Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Jan 12, 2026

We were getting build errors in cloud-docs from recent updates to schema reg auth in the docs repo. Here's why: The cloud-docs pages include content from the main docs repo via include::ROOT:... That included content contains xrefs like xref:manage:security/authorization/acl.adoc[...] which are valid in the docs repo, but those paths don't exist in cloud-docs.

By adding page-aliases to the cloud-docs pages, if something tries to link to manage:security/authorization/acl.adoc, we redirect it to security:authorization/acl.adoc (which is where that page actually lives in cloud-docs).

Add page-aliases to resolve xrefs from included ROOT content:

  • schema-reg:schema-reg-api.adoc -> manage:schema-reg/schema-reg-api.adoc
  • manage:security/authorization/acl.adoc -> security:authorization/acl.adoc

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Add page-aliases to resolve xrefs from included ROOT content:
- schema-reg:schema-reg-api.adoc -> manage:schema-reg/schema-reg-api.adoc
- manage:security/authorization/acl.adoc -> security:authorization/acl.adoc

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@micheleRP micheleRP requested a review from a team as a code owner January 12, 2026 04:36
@netlify
Copy link

netlify bot commented Jan 12, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 3581a34
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69647a3a4824510008cac1f5
😎 Deploy Preview https://deploy-preview-481--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
Contributor

coderabbitai bot commented Jan 12, 2026

📝 Walkthrough

Walkthrough

This pull request updates page alias metadata in two AsciiDoc documentation files. The schema-reg-api.adoc file receives a new page alias pointing to its current location, while the acl.adoc file's page alias is updated to reference an additional documentation module path. These are documentation configuration changes with no modifications to content or functional logic.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • r-vasquez
  • kbatuigas
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding page-aliases to fix broken cross-reference targets.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed PR description is mostly complete with clear context and technical details, but lacks issue number and page preview links as specified in the template.

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

✨ Finishing touches
  • 📝 Generate docstrings

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

@JakeSCahill JakeSCahill merged commit 362036c into main Jan 12, 2026
5 checks passed
@JakeSCahill JakeSCahill deleted the fix/xref-page-aliases-clean branch January 12, 2026 10:49
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.

3 participants