Skip to content

Conversation

@paulohtb6
Copy link
Collaborator

@paulohtb6 paulohtb6 commented Dec 16, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1876
Review deadline:

Page previews

Checks

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

@paulohtb6 paulohtb6 requested a review from a team as a code owner December 16, 2025 17:54
@netlify
Copy link

netlify bot commented Dec 16, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit e5e51d4
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69419cbbff895000087ace63
😎 Deploy Preview https://deploy-preview-1520--redpanda-docs-preview.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 Dec 16, 2025

📝 Walkthrough

Walkthrough

This PR fixes a broken cross-reference in the AsciiDoc documentation. Two xref links in the rpk-shadow-create.adoc file are updated from rpk-cloud-select to rpk-cloud-cluster-select to resolve a broken link error reported during documentation builds in production.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Straightforward documentation reference fix with no logic or behavioral changes
  • Changes are confined to a single file with minimal scope

Possibly related PRs

  • rpk: update reference with dec 12th #1515: Modifies the same documentation file (rpk-shadow-create.adoc) and updates Redpanda Cloud cluster selection references—related through overlapping changes to the cluster selection guidance.

Suggested reviewers

  • micheleRP
  • r-vasquez

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix link in rpk cloud' clearly summarizes the main change—fixing a broken documentation link related to rpk cloud.
Description check ✅ Passed The PR description follows the template structure and includes the resolved Jira ticket (DOC-1876) and a relevant checkbox selection (Small fix).
Linked Issues check ✅ Passed The code changes directly address DOC-1876 by updating the broken cross-reference from rpk-cloud-select to rpk-cloud-cluster-select, resolving the Asciidoctor build error.
Out of Scope Changes check ✅ Passed All changes are within scope—only documentation cross-references were updated to fix the broken link, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-link

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ceb8177 and e5e51d4.

📒 Files selected for processing (1)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1349
File: modules/manage/pages/cluster-maintenance/manage-throughput.adoc:0-0
Timestamp: 2025-09-03T16:34:58.323Z
Learning: For Redpanda documentation, use absolute URLs (https://docs.redpanda.com/api/...) rather than relative URLs (/api/...) when linking to API documentation. Relative API links break in Netlify previews because Bump only serves from docs.redpanda.com, causing the relative URLs to be appended to the preview URL where Bump doesn't serve content.
Learnt from: CR
Repo: redpanda-data/docs PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T09:42:15.235Z
Learning: Applies to docs-data/property-overrides.json : Always use full Antora resource IDs with module prefixes in xref links within property descriptions (e.g., `reference:properties/cluster-properties.adoc`, never `./cluster-properties.adoc`)
Learnt from: CR
Repo: redpanda-data/docs PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T09:42:15.235Z
Learning: Applies to docs-data/property-overrides.json : Normalize all xref links in property-overrides.json to use full Antora resource IDs after updating
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.
📚 Learning: 2025-08-25T21:00:26.626Z
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.

Applied to files:

  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc
📚 Learning: 2025-12-12T16:18:28.126Z
Learnt from: andrewstucki
Repo: redpanda-data/docs PR: 1514
File: modules/troubleshoot/partials/errors-and-solutions.adoc:618-632
Timestamp: 2025-12-12T16:18:28.126Z
Learning: In Redpanda ShadowLink CRD usage, do not copy CA certificates into pods via kubectl cp because they won't persist across pod restarts. Store CA certs in Kubernetes Secrets and reference them in the ShadowLink's staticConfiguration block (or inline the cert data in that block) to ensure persistence and proper secret management.

Applied to files:

  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc (1)

13-13: Xref target file verified and change is correct.

The update from rpk-cloud-select to rpk-cloud-cluster-select correctly resolves DOC-1876. The target file exists at modules/reference/partials/rpk-cloud/rpk-cloud-cluster-select.adoc, the xref uses the proper full Antora resource ID format, and no old broken references remain. The "two places" mentioned in the AI summary refers to the two xref links on line 13 (rpk-cloud-login and rpk-cloud-cluster-select).


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@paulohtb6 paulohtb6 merged commit be83200 into main Dec 18, 2025
7 checks passed
@paulohtb6 paulohtb6 deleted the fix-link branch December 18, 2025 18:32
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