diff --git a/README.adoc b/README.adoc index bb0591b19..c96c41e11 100644 --- a/README.adoc +++ b/README.adoc @@ -20,7 +20,7 @@ This repository hosts the documentation content for Redpanda. 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. +Before you add or edit content, consult the Redpanda https://github.com/redpanda-data/docs-team-standards/blob/main/resources/writing-style/style-guide.md[Style Guide] for product documentation guidelines. To contribute to the Redpanda docs, you have the following options: @@ -51,15 +51,21 @@ If you are a Redpanda employee, submit doc issues in `redpanda-data/documentatio 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]. +. Clone the docs repository to make changes locally on your machine. For a guide, see https://github.com/redpanda-data/cupboard/blob/main/sales/customer-success/documentation/2026-08-04-authoring-guide.md[Build and test your changes locally]. 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. +== Set up GitHub authentication + +Building this site locally fetches content from other GitHub repositories, including the private `docs`, `rp-connect-docs`, and `adp-docs` repositories, so you need a GitHub token even for read-only builds. See "Set up GitHub authentication" in the https://github.com/redpanda-data/cupboard/blob/main/sales/customer-success/documentation/2026-08-04-authoring-guide.md[authoring guide]. + == Local development +Local builds require the GitHub authentication set up above. + If you want to run the website locally, install and update the packages: ```bash