DOC-1340 fix single sourcing in docs repo#1119
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes update the Antora playbook to use a specific branch ( Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant CloudDocs
User->>Docs: Access "intro-to-rpk.adoc"
alt Environment is Cloud
Docs->>CloudDocs: Link to cloud-specific rpk profile config
else Not Cloud
Docs->>Docs: Link to standard rpk profile config
end
Assessment against linked issues
Suggested reviewers
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
modules/get-started/pages/intro-to-rpk.adoc (1)
37-38:⚠️ Potential issueRemove stray plus character
There's an unintended+on its own line. It should be removed to prevent rendering issues:- +
🧹 Nitpick comments (1)
local-antora-playbook.yml (1)
19-20: Align quoting style for consistency
Other content sources use bare strings for single branches (e.g.,branches: main). Consider dropping the single quotes so it reads:branches: DOC-1339-fix-single-sourcing
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
local-antora-playbook.yml(1 hunks)modules/get-started/pages/intro-to-rpk.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (7)
local-antora-playbook.yml (2)
19-20: Branch updated to feature branch
The content source forcloud-docsnow points toDOC-1339-fix-single-sourcingas intended.
19-20:Details
✅ Verification successful
Verify remote branch exists
Ensure the branchDOC-1339-fix-single-sourcingis available in thecloud-docsrepository to prevent build failures. You can run:
🏁 Script executed:
#!/bin/bash # Verify branch existence in cloud-docs repo git ls-remote https://github.com/redpanda-data/cloud-docs.git refs/heads/DOC-1339-fix-single-sourcingLength of output: 184
Remote branch
DOC-1339-fix-single-sourcingverified
- Confirmed via
git ls-remote https://github.com/redpanda-data/cloud-docs.git refs/heads/DOC-1339-fix-single-sourcing(returned commit334ec548adf768e911b3089d810e0c70970e442b)No further action required.
modules/get-started/pages/intro-to-rpk.adoc (5)
17-19: ConditionalSee alsolink for Cloud
Theifdef::env-cloud[]block correctly switches theconfig-rpk-profilelink to the cloud-specific path.
17-19: Verify target document exists
Please confirm thatmodules/manage/rpk/config-rpk-profile.adocis present in thecloud-docsrepo on branchDOC-1339-fix-single-sourcing, otherwise the xref will be broken.
20-23: ConditionalSee alsolink for non-Cloud
Theifndef::env-cloud[]block correctly retains the standard config and quickstart links for on-prem users.
29-31: Conditional link in "Specify configuration properties" for Cloud
The cloud-specificrpk profilelink is properly scoped underifdef::env-cloud[].
32-34: Conditional link in "Specify configuration properties" for non-Cloud
The non-cloud path is correctly preserved underifndef::env-cloud[].
|
To avoid these conditionals, you can just add a page aliases in the Cloud docs for
This will make |
|
Closing, as this was fixed in redpanda-data/cloud-docs#285 |
2 participants
Description
This pull request updates branch references in the Antora playbook and improves conditional content handling in the "Intro to rpk" documentation. The changes ensure better alignment with the current development workflow and enhance the documentation's adaptability for different environments.
intro-to-rpk.adocto include environment-specific links for theconfig-rpk-profiletopic. This ensures the correct content is displayed based on whether the environment iscloudor not.Resolves https://redpandadata.atlassian.net/browse/DOC-1340
Review deadline:
Page previews
Intro to rpk - SM
Intro to rpk - Cloud
Checks