Skip to content

Conversation

@Sheeproid
Copy link
Contributor

@Sheeproid Sheeproid commented Dec 7, 2025

Screenshot 2025-12-07 at 12 25 07

@Sheeproid Sheeproid requested a review from arikalon1 December 7, 2025 10:25
@coderabbitai
Copy link

coderabbitai bot commented Dec 7, 2025

Walkthrough

Adds an image and new "Finding CRD Names and API Groups" section to CRD docs, provides kubectl examples and sample output, expands RBAC "Basic Configuration" guidance (including use of "*" to monitor all resources), and replaces specific acme.cert-manager.io resource entries with wildcard usage in examples.

Changes

Cohort / File(s) Summary
Documentation updates
docs/setup-robusta/crds.rst
Adds an overview image; adds "Finding CRD Names and API Groups" with kubectl get crd example and sample output; updates "Basic Configuration" RBAC examples to show apiGroups change from acme.cert-manager.iocert-manager.io, replaces specific resources with * option and adds transitional explanatory text.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Single-file documentation change.
  • Review focus: example command correctness, YAML snippets accuracy, and wording clarity.

Possibly related PRs

Suggested reviewers

  • RoiGlinik

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: adding documentation on how to get CRD names for configuration and including an image.
Description check ✅ Passed The description contains only an embedded screenshot image without any textual explanation of the changes, making it minimal but related to the PR's visual documentation update.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch crd-docs-hints

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d383f83 and 2eb50e5.

📒 Files selected for processing (1)
  • docs/setup-robusta/crds.rst (3 hunks)
⏰ 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: run_tests
  • GitHub Check: run_tests
  • GitHub Check: Deploy docs
🔇 Additional comments (2)
docs/setup-robusta/crds.rst (2)

29-50: Well-structured guidance for discovering CRD names and API groups.

The new section provides clear, accurate instructions with a practical kubectl command and realistic example output. This significantly improves user experience by showing exactly what users need to look for in subsequent configuration steps.


52-85: Excellent expansion clarifying specific vs. wildcard resource monitoring.

The two examples effectively demonstrate both granular and broad monitoring approaches. The introductory text at line 55 clearly explains the options, and the dual examples help users choose the right approach for their needs. The cert-manager.io API group is correct for all listed resources (certificates, certificaterequests, issuers, clusterissuers).


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@arikalon1 arikalon1 left a comment

Choose a reason for hiding this comment

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

LGTM

@arikalon1 arikalon1 merged commit 937fb7f into master Dec 7, 2025
9 of 10 checks passed
@arikalon1 arikalon1 deleted the crd-docs-hints branch December 7, 2025 14:01
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.

3 participants