Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Documentation for Redpanda Connect

NotificationsYou must be signed in to change notification settings

redpanda-data/rp-connect-docs

Repository files navigation

SlackTwitter

This repository hosts the documentation content for Redpanda Connect.

Contribute

The Redpanda docs are open source, and we welcome your contributions!

Before you add or edit content, consult the RedpandaStyle Guide for product documentation guidelines.

To contribute to the Redpanda docs, you have the following options:

OptionDescription

Open an issue

Suggest a change by opening an issue on GitHub.

Contribute content

Make changes directly to the documentation and submit them through a pull request.

Open an issue

The Redpanda docs team uses GitHub issues to track, plan, and prioritize tasks. To suggest changes, you can create an issue, which the team will then evaluate:

  1. Verify whether a similar issue already exists in that repository to avoid duplication.

  2. Go toIssues >New Issue to create a new issue.

You have the option to assign the issue to yourself or leave the assignee field blank. The Redpanda docs team triages all new issues and will allocate a writer if one isn’t already assigned.

If you are a Redpanda employee, submit doc issues inredpanda-data/documentation-private.

Contribute content

You have two options to contribute to the documentation:

  1. Directly edit a page on GitHub by selectingMake a contribution >Edit on GitHub located at the bottom of a documentation page.

  2. Clone the docs repository to make changes locally on your machine. For a guide, seeSubmit your first contribution.

Check the open docs issues. If you find an issue you’d like to work on:

  • If the issue is already assigned to someone else, please consider another one.

  • If the issue is unassigned, add a comment expressing your interest in working on it.

Local development

If you want to run the website locally, install and update the packages:

npm update

Then, build the docs:

npm run build

This command generates static content in thedocs directory and can be served using any hosting service.

You can serve the static files on a local web server using:

npm run serve

Autogenerated docs

Some of the documentation files in this repository are autogenerated from the source code. These files include details about components, configurations, and usage that are derived from the codebase to ensure accuracy and consistency.

Autogenerated documentation files include a special comment at the top of the file:

////     THIS FILE IS AUTOGENERATED!////

The location of the source is included in this comment.

About

Documentation for Redpanda Connect

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors21

Languages


[8]ページ先頭

©2009-2025 Movatter.jp