Add page on users and permissions#5831
Open
Granjow wants to merge 1 commit intoDependencyTrack:masterfrom
Open
Add page on users and permissions#5831Granjow wants to merge 1 commit intoDependencyTrack:masterfrom
Granjow wants to merge 1 commit intoDependencyTrack:masterfrom
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation page for users and permissions to address the lack of user-facing documentation about the permission system. Currently, permissions are only documented in the OpenAPI specification, which is primarily intended for developers rather than end users.
Changes:
- Created a new Administration category documentation page listing all 14 permissions with user-friendly descriptions
- Provides a non-exhaustive overview of what each permission grants access to
Comments suppressed due to low confidence (1)
docs/_docs/administration/users-and-permissions.md:22
- Inconsistent capitalization: "Tags" should be lowercase "tags" to match the capitalization used in line 25 and throughout the documentation.
| `TAG_MANAGEMENT` | Modify Tags |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `VIEW_PORTFOLIO` | Read projects, services, tags, vulnerabilities, BOMs, Dependency Graph, metrics; use Search | | ||
| | `VIEW_VULNERABILITY` | Read analysis decisions and findings | | ||
| | `VULNERABILITY_ANALYSIS` | Record analysis decision | | ||
| | `VULNERABILITY_MANAGEMENT` | Modify vunlerabilities | |
There was a problem hiding this comment.
Spelling error: "vunlerabilities" should be "vulnerabilities".
Suggested change
| | `VULNERABILITY_MANAGEMENT` | Modify vunlerabilities | | |
| | `VULNERABILITY_MANAGEMENT` | Modify vulnerabilities | |
Signed-off-by: Simon A. Eugster <simon.eu@gmail.com>
Granjow
force-pushed
the
docs/permissions
branch
from
82fd1d1 to
0a867f0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Docs: Summarise permissions
Addressed Issue
Permissions are currently only documented in the OpenAPI specification, which is fine for developers, but not for normal users or for getting started with permissions.
closes #5830
Additional Details
I'm not entirely sure about chapter ordering, please let me know if changes are required and how you would do that (i.e. if there is an alternative to modifying countless .md front matters by hand to change the chapter number).
Checklist
This PR fixes a defect, and I have provided tests to verify that the fix is effectiveThis PR introduces changes to the database model, and I have added corresponding update logicThis PR introduces new or alters existing behavior, and I have updated the documentation accordingly