DOC-1811 Document Cloud Feature User-based throughput quotas#534
DOC-1811 Document Cloud Feature User-based throughput quotas#534
Conversation
📝 WalkthroughWalkthroughThis pull request updates the documentation configuration and content to introduce user-based throughput quotas functionality. The Antora playbook is switched from the Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
📝 Coding Plan
Comment Tip CodeRabbit can generate a title for your PR based on the changes with custom instructions.Set the |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@pgellert, @mattschumpert please let me know if there are any changes to this for Cloud! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
local-antora-playbook.yml (1)
18-18: Add an explicit inline “revert before merge” marker at Line 18.This change is valid for preview, but adding an inline comment reduces the chance of accidentally merging a WIP branch pin.
Based on learnings: local Antora playbook branch overrides are used for cross-repo single-sourcing previews and are reverted before merge.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@local-antora-playbook.yml` at line 18, The branches entry currently pins a WIP branch ("v-WIP/26.1") which must be clearly marked for removal before merging; add an inline comment marker adjacent to the branches list (e.g., "REVERT-BEFORE-MERGE: v-WIP/26.1") so reviewers and CI can spot and remove the WIP pin prior to merge, updating the branches line/object that contains "v-WIP/26.1" to include that explicit revert-before-merge marker.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@local-antora-playbook.yml`:
- Line 18: The branches entry currently pins a WIP branch ("v-WIP/26.1") which
must be clearly marked for removal before merging; add an inline comment marker
adjacent to the branches list (e.g., "REVERT-BEFORE-MERGE: v-WIP/26.1") so
reviewers and CI can spot and remove the WIP pin prior to merge, updating the
branches line/object that contains "v-WIP/26.1" to include that explicit
revert-before-merge marker.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ba3fcdbf-0daa-48e1-8bbc-56e20dc2c3dc
📒 Files selected for processing (5)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/get-started/pages/whats-new-cloud.adocmodules/manage/pages/cluster-maintenance/about-throughput-quotas.adocmodules/manage/pages/cluster-maintenance/manage-throughput.adoc
pgellert
left a comment
pgellert
left a comment
There was a problem hiding this comment.
lgtm
please let me know if there are any changes to this for Cloud!
No Cloud-only changes needed for user quotas 👍
2 participants
Description
DO NOT MERGE UNTIL 26.1 + revert playbook
This PR updates doc to support the new user-based throughput quotas feature in Redpanda Cloud. SIngle sourcing done in redpanda-data/docs#1596
about-throughput-quotas.adoc, to single source user-based and client ID-based throughput quotas, their hierarchy, precedence, and quota tracking behavior.whats-new-cloud.adoc.about-throughput-quotas.adocto the navigation innav.adoc.manage-throughput.adocpage to cover user-based quotas, client ID-based quotas, and monitoring.Antora Playbook Update: REVERT BEFORE MERGING
v-WIP/26.1branch for preview docsResolves https://redpandadata.atlassian.net/browse/DOC-1811?search_id=7159cbcc-d80d-45ac-99c8-1f79b6177251
Review deadline: March 27
Page previews
What's New
About Client Throughput Quotas
Manage Throughput
Checks