Skip to content

Relocate external contribution guide (DOC-2303) - #201

Open
JakeSCahill wants to merge 4 commits into
mainfrom
doc-2303-relocate-contribution-guide
Open

Relocate external contribution guide (DOC-2303)#201
JakeSCahill wants to merge 4 commits into
mainfrom
doc-2303-relocate-contribution-guide

Conversation

@JakeSCahill

@JakeSCahill JakeSCahill commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

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

meta-docs/CONTRIBUTING.adoc assumed anyone could fork and clone docs, cloud-docs, rp-connect-docs, and adp-docs. DOC-2303 makes those repos private, so that workflow no longer works for non-employees (also flagged in the docs-team-standards review on cloud-docs#661).

This deletes the file. Its content is fully archived/ported internally, split into two pages:

  • The external-contribution process (open an issue, fork-and-PR, "if you're not a Redpanda employee...") is archived at redpanda-data/cupboard#676, since it no longer describes a path that works.
  • The generic Antora build/authoring reference (repo structure, local build/preview steps, single-sourcing, categories) was initially kept public here as meta-docs/AUTHORING.adoc, but every docs repo's local-antora-playbook.yml — including this one — cross-fetches the private repos to build locally at all, so that audience was already internal in practice. It's now ported to redpanda-data/cupboard#677 instead, and this repo's own README points there.
  • home/modules/ROOT/pages/how-to-use-these-docs.adoc (published, reader-facing content) drops its "want to contribute? see guide" bullet rather than linking anywhere internal — that page is public, cupboard isn't.

Related PRs

@JakeSCahill
Relocate external contribution guide, keep authoring reference public
cace8b2 
DOC-2303 makes docs/cloud-docs/rp-connect-docs/adp-docs private, so
the fork-and-clone contribution workflow this file described no
longer works for non-employees. Split it:

- The still-public, still-relevant parts (repo structure, local build
  steps, single-sourcing, categories) move to meta-docs/AUTHORING.adoc,
  which docs-ui and this repo's own README keep linking to.
- The external-contribution process itself is archived internally in
  redpanda-data/cupboard (redpanda-data/cupboard#676) since it no
  longer describes a working path.
- how-to-use-these-docs.adoc (published content) drops its dangling
  link to the removed guide rather than pointing at the internal copy.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
@JakeSCahill
JakeSCahill requested a review from a team as a code owner August 4, 2026 15:41
@netlify

netlify Bot commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for redpanda-documentation ready!

Name Link
🔨 Latest commit 82dc7ae
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-documentation/deploys/6a72134c60ed9f000850aaec
😎 Deploy Preview https://deploy-preview-201--redpanda-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 86 (🟢 up 12 from production)
Accessibility: 93 (🔴 down 1 from production)
Best Practices: 92 (no change from production)
SEO: 83 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

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

JakeSCahill added a commit to redpanda-data/docs-ui that referenced this pull request Aug 4, 2026
@JakeSCahill
Drop the modal's generic contribution-guide link
d6a0838 
The linked docs-site/meta-docs/CONTRIBUTING.adoc is being removed
(redpanda-data/docs-site#201) since it described a fork-and-clone
workflow that no longer works once docs/cloud-docs/rp-connect-docs/
adp-docs go private. The Labs branch is unaffected — Labs stays
public and keeps its own separate contribution guide. Also drops
README's :url-contributing: attribute, which pointed at the same
removed file and wasn't referenced anywhere else in the doc.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
This was referenced Aug 4, 2026
Open
Open
Closed
Open
Open
Merged
Open
@JakeSCahill
Add GitHub auth setup to the shared authoring guide
59add4f 
Every docs 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 anywhere need a GitHub token once DOC-2303 lands.
Central per the Single-sourcing section this file already documents,
rather than duplicated per repo.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
JakeSCahill added a commit to redpanda-data/cloud-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Point auth setup and contribution link at the shared authoring guide
93da357 
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
Move the authoring guide to cupboard instead of keeping it split
99d1ab0 
Every docs repo's local-antora-playbook.yml, including this one,
cross-fetches the private docs/cloud-docs/rp-connect-docs/adp-docs
repos to build locally at all, so the audience for this guide was
already internal in practice even while it stayed public here.
Delete meta-docs/AUTHORING.adoc and repoint this README at the full
guide now ported to redpanda-data/cupboard#677, adding the same
GitHub-auth pointer the other repos already have.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
JakeSCahill added a commit to redpanda-data/docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint authoring guide link at cupboard instead of docs-site
97b125f 
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
JakeSCahill added a commit to redpanda-data/rp-connect-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint authoring guide link at cupboard instead of docs-site
338c203 
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
JakeSCahill added a commit to redpanda-data/adp-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint authoring guide link at cupboard instead of docs-site
2a332fb 
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
JakeSCahill added a commit to redpanda-data/docs-template that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint authoring guide link at cupboard instead of docs-site
244d2ec 
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
JakeSCahill added a commit to redpanda-data/cloud-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint authoring guide link at cupboard instead of docs-site
059e5fa 
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
@JakeSCahill
Delete stale STYLE-GUIDE.adoc, canonical version already lives elsewhere
82dc7ae 
redpanda-data/docs-team-standards (private) already has a more
current, more structured style guide
(resources/writing-style/style-guide.md), flagged as canonical in an
existing cupboard feedback file dated 2026-05-29. This copy was
drifting into a second source of truth rather than a genuine
duplicate worth reconciling — delete it outright rather than port it
anywhere new.

Related: https://redpandadata.atlassian.net/browse/DOC-2303
JakeSCahill added a commit to redpanda-data/docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint style guide link at docs-team-standards, drop stale copy
456a93a 
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
JakeSCahill added a commit to redpanda-data/rp-connect-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint style guide link at docs-team-standards, drop stale copy
ac62029 
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
JakeSCahill added a commit to redpanda-data/adp-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint style guide link at docs-team-standards, drop stale copy
5311249 
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
JakeSCahill added a commit to redpanda-data/docs-template that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint style guide link at docs-team-standards, drop stale copy
2f40b1e 
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
JakeSCahill added a commit to redpanda-data/cloud-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Repoint style guide link at docs-team-standards, drop stale copy
b91d327 
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
@JakeSCahill JakeSCahill mentioned this pull request Aug 4, 2026
Open
kbatuigas pushed a commit to redpanda-data/api-docs that referenced this pull request Aug 4, 2026
@JakeSCahill
Fix link to relocated contribution/authoring guide (DOC-2303) (#82)
52f5a28 
* Repoint local-build link at docs-site's renamed AUTHORING.adoc

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

* Drop link to now fully-internal authoring guide

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

* Drop dead style guide link

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JakeSCahill