Remove documentation for broken roles feature#2117
Merged
Conversation
4 tasks
✅ 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. |
2 tasks
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull request overview
Removes end-user documentation for the Roles-based access control feature (which is currently broken / unsafe per linked issue), and cleans up the documentation site navigation accordingly.
Changes:
- Removed the “Access Control / Roles” entry from the MkDocs navigation.
- Deleted the Roles documentation page.
- Removed associated images that were only used by the deleted Roles page.
Reviewed changes
Copilot reviewed 2 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Removes the Roles documentation page from the generated docs navigation. |
| docs/usage/access-control/roles.md | Deletes the Roles feature documentation content. |
| docs/images/select_permissions.png | Removes an image that was only referenced by the deleted Roles page. |
| docs/images/roles_page_view.png | Removes an image that was only referenced by the deleted Roles page. |
| docs/images/redpanda-console_messages.png | Removes an image included in the PR changes. |
| docs/images/managed_users_page_view.png | Removes an image that was only referenced by the deleted Roles page. |
| docs/images/demo_webhook_notifications.png | Removes an image included in the PR changes. |
| docs/images/demo_redpanda-console_consumer-groups_default.png | Removes an image included in the PR changes. |
| docs/images/demo_redpanda-console_consumer-groups_default-detailed.png | Removes an image included in the PR changes. |
| docs/images/demo_dtrack_create-alert.png | Removes an image included in the PR changes. |
| docs/images/demo_dtrack_configure-alert.png | Removes an image included in the PR changes. |
| docs/images/create_role.png | Removes an image that was only referenced by the deleted Roles page. |
| docs/images/create_managed_user.png | Removes an image that was only referenced by the deleted Roles page. |
| docs/images/assign_role.png | Removes an image that was only referenced by the deleted Roles page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Refer to #2116 for background Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
force-pushed
the
remove-role-docs
branch
from
1b78a22 to
f1b2929
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
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
Removes documentation for broken roles feature.
Refer to #2116 for background.
Addressed Issue
Relates to #2116
Additional Details
API server PR: DependencyTrack/hyades-apiserver#1954
Frontend PR: DependencyTrack/hyades-frontend#466
Checklist
This PR fixes a defect, and I have provided tests to verify that the fix is effectiveThis PR implements an enhancement, and I have provided tests to verify that it works as intendedThis PR introduces changes to the database model, and I have updated the migration changelog accordingly