Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Updated permissions in docs#273

Merged
validbeck merged 39 commits intomainvalidmind/documentation:mainfrom
beck/sc-4995/discuss-switching-from-roles-to-permissionsvalidmind/documentation:beck/sc-4995/discuss-switching-from-roles-to-permissionsCopy head branch name to clipboard
Aug 15, 2024
Merged

Updated permissions in docs#273
validbeck merged 39 commits intomainvalidmind/documentation:mainfrom
beck/sc-4995/discuss-switching-from-roles-to-permissionsvalidmind/documentation:beck/sc-4995/discuss-switching-from-roles-to-permissionsCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Aug 14, 2024

Internal Notes for Reviewers

For sc-4995, I:

  • Established a new prereq convention & CSS class
  • Added a variable back in for our login information
  • Added a framework in configuration/manage-permissions.qmd for permissions tables (when the correct permissions are released)
  • Adjusted any prereq blurbs to be more inclusive of permissions/roles, linking out to context when relevant
  • Did a preliminary review of modified instructions for accuracy (removed repetitive "1. Log in to ValidMind," cleaned up inaccurate references, etc.). See comment on audit Story for remaining articles to review.

Permissions table

While the permissions table on configuration/manage-permissions.qmd isn't 100% accurate just yet (see context on Slack) it provides the foundation for one source of truth we can link to in the docs instead of re-outlining each potentially relevant granular permission on every article.

Whenever permissions change or are added, only one page has to be updated (more or less).

permissions-table

Managing users

The Supported Roles section is now Default roles, to accommodate for the ability to add custom roles and toggle granular permissions:

Old New
Screenshot 2024-08-14 at 9 35 09 AM default-roles

prereq class

At the request of Nik, there is now a special CSS class that stands apart from the rest of the instructions (and also callouts!). It looks a bit different depending on what is contained in that section.

  • While it is called the prereq class, it's just some styling — I've also used it in a few other places to draw attention to the central information on that page.
  • It's just an FA icon in front of the header text, so it can be changed depending on the section.
Old New
Screenshot 2024-08-14 at 9 46 08 AM Screenshot 2024-08-12 at 3 01 47 PM
Screenshot 2024-08-14 at 9 47 14 AM Screenshot 2024-08-12 at 3 02 37 PM

Margin styling

Depending on whether or not there are margin footnotes, the section will span the entire body + margin or just the body:

  • I personally rather like this effect, since if there are margin footnotes the continuation of the section draws the eye to the supplementary information in a subtle way.
  • If there aren't any footnotes, it keeps the line of sight contained to the body only.
Margin footnotes No margin footnotes
Screenshot 2024-08-12 at 3 03 36 PM Screenshot 2024-08-12 at 3 05 43 PM

Prerequisites

These are now a task list:

  • This solves the problem of the login-link variable adding extraneous spacing before and after the variable line when in a bulleted list, causing the other items needing to be spaced.
  • This visually indicates to the user that these items are things they should be "checking off" (at least mentally), qualifications they need to confirm they have.
  • Any references to required roles names the default role, or mentions sufficient permissions and links to the "Manage permissions" guide.
Old New
Screenshot 2024-08-14 at 9 52 28 AM Screenshot 2024-08-12 at 3 05 30 PM

Instructions

Since the prerequisite covers the link to the login page, I've removed it from any 1-2-3 instructions and cleaned up as many simple instructions as I can to ensure that they reflect the UI and are accurate.

Old New
old-123 Screenshot 2024-08-14 at 9 39 37 AM

Customize your dashboard

Quick update to this page, as there was no information about resizing previously.

Old New
Screenshot 2024-08-14 at 9 36 44 AM arrange-widgets

@validbeck validbeck added the internal Not to be externalized in the release notes label Aug 14, 2024
@validbeck validbeck self-assigned this Aug 14, 2024
@validbeck validbeck requested a review from nrichers August 14, 2024 16:53
@validbeck validbeck changed the title Beck/sc 4995/discuss switching from roles to permissions Updated permissions in docs Aug 14, 2024
@validbeck
Copy link
Collaborator Author

After some discussion, an alternate version. Thoughs?

Screenshot 2024-08-14 at 4 52 21 PM

  • I personally like how clean and distinct this looks, and agreed that it didn't need necessarily need to be pink.
  • The checked off boxes will retain after move from page/refresh, and more or less indicate that all these things are necessary.

@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements and fixes to the documentation and configuration files within the project. The key changes include:

  1. Template Updates: Improved the structure and formatting of various documentation templates, including task templates, style guides, and configuration guides.
  2. Content Enhancements: Added more detailed instructions and prerequisites for various tasks, ensuring clarity and completeness.
  3. UI Element Updates: Updated UI element references to use consistent and clear icons and labels.
  4. Permission and Role Management: Enhanced the documentation around managing permissions, roles, and user groups, providing clearer instructions and examples.
  5. Workflow and Status Customization: Improved the documentation for setting up and customizing workflows and statuses, including adding, editing, and deleting steps and statuses.
  6. Model Inventory Management: Added detailed steps for managing the model inventory, including registering models, editing fields, and customizing the layout.
  7. Validation and Compliance: Enhanced the guidelines and steps for assessing compliance, linking evidence, and managing validation reports and findings.
  8. Security and Best Practices: Included best practices for storing credentials and managing sensitive information.

These changes aim to improve the usability and clarity of the documentation, making it easier for users to follow and implement the instructions provided.

Test Suggestions

  • Verify that all links in the documentation are working correctly and lead to the intended pages.
  • Check the formatting of the updated templates to ensure they render correctly in the UI.
  • Test the new instructions for managing permissions, roles, and user groups to ensure they are accurate and complete.
  • Validate the steps for customizing workflows and statuses to ensure they work as described.
  • Ensure that the model inventory management steps are clear and can be followed without issues.
  • Test the process of linking evidence and findings in validation reports to ensure it works as expected.
  • Review the security best practices to ensure they are up-to-date and correctly implemented.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! New "Prerequisites" section looks great, as do the other changes. Thank you so much. :shipit:

@validbeck validbeck merged commit 0ea0dee into main Aug 15, 2024
@validbeck validbeck deleted the beck/sc-4995/discuss-switching-from-roles-to-permissions branch August 15, 2024 23:58
@validbeck validbeck mentioned this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.