DOC-1274 Azure doc edits #275
Conversation
WalkthroughThe documentation for creating a BYOC cluster on Azure was updated to clarify terminology, improve the flow of instructions, and enhance usability. Notable changes include expanded explanations for virtual CPUs, reorganization of notes and instructions for better visibility, an updated section on Azure SKU restrictions with explicit examples, and the addition of an interactive prerequisite checklist. Minor formatting and wording adjustments were made throughout, and the "Next steps" section was expanded with more relevant links. No code or public API changes were introduced. Changes
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![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
🧹 Nitpick comments (5)
modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc (5)
69-75: Enhance vCPU quota verification and link styling
The new section explains vCPU requirements clearly, but we can drive action by providing an Azure CLI example and maintain consistency by using an Asciidoc cross-reference instead of a raw URL.Consider applying a diff like this:
+ Use the Azure CLI to check your current usage: + + [source,bash] + ---- + az vm list-usage -l <region> --output table + ---- + See xref:manage:quotas/view-quotas[Microsoft quotas documentation] for more details.
77-78: Convert inline “NOTE:” to an admonition block
The inline NOTE is informative but inconsistent with other Asciidoc admonitions. Wrapping it in a block enhances readability:+ [NOTE] + ---- + If you run Redpanda Connect pipelines, or if you <<enable-kafka-connect,enable Kafka Connect>>, Redpanda also deploys an additional node pool. + ----
82-87: Unify code-block styling and clarify parameters
This snippet uses[source,bash]/----while earlier commands use fenced blocks. For consistency, switch to triple backticks and prompt users to replace both region and SKU:+ + ``` + # Replace <region> and <SKU_size> with your target region and VM size + az vm list-skus -l <region> --zone --size <SKU_size> --output table + ```
106-106: Use a cross-reference for the support-request link
Raw URLs break flow—consider an xref macro to match surrounding links.+ If you see restrictions, open a xref:troubleshoot/azure/general/region-access-request-process[Microsoft support request] to remove them.
130-131: Refine wording in the new NOTE block
The two bullets are clear but slightly repetitive; tightening the phrasing improves readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (3)
modules/get-started/pages/cluster-types/byoc/azure/create-byoc-cluster-azure.adoc (3)
90-96: Example output (no restrictions) looks good
The table sample accurately demonstrates the expected “None” restrictions state and is clear.
98-104: Example output (with restrictions) is informative
The restricted output example correctly flags “NotAvailableForSubscription.” Good clarity on what to look for.
108-117: Verify interactive checklist support
The new interactive checklist is a great way to track prerequisites. Please confirm that[%interactive]is supported in your build pipeline (Netlify/Asciidoc toolchain).
Description
This pull request updates the Azure BYOC cluster creation documentation to improve clarity, add a prerequisite checklist, and enhance the "Next Steps" section.
rpkversion, Azure role, and vCPU quota.rpkcommands to guide users after cluster creation.Resolves https://redpandadata.atlassian.net/browse/DOC-1274
Review deadline: April 28
Page previews
Create BYOC Cluster on Azure
Checks