From 4d7a8e3da4d6f68cf46827424d1c13ca1ee2be7a Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 16:44:28 +0100 Subject: [PATCH 1/4] Repoint local-build link at docs-site's renamed AUTHORING.adoc docs-site/meta-docs/CONTRIBUTING.adoc was split and renamed to AUTHORING.adoc (redpanda-data/docs-site#201) since it also served as the generic local-build reference this line points to, separate from the external-contribution process that moved to internal cupboard (redpanda-data/cupboard#676). Related: https://redpandadata.atlassian.net/browse/DOC-2303 --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 1da74fee61..2f6308375b 100644 --- a/README.adoc +++ b/README.adoc @@ -53,7 +53,7 @@ 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 {url-playbook}/blob/main/meta-docs/AUTHORING.adoc[Build and test your changes locally]. Check the open docs issues. If you find an issue you'd like to work on: From ddd876042e0a1af2c8be6d34441283926e40327f Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 16:57:42 +0100 Subject: [PATCH 2/4] Point to the shared GitHub auth setup for local builds This repo's local-antora-playbook.yml fetches cross-repo content including the private docs/cloud-docs/rp-connect-docs/adp-docs repos, so local builds need a GitHub token even for read-only work. Details live centrally in docs-site's authoring guide rather than duplicated here. Related: https://redpandadata.atlassian.net/browse/DOC-2303 --- README.adoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.adoc b/README.adoc index 2f6308375b..042007e960 100644 --- a/README.adoc +++ b/README.adoc @@ -60,8 +60,14 @@ 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`, `cloud-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 {url-playbook}/blob/main/meta-docs/AUTHORING.adoc[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 From 97b125fabaf425b8164d0171bb3faa9bd3a39a62 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 17:20:33 +0100 Subject: [PATCH 3/4] Repoint authoring guide link at cupboard instead of docs-site docs-site/meta-docs/AUTHORING.adoc has been deleted entirely (redpanda-data/docs-site#201) since every content repo's local build already requires the same private-repo GitHub access the guide assumed, making its old public location moot. The full guide now lives at redpanda-data/cupboard#677. Related: https://redpandadata.atlassian.net/browse/DOC-2303 --- README.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 042007e960..124ccdac7e 100644 --- a/README.adoc +++ b/README.adoc @@ -53,7 +53,7 @@ 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/AUTHORING.adoc[Build and test your changes locally]. +. 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: @@ -62,7 +62,7 @@ Check the open docs issues. If you find an issue you'd like to work on: == Set up GitHub authentication -Building this site locally fetches content from other GitHub repositories, including the private `docs`, `cloud-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 {url-playbook}/blob/main/meta-docs/AUTHORING.adoc[authoring guide]. +Building this site locally fetches content from other GitHub repositories, including the private `docs`, `cloud-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 From 456a93acaea18db06131363a67b12765a43110c7 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 17:29:40 +0100 Subject: [PATCH 4/4] Repoint style guide link at docs-team-standards, drop stale copy docs-site/meta-docs/STYLE-GUIDE.adoc has been deleted (redpanda-data/docs-site#201) since redpanda-data/docs-team-standards already has a more current, canonical style guide. Related: https://redpandadata.atlassian.net/browse/DOC-2303 --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 124ccdac7e..be0ab3361b 100644 --- a/README.adoc +++ b/README.adoc @@ -22,7 +22,7 @@ This repository hosts the documentation content for Redpanda Streaming. 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: