Skip to content

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

Closed
JakeSCahill wants to merge 1 commit into
mainfrom
doc-2303-fix-contributing-link
Closed

Fix link to relocated contribution/authoring guide (DOC-2303)#663
JakeSCahill wants to merge 1 commit into
mainfrom
doc-2303-fix-contributing-link

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

Description

Related to https://redpandadata.atlassian.net/browse/DOC-2303.

docs-site/meta-docs/CONTRIBUTING.adoc was split and renamed to AUTHORING.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.

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
@JakeSCahill
JakeSCahill requested a review from a team as a code owner August 4, 2026 15:51
@netlify

netlify Bot commented Aug 4, 2026

Copy link
Copy Markdown

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 46903e5
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a720a8b988ac900087b2590
😎 Deploy Preview https://deploy-preview-663--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6fa501cf-69e3-4729-9e0d-4145c0ea1c55

📥 Commits

Reviewing files that changed from the base of the PR and between b5d4c3d and 46903e5.

📒 Files selected for processing (1)
  • README.adoc

📝 Walkthrough

Walkthrough

README.adoc now links to AUTHORING.adoc instead of CONTRIBUTING.adoc. The link text now describes guidance for building and testing changes locally.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: feediver1

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change but omits the required review deadline, page previews, and checks sections. Add the required review deadline, page previews, and checks sections, and include the repository issue reference if required by the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation link fix and includes the related issue identifier.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch doc-2303-fix-contributing-link

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

JakeSCahill added a commit that referenced this pull request Aug 4, 2026
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
@JakeSCahill

Copy link
Copy Markdown
Contributor Author

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.

@JakeSCahill JakeSCahill closed this Aug 4, 2026
JakeSCahill added a commit that referenced this pull request Aug 10, 2026
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant