Skip to content

Fix link to relocated contribution/authoring guide (DOC-2303) #1881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JakeSCahill wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix link to relocated contribution/authoring guide (DOC-2303) #1881

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d7a8e3
Repoint local-build link at docs-site's renamed AUTHORING.adoc
JakeSCahill Aug 4, 2026
ddd8760
Point to the shared GitHub auth setup for local builds
JakeSCahill Aug 4, 2026
97b125f
Repoint authoring guide link at cupboard instead of docs-site
JakeSCahill Aug 4, 2026
456a93a
Repoint style guide link at docs-team-standards, drop stale copy
JakeSCahill Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -53,15 +53,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`, `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

Local builds require the GitHub authentication set up above.

If you want to run the website locally, install and update the packages:

```bash
Expand Down
Loading