Skip to content

chore: consume the shared component from the shared/ folder on main - #3

Open
JakeSCahill wants to merge 1 commit into
mainfrom
chore/shared-folder-start-path
Open

chore: consume the shared component from the shared/ folder on main#3
JakeSCahill wants to merge 1 commit into
mainfrom
chore/shared-folder-start-path

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

What this does

Points this playbook at the shared component's new home. The component is moving from the dedicated shared branch of redpanda-data/docs to a shared/ folder on main, so this:

  • drops shared from the branches list of the redpanda-data/docs source
  • adds the folder as its own content source with start_path: shared

Same shape as redpanda-data/docs#1892 and redpanda-data/rp-connect-docs#485.

⚠️ Do not merge before redpanda-data/docs#1892

The shared/ folder does not exist on docs main until #1892 lands. Merging this first points the playbook at a folder that isn't there, and the playbook loses the shared component entirely — no glossary terms, no enterprise features registry.

Why this matters

This is a local playbook, so the published site is unaffected either way — the production cutover is docs-site#205. The cost of not doing this is that local previews in this repo silently lose the shared component once the shared branch is retired, which is easy to misread as a content bug.

Conversely, leaving any consumer on the branch means the shared branch can't be retired, and the folder and branch keep drifting. That drift already bit docs#1892: four glossary terms in the folder copy still carried the old ADP acronym after #1894 updated the branch.

Verification

  • YAML parses
  • no shared entry remains in the docs source's branches
  • exactly one source with start_path: shared

🤖 Generated with Claude Code

Part of the shared-component migration (redpanda-data/docs#1892). The shared
component is moving from the dedicated `shared` branch of redpanda-data/docs
to a `shared/` folder on `main`, so this playbook drops `shared` from the
branches list and adds the folder as its own content source with
`start_path: shared`.

Matches the form used in docs#1892 and rp-connect-docs#485.

Do not merge before docs#1892. The shared/ folder does not exist on docs main
until that PR lands, and this playbook loses the shared component entirely if
it points at a folder that is not there yet.
@JakeSCahill
JakeSCahill requested a review from a team as a code owner August 14, 2026 12:31
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