Fix link to relocated contribution/authoring guide (DOC-2303) - #188
Open
JakeSCahill wants to merge 4 commits into
Open
Fix link to relocated contribution/authoring guide (DOC-2303)#188JakeSCahill wants to merge 4 commits into
JakeSCahill wants to merge 4 commits into
Conversation
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
✅ Deploy Preview for redpanda-agentic-data-plane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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
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
micheleRP
reviewed
Aug 5, 2026
micheleRP
left a comment
micheleRP
left a comment
Contributor
There was a problem hiding this comment.
PR Review
Critical issues (must fix)
- [README.adoc:42, 58, "Set up GitHub authentication" section] All three contribution-related links in this PR now point to private repos, while the surrounding section still says "The Redpanda docs are open source, and we welcome your contributions!" (line 40, unchanged). Any external/non-Redpanda reader who clicks "Submit your first contribution," the new "authoring guide" link, or "Style Guide" gets a 404/access-denied —
redpanda-data/cupboardandredpanda-data/docs-team-standardsare both private, whileredpanda-data/adp-docsis still public. The paths themselves resolve fine for someone with access — this is an audience-mismatch problem, not a broken-link problem.- Fix: Either hold this README update until
adp-docs' privacy flip lands (matching DOC-2303's stated checklist order), or, if shipping now, soften/remove the "we welcome your contributions" promise foradp-docsspecifically — per the ticket's own text, CTO guidance is that ADP won't take outside contributions, so that sentence may already be inaccurate independent of this PR.
- Fix: Either hold this README update until
Suggestions (should consider)
- [README.adoc:3]
:url-playbook: https://github.com/redpanda-data/docs-siteis now a dead attribute — its only two usages were both replaced with hardcodedcupboardURLs in the third commit. Consider removing it, or reintroducing a{url-cupboard}-style attribute so the base URL stays centralized.
micheleRP
approved these changes
Aug 7, 2026
micheleRP
left a comment
micheleRP
left a comment
Contributor
There was a problem hiding this comment.
Approving — links verified and the guidance is correct. Non-blocking nit: the blurb's repo list is the generic union rather than what this playbook actually fetches. Since you'll rebase after #186 merges anyway, consider dropping the repo names entirely ("fetches content from private Redpanda repositories — see the authoring guide") so the sentence stays accurate everywhere.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related to https://redpandadata.atlassian.net/browse/DOC-2303.
docs-site/meta-docs/CONTRIBUTING.adocwas split and renamed toAUTHORING.adoc(redpanda-data/docs-site#201), then that file was deleted entirely and ported to internal-onlyredpanda-data/cupboard(redpanda-data/cupboard#677) — every one of these repos'local-antora-playbook.ymlcross-fetches the privatedocs/cloud-docs/rp-connect-docs/adp-docsrepos to build locally at all, so the audience for that guide was already internal in practice.This repoints both the "clone locally" contribution link and the "Set up GitHub authentication" pointer at the ported cupboard guide.