From efe5a77d01e7854a6036da5216c212cfd925ab82 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 16:44:51 +0100 Subject: [PATCH 1/3] 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 a983120..1b8ba6c 100644 --- a/README.adoc +++ b/README.adoc @@ -51,7 +51,7 @@ If you are a Redpanda employee, submit doc issues in the Documentation https://r 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 4a8a8628d721ac968ad0a0d453b1b23e1bf85b30 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 17:21:41 +0100 Subject: [PATCH 2/3] Drop link to now fully-internal authoring guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs-site/meta-docs/AUTHORING.adoc has been deleted and ported to internal-only cupboard, since every other content repo's local build requires private-repo GitHub access the guide assumed. api-docs doesn't have that dependency (no local-antora-playbook.yml cross-fetching private repos), so it isn't part of that move — just drop the now-dead link rather than pointing at an internal resource this repo's audience doesn't need. 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 1b8ba6c..abe1147 100644 --- a/README.adoc +++ b/README.adoc @@ -51,7 +51,7 @@ If you are a Redpanda employee, submit doc issues in the Documentation https://r 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, then open a pull request. Check the open docs issues. If you find an issue you'd like to work on: From 45428983861ed7e94d330415c39415976be8c6ed Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Tue, 4 Aug 2026 17:30:29 +0100 Subject: [PATCH 3/3] Drop dead style guide link MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs-site/meta-docs/STYLE-GUIDE.adoc has been deleted; the canonical style guide now lives in the private redpanda-data/docs-team-standards repo. api-docs stays public, so it can't link there the way the internal-audience repos now do — just drop the dangling reference. Related: https://redpandadata.atlassian.net/browse/DOC-2303 --- README.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.adoc b/README.adoc index abe1147..bdf6b18 100644 --- a/README.adoc +++ b/README.adoc @@ -20,8 +20,6 @@ This repository hosts the documentation content for Redpanda APIs. 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: |===