Fix link to relocated contribution/authoring guide (DOC-2303) - #663
Fix link to relocated contribution/authoring guide (DOC-2303)#663JakeSCahill wants to merge 1 commit 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 rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME.adoc now links to Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Now that docs-site/meta-docs/AUTHORING.adoc centralizes this content (redpanda-data/docs-site#201) and every content repo needs the same GitHub auth setup for local builds, replace this repo's full copy with the same short pointer used everywhere else, and repoint the CONTRIBUTING.adoc link (now split/renamed) to AUTHORING.adoc. Supersedes the separate fix opened as #663. Related: https://redpandadata.atlassian.net/browse/DOC-2303
|
Superseded by #661, which already touched this same section and now includes this fix plus the auth-setup consolidation. Closing to avoid two PRs editing the same lines. |
…t repos (#661) * DOC-2303: Add Antora GitHub auth prerequisites to README Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * DOC-2303: Address CodeRabbit and style review feedback Fix repo lists to match each playbook, soften credential-source wording, add XDG fallback path, remove em dash, use verb-phrase heading, add new-tab carets to external links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * DOC-2303: Document gh auth login prerequisite and PAT repo selection Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Address docs-team-standards review findings on the auth setup section - Fix the troubleshooting NOTE to quote Antora's real error text ("Content repository not found or credentials were rejected") instead of HTTP status codes that never appear in its output - Prevent a silently-ignored duplicate ~/.git-credentials entry by replacing any existing github.com line instead of blind-appending - Note that the credential is stored in plaintext, not just chmod 600'd - Add a cross-reference from Local development back to the auth prerequisite - Active voice for the org-approval sentence - Capitalize "Git" as a proper noun Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Point auth setup and contribution link at the shared authoring guide Now that docs-site/meta-docs/AUTHORING.adoc centralizes this content (redpanda-data/docs-site#201) and every content repo needs the same GitHub auth setup for local builds, replace this repo's full copy with the same short pointer used everywhere else, and repoint the CONTRIBUTING.adoc link (now split/renamed) to AUTHORING.adoc. Supersedes the separate fix opened as #663. Related: https://redpandadata.atlassian.net/browse/DOC-2303 * 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 * 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 * Update README.adoc --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
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). The external-contribution process this line originally led toward is no longer accurate once the private-repo migration lands, and has been archived internally instead (redpanda-data/cupboard#676). This just repoints the link at the still-public local-build guide so it doesn't 404.