fix ha link #1480
fix ha link #1480
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA cross-reference link in the high-availability deployment documentation was updated. The link for the Kubernetes conditional in the HA deployment options section was changed from a relative path reference ( Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 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.
📒 Files selected for processing (1)
modules/deploy/partials/high-availability.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 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: Feediver1
Repo: redpanda-data/docs PR: 1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.
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.
Learnt from: JakeSCahill
Repo: redpanda-data/docs PR: 1304
File: modules/troubleshoot/partials/errors-and-solutions.adoc:44-44
Timestamp: 2025-08-13T16:39:20.038Z
Learning: In AsciiDoc documentation with Antora, explicit anchors like [[anchor-name]] take precedence over automatically generated anchors from headings. When troubleshooting cross-references, check for both explicit anchors and auto-generated ones from heading text (lowercase with spaces replaced by hyphens).
⏰ 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
| |=== | ||
|
|
||
| ifndef::env-kubernetes[See also: xref:./production/production-deployment.adoc[Deploy for Production]] | ||
| ifndef::env-kubernetes[See also: xref:deploy:redpanda/manual/production/production-deployment.adoc[Deploy for Production]] |
There was a problem hiding this comment.
🧩 Analysis chain
Verify the cross-reference path resolves correctly.
The change from a relative path to a fully qualified module reference is good for consistency with the pattern established in lines 3–11. However, the path format deploy:redpanda/manual/production/production-deployment.adoc should be verified to ensure it matches the actual file location and resolves correctly in the Antora documentation build.
Additionally, Line 256 contains a similar reference using a relative path (./production/production-deployment-automation.adoc) that may need the same update for consistency.
🏁 Script executed:
#!/bin/bash
# Description: Verify the cross-reference target exists and check for other inconsistent relative paths in this file.
# Find the production deployment page to verify the path is correct
fd -e adoc -e md "production-deployment" modules/
# Check if there are other relative path xrefs in the high-availability.adoc file that might need updating
rg -n '\./production|deploy:.*production' modules/deploy/partials/high-availability.adocLength of output: 448
Line 51 change is correct; Line 256 requires the same update for consistency.
The path on line 51 (deploy:redpanda/manual/production/production-deployment.adoc) is correct and resolves to the existing file. However, line 256 still uses a relative path (./production/production-deployment-automation.adoc) and should be updated to the fully qualified reference (deploy:redpanda/manual/production/production-deployment-automation.adoc) for consistency.
🤖 Prompt for AI Agents
In modules/deploy/partials/high-availability.adoc around lines 51 and 256, line
51 has been updated to the fully qualified xref but line 256 still uses a
relative path; replace the relative reference
"./production/production-deployment-automation.adoc" on line 256 with the fully
qualified reference
"deploy:redpanda/manual/production/production-deployment-automation.adoc" so
both links use consistent, fully qualified xref syntax.
|
this may have been fixed already with #1481 |
paulohtb6
force-pushed
the
fix-ha-link
branch
from
dbc8815 to
3ebfd42
Compare
Description
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks