|
| 1 | += Redpanda Documentation |
| 2 | +:url-playbook: https://github.com/redpanda-data/docs-site |
| 3 | + |
| 4 | +image:https://img.shields.io/badge/slack-purple[Slack, link="https://redpanda.com/slack"] |
| 5 | +image:https://img.shields.io/twitter/follow/redpandadata.svg?style=social&label=Follow[Twitter, link="https://twitter.com/intent/follow?screen_name=redpandadata"] |
| 6 | +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"] |
| 7 | + |
| 8 | +++++ |
| 9 | +<p> |
| 10 | +<a href="https://docs.redpanda.com"> |
| 11 | +<object type="image/svg+xml"> |
| 12 | + <img src="https://raw.githubusercontent.com/redpanda-data/docs-ui/main/src/img/redpanda-docs-logo.svg"/> |
| 13 | +</object> |
| 14 | +</p></a> |
| 15 | +++++ |
| 16 | + |
| 17 | +This repository hosts the documentation content for Redpanda APIs. |
| 18 | + |
| 19 | +== Contribute |
| 20 | + |
| 21 | +The Redpanda docs are open source, and we welcome your contributions! |
| 22 | + |
| 23 | +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. |
| 24 | + |
| 25 | +To contribute to the Redpanda docs, you have the following options: |
| 26 | + |
| 27 | +|=== |
| 28 | +|Option|Description |
| 29 | + |
| 30 | +|<<Open an issue>> |
| 31 | +|Suggest a change by opening an issue on GitHub. |
| 32 | + |
| 33 | +|<<Contribute content>> |
| 34 | +|Make changes directly to the documentation and submit them through a pull request. |
| 35 | + |
| 36 | +|=== |
| 37 | + |
| 38 | +=== Open an issue |
| 39 | + |
| 40 | +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: |
| 41 | + |
| 42 | +. Verify whether a similar issue already exists in that repository to avoid duplication. |
| 43 | +. Go to **Issues** > **New Issue** to create a new issue. |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +If you are a Redpanda employee, submit doc issues in the Documentation [Jira board](https://redpandadata.atlassian.net/jira/software/c/projects/DOC/boards/65). |
| 48 | + |
| 49 | +=== Contribute content |
| 50 | + |
| 51 | +You have two options to contribute to the documentation: |
| 52 | + |
| 53 | +. Directly edit a page on GitHub by selecting **Make a contribution** > **Edit on GitHub** located at the bottom of a documentation page. |
| 54 | +. 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]. |
| 55 | + |
| 56 | +Check the open docs issues. If you find an issue you'd like to work on: |
| 57 | + |
| 58 | +- If the issue is already assigned to someone else, please consider another one. |
| 59 | +- If the issue is unassigned, add a comment expressing your interest in working on it. |
| 60 | + |
| 61 | +== Local development |
| 62 | + |
| 63 | +If you want to run the website locally, install and update the packages: |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +=== Build the site |
| 68 | + |
| 69 | +To build the files, run: |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +== Versioning |
| 74 | + |
| 75 | +tbd |
| 76 | + |
| 77 | +== Repository Structure |
| 78 | + |
| 79 | +tbd |
0 commit comments