chore: consume the shared component from the shared/ folder on main - #3
Open
JakeSCahill wants to merge 1 commit into
Open
chore: consume the shared component from the shared/ folder on main#3JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
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.
kbatuigas
approved these changes
Aug 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Points this playbook at the shared component's new home. The component is moving from the dedicated
sharedbranch ofredpanda-data/docsto ashared/folder onmain, so this:sharedfrom thebrancheslist of theredpanda-data/docssourcestart_path: sharedSame shape as redpanda-data/docs#1892 and redpanda-data/rp-connect-docs#485.
The
shared/folder does not exist on docsmainuntil #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
sharedbranch is retired, which is easy to misread as a content bug.Conversely, leaving any consumer on the branch means the
sharedbranch 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 oldADPacronym after #1894 updated the branch.Verification
sharedentry remains in the docs source'sbranchesstart_path: shared🤖 Generated with Claude Code