https://github.com/redpanda-data/api-docs

Redpanda API docs content.
https://github.com/redpanda-data/api-docs

Last synced: 5 months ago
JSON representation

Redpanda API docs content.

• Host: GitHub
• URL: https://github.com/redpanda-data/api-docs
• Owner: redpanda-data
• Created: 2025-05-23T18:32:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-27T17:00:57.000Z (5 months ago)
• Last Synced: 2026-01-28T03:40:53.024Z (5 months ago)
• Homepage:
• Size: 601 KB
• Stars: 0
• Watchers: 0
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.adoc
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
= Redpanda Documentation

:url-playbook: https://github.com/redpanda-data/docs-site

image:https://img.shields.io/badge/slack-purple[Slack, link="https://redpanda.com/slack"]

image:https://img.shields.io/twitter/follow/redpandadata.svg?style=social&label=Follow[Twitter, link="https://twitter.com/intent/follow?screen_name=redpandadata"]

image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f/deploy-status[Netlify Status, link="https://app.netlify.com/sites/redpanda-documentation/deploys"]

++++





  



++++


This repository hosts the documentation content for Redpanda APIs.

== Contribute

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

Before you add or edit content, consult the Redpanda https://github.com/redpanda-data/docs-site/blob/main/meta-docs/STYLE-GUIDE.adoc[Style Guide] for product documentation guidelines.

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

|===

|Option|Description

|<>

|Suggest a change by opening an issue on GitHub.

|<>

|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:

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

. Go to **Issues** > **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 in the Documentation https://redpandadata.atlassian.net/jira/software/c/projects/DOC/boards/65[Jira board].

=== Contribute content

You have two options to contribute to the documentation:

. Directly edit a page on GitHub by selecting **Make a contribution** > **Edit on GitHub** located at the bottom of a documentation page.

. Clone the docs repository to make changes locally on your machine. For a guide, see {url-playbook}/blob/main/meta-docs/CONTRIBUTING.adoc[Submit 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:

=== Build the site

To build the files, run:

== Versioning

== Repository Structure