Skip to content

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

Merged
kbatuigas merged 3 commits into
mainfrom
doc-2303-fix-contributing-link
Aug 4, 2026
Merged

Fix link to relocated contribution/authoring guide (DOC-2303)#82
kbatuigas merged 3 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 (and its later replacement, AUTHORING.adoc) has been removed and ported to internal-only redpanda-data/cupboard (redpanda-data/cupboard#677). Unlike docs/cloud-docs/rp-connect-docs/adp-docs/docs-template/docs-site, this repo has no local-antora-playbook.yml cross-fetching those private repos, so it isn't part of that internal move. This just drops the now-dead link rather than pointing at an internal resource this repo's audience doesn't need.

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

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

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: d0273477-adf9-4006-b4d9-039c30018954

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

The README local contribution instruction now references AUTHORING.adoc. The linked text directs contributors to build and test changes locally instead of submitting a 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 describes the documentation link fix and identifies the related issue.
Description check ✅ Passed The description explains the relocated guide and the resulting documentation link change.
✨ 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.

docs-site/meta-docs/AUTHORING.adoc has been deleted and ported to
internal-only cupboard, since every other content repo's local build
requires private-repo GitHub access the guide assumed. api-docs
doesn't have that dependency (no local-antora-playbook.yml
cross-fetching private repos), so it isn't part of that move — just
drop the now-dead link rather than pointing at an internal resource
this repo's audience doesn't need.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
docs-site/meta-docs/STYLE-GUIDE.adoc has been deleted; the canonical
style guide now lives in the private redpanda-data/docs-team-standards
repo. api-docs stays public, so it can't link there the way the
internal-audience repos now do — just drop the dangling reference.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
@kbatuigas
kbatuigas merged commit 52f5a28 into main Aug 4, 2026
8 checks passed
@kbatuigas
kbatuigas deleted the doc-2303-fix-contributing-link branch August 4, 2026 22:33
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.

2 participants