Skip to content

Conversation

Feediver1
Copy link
Contributor

@Feediver1 Feediver1 commented Aug 20, 2025

Description

Resolves (https://redpandadata.atlassian.net/browse/DOC-1629)
Review deadline:

Page previews

RBAC link in Cloud
RBAC link in SM

Checks

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

@Feediver1 Feediver1 requested a review from a team as a code owner August 20, 2025 15:29
Copy link
Contributor

coderabbitai bot commented Aug 20, 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 environment-gated documentation updates in modules/manage/pages/schema-reg/schema-reg-authorization.adoc. For env-cloud, inserts RBAC references to cloud-specific docs (rbac_dp.adoc and rbac-dp with single-source tag). For non-cloud, retains the existing RBAC doc link. Introduces a non-cloud-only troubleshooting example for an “Invalid license: not present” error when creating ACLs, including command/output. No code or API changes; only AsciiDoc content conditioned by env-cloud.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Assessment against linked issues

Objective Addressed Explanation
Conditionalize out license example for cloud (DOC-1629)
Fix broken cross-repo links with correct RBAC references (DOC-1629)

Assessment against linked issues: Out-of-scope changes

(no out-of-scope changes detected)

Possibly related PRs

Suggested reviewers

  • paulohtb6
  • 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-1629

🪧 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.

@Feediver1 Feediver1 requested a review from micheleRP August 20, 2025 15:29
@Feediver1 Feediver1 marked this pull request as draft August 20, 2025 15:30
Copy link
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: 1

🧹 Nitpick comments (1)
modules/manage/pages/schema-reg/schema-reg-authorization.adoc (1)

357-378: Standardize code block formatting and prompt style.

For consistency with earlier examples in this page:

  • Use [,bash] (or [source,bash]) rather than [bash].
  • Drop the leading $ prompt in commands (prior examples omit it).

Suggested tweak:

-[bash]
+[,bash]
 ----
-$ rpk security acl create --topic private --allow-principal mary --operation read --registry-subject private-key -v
+rpk security acl create --topic private --allow-principal mary --operation read --registry-subject private-key -v

Content and env-conditionalization look good otherwise.

📜 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 sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between afbd031 and e6bac48.

📒 Files selected for processing (1)
  • modules/manage/pages/schema-reg/schema-reg-authorization.adoc (3 hunks)

Copy link

netlify bot commented Aug 20, 2025

Deploy Preview for redpanda-docs-preview ready!

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

@Feediver1 Feediver1 marked this pull request as ready for review August 20, 2025 17:01
Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm

@Feediver1 Feediver1 merged commit d0a074c into main Aug 20, 2025
7 checks passed
@Feediver1 Feediver1 deleted the DOC-1629 branch August 20, 2025 17:07
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.

2 participants