Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix project role docs #21832

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

klemmster
Copy link

@klemmster klemmster commented Feb 10, 2025

The docs were using the role description, not the role name as handle

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Copy link

bunnyshell bot commented Feb 10, 2025

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

@blakepettersson blakepettersson changed the title Fix project role docs docs: ix project role docs Feb 13, 2025
@blakepettersson blakepettersson changed the title docs: ix project role docs docs: fix project role docs Feb 13, 2025
@blakepettersson
Copy link
Member

@klemmster you'll need to signoff your commit

git commit --amend -s

@@ -140,15 +140,15 @@ spec:
groups:
- some-user
policies:
- p, proj:sample-test-project:some-role, applications, *, *, allow
- p, proj:sample-test-project:admin, applications, *, *, allow
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- p, proj:sample-test-project:admin, applications, *, *, allow
- p, proj:sample-test-project:admin, applications, *, *, allow

This doesn't necessarily need to be an admin role.

Copy link
Author

Choose a reason for hiding this comment

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

Doesn't it?
The role name is taken from a few lines above:
0f3d760#diff-d89745b05f3543cc0beea51e5f2a351f604b8ef117448098e65166afa08c70f5R138

and the explanation says:

A role's policy can only grant access to that role.

From that, my understanding is that this must be the admin role.

Copy link
Member

Choose a reason for hiding this comment

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

@klemmster you're right, the name is given a few lines above and policies should use the given role name. I guess another option is to rename the role name to some-role.

Copy link
Member

@nitishfy nitishfy left a comment

Choose a reason for hiding this comment

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

PTAL

The docs were using the role description, not the role name as handle

Signed-off-by: Richard Palm <[email protected]>
@klemmster klemmster force-pushed the fix/project-roles-docs branch from 0f3d760 to 84517e2 Compare February 21, 2025 16:45
@klemmster klemmster requested a review from nitishfy February 21, 2025 16:45
@klemmster klemmster marked this pull request as ready for review February 21, 2025 16:46
@klemmster klemmster requested review from a team as code owners February 21, 2025 16:46
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