From 825efff1fad56aa206af5a061d1267fc4f02ea2d Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:54:48 -0700 Subject: [PATCH 1/6] Edits to summaries of docs under Managing users --- site/guide/configuration/manage-groups.qmd | 6 +++--- site/guide/configuration/manage-permissions.qmd | 2 +- site/guide/configuration/manage-roles.qmd | 2 +- site/guide/configuration/manage-users.qmd | 3 ++- site/training/training-for-administrators.qmd | 2 +- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/site/guide/configuration/manage-groups.qmd b/site/guide/configuration/manage-groups.qmd index 7e1f1e465e..c8308e37cb 100644 --- a/site/guide/configuration/manage-groups.qmd +++ b/site/guide/configuration/manage-groups.qmd @@ -2,10 +2,10 @@ title: "Manage groups" --- -Invite new users and assign users to specific groups to maintain access control and efficient user management within your organization via the {{< var validmind.platform >}}. +Groups are segments of users with the ability to view models associated with that group. Access to granular features in the {{< var validmind.platform >}} within a group's set of models is further defined by roles and permissions. -::: {.callout-important} -Ensure that the group details align with your requirements for access control and group management. +::: {.callout} +Users must belong to a default group, and can belong to mulitple groups. ::: ::: {.prereq} diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index 668aacd51b..e58f714578 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -4,7 +4,7 @@ date: last-modified tbl-cap-location: bottom --- -Use permissions to streamline and secure access control within your organization. Add or remove roles for specific permissions and ensure that individuals have access to the right features. +Permissions dictate user access controls within the {{< var validmind.platform >}}, and are associated with specific roles. Assign granular permissions to roles according to your organization's custom requirements. ::: {.prereq} diff --git a/site/guide/configuration/manage-roles.qmd b/site/guide/configuration/manage-roles.qmd index 8c8ec7b18b..d93a274d7c 100644 --- a/site/guide/configuration/manage-roles.qmd +++ b/site/guide/configuration/manage-roles.qmd @@ -2,7 +2,7 @@ title: "Manage roles" --- -Managing roles is crucial for maintaining a secure and well-organized environment. Assign, update, and view permissions for different roles, and ensure that each role has appropriate access to the resources they need. +Roles are a named set of permissions that determine your users' access to features within the {{< var vm.platform >}} based on your organization's structure. Create and update roles, and verify that each role has appropriate access to the resources they need. ::: {.prereq} diff --git a/site/guide/configuration/manage-users.qmd b/site/guide/configuration/manage-users.qmd index 0d6ea23f50..6da0214661 100644 --- a/site/guide/configuration/manage-users.qmd +++ b/site/guide/configuration/manage-users.qmd @@ -2,7 +2,8 @@ title: "Manage users" date: last-modified --- -Ensure smooth operations and maintain secure access controls by managing users. The {{< var validmind.platform >}} offers robust features for managing user profiles, roles, groups, and invitations effectively. + +Invite new users and review your current users from within the user directory. Users belong to groups which determine which models they can see, and have roles with attached permissions which define the level of access they have to features. ::: {.prereq} diff --git a/site/training/training-for-administrators.qmd b/site/training/training-for-administrators.qmd index 81bcc690c4..ee5339ddd1 100644 --- a/site/training/training-for-administrators.qmd +++ b/site/training/training-for-administrators.qmd @@ -186,7 +186,7 @@ When you are done, click [{{< fa chevron-right >}}]() to continue. :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Assign roles to users to define their responsibilities and grant permissions to groups to set access levels. +Assign roles to users to define their responsibilities based on your organization's structure, granting them acccess to features within the {{< var validmind.platform >}}. ::: ::: {.column width="70%" .bl .pl4 .f3} From ad3e2a566ab8bad731c3870b93d91bbea13cbaa6 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:11:25 -0700 Subject: [PATCH 2/6] Added section for renaming roles --- site/guide/configuration/manage-groups.qmd | 2 +- .../configuration/manage-permissions.qmd | 2 +- site/guide/configuration/manage-roles.qmd | 22 ++++++++++++++++--- site/training/training-for-administrators.qmd | 2 +- 4 files changed, 22 insertions(+), 6 deletions(-) diff --git a/site/guide/configuration/manage-groups.qmd b/site/guide/configuration/manage-groups.qmd index c8308e37cb..9ed054ac12 100644 --- a/site/guide/configuration/manage-groups.qmd +++ b/site/guide/configuration/manage-groups.qmd @@ -5,7 +5,7 @@ title: "Manage groups" Groups are segments of users with the ability to view models associated with that group. Access to granular features in the {{< var validmind.platform >}} within a group's set of models is further defined by roles and permissions. ::: {.callout} -Users must belong to a default group, and can belong to mulitple groups. +Users must belong to a default group of `All`, and can belong to mulitple groups. ::: ::: {.prereq} diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index e58f714578..b2b6c3128c 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -17,7 +17,7 @@ Permissions dictate user access controls within the {{< var validmind.platform > ## Steps -::: {.callout-important title="Be careful when modifying permissions to ensure they align with the role's intended responsibilities and access requirements."} +::: {.callout-important title="When assigning permissions to roles, ensure they align with the role's intended responsibilities and access requirements."} Please note that the `Customer Admin` role has the highest level of access and as such, its permissions cannot be modified. ::: diff --git a/site/guide/configuration/manage-roles.qmd b/site/guide/configuration/manage-roles.qmd index d93a274d7c..6db7d65264 100644 --- a/site/guide/configuration/manage-roles.qmd +++ b/site/guide/configuration/manage-roles.qmd @@ -13,16 +13,32 @@ Roles are a named set of permissions that determine your users' access to featur ::: -## Steps +## Add or update roles -::: {.callout-important} -Be careful when modifying permissions to ensure they align with the role's intended responsibilities and access requirements. +::: {.callout-important title="Role permissions and role assignments determines a user's level of access."} +Please note that the `Customer Admin` role has the highest level of access and as such, it cannot be cannot be modified. ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**. {{< include _manage-roles.qmd >}} +### Rename existing roles + +To rename a role after it has been created: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under User Permissions, select **{{< fa user-group >}} Roles**. + +3. Select the role you want to rename. + +4. On the role's detail view, click on the title of the role. + + Type in the new name of the role. + +6. Click **Save** to apply your changes. + diff --git a/site/training/training-for-administrators.qmd b/site/training/training-for-administrators.qmd index ee5339ddd1..084225fce6 100644 --- a/site/training/training-for-administrators.qmd +++ b/site/training/training-for-administrators.qmd @@ -186,7 +186,7 @@ When you are done, click [{{< fa chevron-right >}}]() to continue. :::: {.columns} ::: {.column width="30%" .pr4 .f2} -Assign roles to users to define their responsibilities based on your organization's structure, granting them acccess to features within the {{< var validmind.platform >}}. +Assign roles to users to define responsibilities based on your organization's structure, granting them acccess to features within the {{< var validmind.platform >}}. ::: ::: {.column width="70%" .bl .pl4 .f3} From 7bb549334019d52e6302d2e9aa6cc16e51ca53ab Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:36:14 -0700 Subject: [PATCH 3/6] Quick tweak to Register models for user groups --- .../model-inventory/register-models-in-inventory.qmd | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/site/guide/model-inventory/register-models-in-inventory.qmd b/site/guide/model-inventory/register-models-in-inventory.qmd index 9137372026..2fc58bf4f7 100644 --- a/site/guide/model-inventory/register-models-in-inventory.qmd +++ b/site/guide/model-inventory/register-models-in-inventory.qmd @@ -34,12 +34,13 @@ If no additional fields are required on registration for your models: | Field | Description | |---:|---| | Model Name | The name of your model. | +| Group | (conditional) If you belong to multiple user groups,[^3] select the group that can see the model. | | What type of model is it? | Whether the model is a new model, or an existing model. | -| Template (conditional) | New models require a **Template**[^3] to be selected. | +| Template (conditional) | New models require a **Template**[^4] to be selected. | | Model Status (conditional) | Existing models require a **Model Status** to be selected. | | Business Unit | Business unit associated with the model. | | Use Case | The model's use case. | -| Is it a vendor model? (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^4] | +| Is it a vendor model? (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^5] | | Vendor Name (conditional) | If the model is a vendor model, provide the vendor's name. | | Purpose | Explain what the model will be used for. | | Preliminary Risk Tier | Assign a preliminary risk tier. | @@ -70,6 +71,8 @@ If additional fields are required on model registration for your organization: [^2]: [Manage model inventory fields](manage-model-inventory-fields.qmd) -[^3]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd) +[^3]: [Manage groups](/guide/configuration/manage-groups.qmd) -[^4]: Learn more about [vendor models](/about/glossary/glossary.qmd#vendor-model) +[^4]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd) + +[^5]: Learn more about [vendor models](/about/glossary/glossary.qmd#vendor-model) From 24932d42136b75057f3529922585d3df90caf717 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Thu, 29 Aug 2024 08:54:06 -0700 Subject: [PATCH 4/6] Update site/guide/configuration/manage-permissions.qmd Co-authored-by: Nik Richers --- site/guide/configuration/manage-permissions.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index b2b6c3128c..71c471c79b 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -18,7 +18,7 @@ Permissions dictate user access controls within the {{< var validmind.platform > ## Steps ::: {.callout-important title="When assigning permissions to roles, ensure they align with the role's intended responsibilities and access requirements."} -Please note that the `Customer Admin` role has the highest level of access and as such, its permissions cannot be modified. +Please note that the `Customer Admin` role has the highest level of access and, as such, its permissions cannot be modified. ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**. From 277c298b5efe28980d40577cd378e73de2c9599b Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Thu, 29 Aug 2024 08:54:54 -0700 Subject: [PATCH 5/6] Update site/guide/configuration/manage-roles.qmd Co-authored-by: Nik Richers --- site/guide/configuration/manage-roles.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/configuration/manage-roles.qmd b/site/guide/configuration/manage-roles.qmd index 6db7d65264..5c9062d3bf 100644 --- a/site/guide/configuration/manage-roles.qmd +++ b/site/guide/configuration/manage-roles.qmd @@ -35,7 +35,7 @@ To rename a role after it has been created: 4. On the role's detail view, click on the title of the role. - Type in the new name of the role. +5. Type in the new name of the role. 6. Click **Save** to apply your changes. From e79ed0ce36e5d402a8ea125ba417d9326572bbf3 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Thu, 29 Aug 2024 08:55:53 -0700 Subject: [PATCH 6/6] Quick tweak, comma unification --- site/guide/configuration/manage-permissions.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index 71c471c79b..2331a58559 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -18,7 +18,7 @@ Permissions dictate user access controls within the {{< var validmind.platform > ## Steps ::: {.callout-important title="When assigning permissions to roles, ensure they align with the role's intended responsibilities and access requirements."} -Please note that the `Customer Admin` role has the highest level of access and, as such, its permissions cannot be modified. +Please note that the `Customer Admin` role has the highest level of access and as such its permissions cannot be modified. ::: 1. In the left sidebar, click **{{< fa gear >}} Settings**.