Skip to content

user-guide: add warning for permissions additiveness#11

Merged
NicolasCARPi merged 2 commits into
masterfrom
nico/260518-perms
May 18, 2026
Merged

user-guide: add warning for permissions additiveness#11
NicolasCARPi merged 2 commits into
masterfrom
nico/260518-perms

Conversation

@NicolasCARPi
Copy link
Copy Markdown
Contributor

@NicolasCARPi NicolasCARPi commented May 18, 2026

:)

Summary by CodeRabbit

  • Documentation
    • Clarified permissions guidance: added a prominent warning that permission assignments are additive relative to the chosen base permission. Advises selecting a restrictive base permission when you don’t want to broadly share access, then explicitly adding teams, teamgroups, or individual users as needed to grant access. Includes concise examples and actionable guidance for safer permission setup.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5db311fd-fa78-46a6-b1c2-87da592c32fc

📥 Commits

Reviewing files that changed from the base of the PR and between 95b819e and c3e0f0f.

📒 Files selected for processing (1)
  • docs/usage/user-guide/experiments.md

Walkthrough

This PR adds a clarifying warning to the Permissions section of the experiments user guide. The new callout explains that permissions are additive relative to the base permission and directs users to select a restrictive base permission, then explicitly grant access to teams, teamgroups, or users as required.

Changes

Permissions Documentation Update

Layer / File(s) Summary
Permissions additive behavior warning
docs/usage/user-guide/experiments.md
A warning callout is added to the Permissions section explaining that permissions are additive on top of the selected base permission, with guidance to use a restrictive base permission and then explicitly add access grants as needed.

Estimated Code Review Effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🚀 Captain's note: a beacon bright and true,

Permissions stack — heed what you do,
Start restrictive, add those you trust,
Clearer guidance, tidy and just.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'user-guide: add warning for permissions additiveness' directly and accurately describes the main change: adding a warning callout to the permissions section explaining that permissions are additive.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nico/260518-perms

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

Copy link
Copy Markdown

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/usage/user-guide/experiments.md`:
- Around line 215-217: The admonition block's delimiters are mismatched: it
opens with ":::warning" but closes with "::::" causing a Docusaurus render
error; update the closing delimiter to use three colons (":::") so the warning
block's opening ":::warning" and closing "::: " match (look for the ":::warning"
/ "::::" pair in the experiments.md content around the permissions note).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 27e24c20-76c0-46ba-ad28-fc33a369c990

📥 Commits

Reviewing files that changed from the base of the PR and between 8b3277f and 95b819e.

📒 Files selected for processing (1)
  • docs/usage/user-guide/experiments.md

Comment thread docs/usage/user-guide/experiments.md Outdated
@NicolasCARPi NicolasCARPi merged commit 0384bf2 into master May 18, 2026
1 of 2 checks passed
@NicolasCARPi NicolasCARPi deleted the nico/260518-perms branch May 18, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant