Skip to content

Add rpk registry context reference pages#588

Merged
micheleRP merged 1 commit into
mainfrom
add-rpk-registry-context-pages
May 18, 2026
Merged

Add rpk registry context reference pages#588
micheleRP merged 1 commit into
mainfrom
add-rpk-registry-context-pages

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented May 18, 2026

Summary

Adds three wrapper pages in cloud-docs for rpk registry context, rpk registry context list, and rpk registry context delete, following the established include::ROOT:reference:...[tag=single-source] pattern used by the other rpk-registry pages. Also adds the corresponding nav entries between compatibility-level and mode.

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):

* xref:reference:rpk/rpk-registry/rpk-registry-context-list.adoc[]
* xref:reference:rpk/rpk-registry/rpk-registry-context-delete.adoc[]

Cloud-docs didn't have wrapper pages for the rpk registry context list/delete commands, 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 context commands 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 to release-notes/redpanda.adoc which is genuinely self-managed-only): redpanda-data/docs#1707.

Preview pages

Test plan

  • Cloud-docs local build with the companion docs branch confirms all three Schema Registry contexts xref errors are gone.
  • Once both PRs land, cloud-docs CI build is clean for modules/manage/pages/schema-reg/schema-reg-contexts.adoc.

🤖 Generated with Claude Code

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>
@micheleRP micheleRP requested a review from a team as a code owner May 18, 2026 02:30
@micheleRP micheleRP requested a review from Feediver1 May 18, 2026 02:30
@netlify
Copy link
Copy Markdown

netlify Bot commented May 18, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit bc06cd3
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a0a79d306670700084f068a
😎 Deploy Preview https://deploy-preview-588--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds documentation infrastructure for the rpk registry context command family. Three new AsciiDoc pages are introduced—one parent page for the context command and two subcommand pages for list and delete operations—each containing a title and an include:: directive that pulls content from a shared single-source reference. Navigation entries are added to modules/ROOT/nav.adoc to expose these new pages in the table of contents under the rpk-registry command reference section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • Feediver1
  • JakeSCahill
  • mattschumpert
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding three wrapper pages for rpk registry context commands to the reference documentation.
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.
Description check ✅ Passed The pull request description is comprehensive and well-structured, covering the summary, motivation, preview links, and test plan.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-rpk-registry-context-pages

Comment @coderabbitai help to get the list of available commands and usage tips.

@Feediver1
Copy link
Copy Markdown
Contributor

Feediver1 commented May 18, 2026

From Claude:
For the fix in xref:reference:rpk/rpk-profile.adoc:

xref: xref:reference:rpk/rpk-profile.adoc (in all 3)
Resolves in cloud-docs?: ✅
How: Resolves via :page-aliases: reference:rpk/rpk-profile.adoc on the actual page at
modules/reference/pages/rpk/rpk-profile/rpk-profile.adoc

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.

Copy link
Copy Markdown
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@micheleRP micheleRP merged commit 9e7c687 into main May 18, 2026
5 checks passed
@micheleRP micheleRP deleted the add-rpk-registry-context-pages branch May 18, 2026 18: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