Skip to content

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

Open
JakeSCahill wants to merge 4 commits into
mainfrom
doc-2303-fix-contributing-link
Open

Fix link to relocated contribution/authoring guide (DOC-2303)#1881
JakeSCahill wants to merge 4 commits into
mainfrom
doc-2303-fix-contributing-link

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Aug 4, 2026

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), then that file was deleted entirely and ported to internal-only redpanda-data/cupboard (redpanda-data/cupboard#677) — every one of these repos' local-antora-playbook.yml cross-fetches the private docs/cloud-docs/rp-connect-docs/adp-docs repos 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.

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 redpanda-docs-preview ready!

Name Link
🔨 Latest commit 456a93a
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a7213796f006a0008d71b26
😎 Deploy Preview https://deploy-preview-1881--redpanda-docs-preview.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

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5774c2ae-d9b1-4f22-8304-e1e9f0a01682

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

README.adoc now directs contributors to AUTHORING.adoc and uses the description “Build and test your changes locally” instead of linking to CONTRIBUTING.adoc with “Submit your first contribution.”

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

Suggested reviewers: feediver1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and concisely describes the link fix and identifies the related ticket.
Description check ✅ Passed The description identifies DOC-2303 and clearly explains the documentation link updates and their rationale.
✨ 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.

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
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