Skip to content

DOC-1587 Conditionalize Manage Throughput for Cloud#1309

Merged
micheleRP merged 12 commits intomainfrom
DOC-1587-Conditionalize-Manage-Throughput-for-Cloud
Aug 19, 2025
Merged

DOC-1587 Conditionalize Manage Throughput for Cloud#1309
micheleRP merged 12 commits intomainfrom
DOC-1587-Conditionalize-Manage-Throughput-for-Cloud

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

@micheleRP micheleRP commented Aug 14, 2025

Description

This pull request makes rpk cluster quotas commands + the Manage Throughput file single-sourceable to cloud-docs and conditionalizes out SM-specific properties: [1] [2]
It also adds this line: You can manage client quotas with rpk cluster quotas or with the Kafka API. (Soon, it will also be on the Quotas page in Redpanda Cloud.. but not yet). When no quotas apply, the client has unlimited throughput.

Single sourcing for cloud-docs (including What's New in Cloud) is done in redpanda-data/cloud-docs#388.

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

Page previews

Manage Throughput in Cloud docs

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner August 14, 2025 17:46
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 14, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Adds AsciiDoc single-source region markers to modules/manage/pages/cluster-maintenance/manage-throughput.adoc: inserts // tag::single-source[] near the top (after page-categories) and // end::single-source[] at the end. No content edits, feature changes, or behavior modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Conditionalize Manage Throughput for Cloud (DOC-1587) Only single-source region markers added; no conditional logic or Cloud-specific blocks present in this change.

Possibly related PRs

Suggested reviewers

  • Feediver1
  • mattschumpert
  • alenkacz
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1587-Conditionalize-Manage-Throughput-for-Cloud

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 14, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 8c92220
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68a3df7e6b41e70008af40ce
😎 Deploy Preview https://deploy-preview-1309--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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/manage/pages/cluster-maintenance/manage-throughput.adoc (1)

4-4: No downstream includes found; tag block is balanced

  • Search for include::…manage-throughput.adoc returned no hits—this region isn’t currently reused.
  • The // tag::single-source[]/// end::single-source[] block is correctly balanced (1 start, 1 end).
  • When you do include this file in the future, be sure to add tags=single-source to scope the snippet.
  • If you later need only a subset of this content (e.g., excluding broker-wide cluster-config sections), introduce nested tag blocks for finer granularity.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5dbab27 and d1a281f.

📒 Files selected for processing (1)
  • modules/manage/pages/cluster-maintenance/manage-throughput.adoc (2 hunks)
🔇 Additional comments (2)
modules/manage/pages/cluster-maintenance/manage-throughput.adoc (2)

4-4: Start tag correctly scopes reusable body content

Placing the tag after the title and page attributes is appropriate for single-sourcing only the body content without leaking page-level metadata into includes.


246-246: Closing tag matches and cleanly wraps the intended region

The region is properly terminated; no block/tables are left unterminated at the boundary.

@micheleRP micheleRP requested a review from weeco August 15, 2025 20:32
@micheleRP
Copy link
Copy Markdown
Contributor Author

@mattschumpert do you want this added to the Cloud What's New?

@mattschumpert
Copy link
Copy Markdown

Sure, Martin said it's not love in production yet but I guess it will be Tuesday ?

@micheleRP
Copy link
Copy Markdown
Contributor Author

Sure, Martin said it's not love in production yet but I guess it will be Tuesday ?

I'll add to What's New & wait to merge until @weeco's approval

@weeco
Copy link
Copy Markdown
Contributor

weeco commented Aug 16, 2025

yet but I guess it will be Tuesday ?

We missed the release train, we got the okay to merge too late. But managing is not possible, just viewing client quotas.

I'm not a SME for cluster quotas.

Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blockers, just minor suggestions

micheleRP and others added 2 commits August 18, 2025 20:11
@micheleRP micheleRP merged commit 5a571e2 into main Aug 19, 2025
7 checks passed
@micheleRP micheleRP deleted the DOC-1587-Conditionalize-Manage-Throughput-for-Cloud branch August 19, 2025 02:28
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.

5 participants