Add rpk registry context reference pages#588
Conversation
The single-sourced Schema Registry contexts page in the docs repo links to rpk-registry-context-list and rpk-registry-context-delete. Cloud-docs lacked wrapper pages for these commands, so the xrefs broke when the content was included into cloud-docs. Add thin wrapper pages following the existing include::ROOT:reference:...[tag=single-source] pattern, plus the corresponding nav entries between compatibility-level and mode. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR adds documentation infrastructure for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
From Claude: xref: xref:reference:rpk/rpk-profile.adoc (in all 3) Something that is worth knowing about for the future: the file lives at a nested path but a page-aliases directive makes the short xref work. That's the same trick available if you ever need the inverse — a self-managed-only target that needs to resolve in cloud-docs — though ifndef::env-cloud[] is usually cleaner. |
Summary
Adds three wrapper pages in cloud-docs for
rpk registry context,rpk registry context list, andrpk registry context delete, following the establishedinclude::ROOT:reference:...[tag=single-source]pattern used by the other rpk-registry pages. Also adds the corresponding nav entries betweencompatibility-levelandmode.Why this fix is needed
@Feediver1 — your recent PR redpanda-data/docs#1690 (DOC-1790: Schema Registry Metadata Properties) added these xrefs inside the single-sourced section of
modules/manage/pages/schema-reg/schema-reg-contexts.adoc(the page that single-sources into cloud-docs):Cloud-docs didn't have wrapper pages for the
rpk registry context list/deletecommands, so when the docs-repo content was included into cloud-docs the xrefs failed to resolve (in Antora, xrefs inside included content resolve in the including page's component, not the source component).The
rpk registry contextcommands work against any Schema Registry, including cloud, so the right fix is to add the missing wrappers here. Companion docs-repo fix (for a third broken xref torelease-notes/redpanda.adocwhich is genuinely self-managed-only): redpanda-data/docs#1707.Preview pages
Test plan
modules/manage/pages/schema-reg/schema-reg-contexts.adoc.🤖 Generated with Claude Code