diff --git a/site/get-started/administrator/quickstart-administrator.qmd b/site/get-started/administrator/quickstart-administrator.qmd index 1ae3d3a692..0ea371e5ae 100644 --- a/site/get-started/administrator/quickstart-administrator.qmd +++ b/site/get-started/administrator/quickstart-administrator.qmd @@ -15,6 +15,8 @@ listing: contents: - ../../training/administrator-fundamentals/administrator-fundamentals-register.qmd - ../../guide/guides.qmd +includes: + quickstart: true --- Set up the foundational units for your organization within the {{< var validmind.platform >}}, prepare your organization for users, then grant access to your first user. @@ -23,13 +25,7 @@ Set up the foundational units for your organization within the {{< var validmind ## Set up your organization -First, let's set up the foundational units of your organization: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under Workspace, select **Organization**. - -3. Add business units and use cases as required by your organization. +First, let's set up the foundational units of your organization. In the left sidebar, click **{{< fa gear >}} Settings** to add business units and use cases: ::: {.panel-tabset} diff --git a/site/guide/attestation/_add-attestations.qmd b/site/guide/attestation/_add-attestations.qmd index db6c07d6b9..9e595c0d3f 100644 --- a/site/guide/attestation/_add-attestations.qmd +++ b/site/guide/attestation/_add-attestations.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Attestation Templates**. +1. Under {{< fa shield >}} Governance, select **Attestation Templates**. 1. Click **{{< fa plus >}} Add Attestation Template**. @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-hidden unless-format="revealjs"} a. In the left sidebar, click **{{< fa gear >}} Settings**. -a. Under Workspace, select **Attestation Templates**. +a. Under {{< fa shield >}} Governance, select **Attestation Templates**. a. Click **{{< fa plus >}} Add Attestation Template**. diff --git a/site/guide/attestation/_configure-attestations.qmd b/site/guide/attestation/_configure-attestations.qmd index 39a3cd9e52..2f86dc345f 100644 --- a/site/guide/attestation/_configure-attestations.qmd +++ b/site/guide/attestation/_configure-attestations.qmd @@ -8,7 +8,7 @@ To edit an existing attestation template: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Attestation Templates** and then click an attestation template to edit. +1. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click an attestation template to edit. ::: {.panel-tabset} diff --git a/site/guide/attestation/manage-attestations.qmd b/site/guide/attestation/manage-attestations.qmd index 766f532867..c6a3343081 100644 --- a/site/guide/attestation/manage-attestations.qmd +++ b/site/guide/attestation/manage-attestations.qmd @@ -46,7 +46,7 @@ For testing purposes only, you can trigger the attestation process: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Attestation Templates** and then click the attestation template to test. +2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to test. 3. Under **Attestation Periods**, hover over an attestation period. @@ -60,7 +60,7 @@ After starting the schedule, attestation participants are notified via My Inbox 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Attestation Templates** and then click the attestation template to edit. +2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to edit. 3. Under **Attestation Periods**, hover over an attestation period. @@ -84,7 +84,7 @@ This action cannot be undone. The history of previous attestation periods is una 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Attestation Templates** and then click the attestation template to manage. +2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template to manage. 3. Under **Attestation Periods**, hover over an attestation period. @@ -180,7 +180,7 @@ To manually complete an attestation period: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Attestation Templates** and then click the attestation template. +2. Under {{< fa shield >}} Governance, select **Attestation Templates** and then click the attestation template. 3. Under **Attestation Periods**, hover over an active attestation period. @@ -200,7 +200,7 @@ You cannot delete an attestation template if it has any active attestation perio 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Attestation Templates**. +2. Under {{< fa shield >}} Governance, select **Attestation Templates**. 3. Locate the template to delete and hover over it. diff --git a/site/guide/configuration/_add-business-units.qmd b/site/guide/configuration/_add-business-units.qmd index f28ae83fe3..d9fe0f3a9e 100644 --- a/site/guide/configuration/_add-business-units.qmd +++ b/site/guide/configuration/_add-business-units.qmd @@ -2,14 +2,27 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -:::: {.content-visible unless-format="revealjs"} -a. Click **{{< fa plus >}} Add New Business Unit** under Business Units. +:::: {.content-visible when-format="html" when-meta="includes.quickstart"} +1. Under {{< fa building >}} Organization, select **Organization**. + +1. Click **{{< fa plus >}} Add Business Unit** under Business Units. + +1. Enter in your **[business unit name]{.smallcaps}**. + +1. Click **Add Business Unit** to save your changes. + + After you save, confirm that the business unit was added as a new entry in alphabetical order. + +:::: + +:::: {.content-visible unless-format="revealjs" unless-meta="includes.quickstart"} +a. Click **{{< fa plus >}} Add Business Unit** under Business Units. a. Enter in your **[business unit name]{.smallcaps}**. -a. Click **{{< fa plus >}} Add Business Unit** to save your changes. +a. Click **Add Business Unit** to save your changes. - After you save, confirm that the business unit was added as a new entry in alphabetical order.. + After you save, confirm that the business unit was added as a new entry in alphabetical order. :::: @@ -18,13 +31,13 @@ a. Click **{{< fa plus >}} Add Business Unit** to save your changes. a. In the left sidebar, click **{{< fa gear >}} Settings**. -a. Under Workspace, select **Organization**. +a. Under {{< fa building >}} Organization, select **Organization**. -a. Click **{{< fa plus >}} Add New Business Unit** under Business Units. +a. Click **{{< fa plus >}} Add Business Unit** under Business Units. a. Enter in your **[business unit name]{.smallcaps}**. -a. Click **{{< fa plus >}} Add Business Unit** to save your changes. +a. Click **Add Business Unit** to save your changes. After you save, confirm that the business unit was added as a new entry in alphabetical order. :::: \ No newline at end of file diff --git a/site/guide/configuration/_add-groups.qmd b/site/guide/configuration/_add-groups.qmd index b1db3f3d3a..e89a39acae 100644 --- a/site/guide/configuration/_add-groups.qmd +++ b/site/guide/configuration/_add-groups.qmd @@ -5,15 +5,15 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **Groups**. +1. Under {{< fa users >}} Users & Access, select **Groups**. -1. Next to All Groups, click **{{< fa plus >}} Create Group** to open the Create New Group menu. +1. Click **{{< fa plus >}} Create Group**. 1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. 1. Select users from the list to add them to the group. -1. Click **{{< fa check >}} Create Group** to save. +1. Click **Create Group** to save. Confirm that the new group is created and appears in the list of available groups in alphabetical order. @@ -21,13 +21,13 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-hidden unless-format="revealjs"} -1. Next to All Groups, click **{{< fa plus >}} Create Group** to open the Create New Group menu. +1. Click **{{< fa plus >}} Create Group**. 1. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. 1. Select users from the list to add them to the group. -1. Click **{{< fa check >}} Create Group** to save. +1. Click **Create Group** to save. Confirm that the new group is created and appears in the list of available groups in alphabetical order. diff --git a/site/guide/configuration/_add-model-stakeholder-types.qmd b/site/guide/configuration/_add-model-stakeholder-types.qmd index 99aec547ab..bbef5b2aa7 100644 --- a/site/guide/configuration/_add-model-stakeholder-types.qmd +++ b/site/guide/configuration/_add-model-stakeholder-types.qmd @@ -3,31 +3,31 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa gear >}} Settings**. +1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Models, select **Model Stakeholder Types**. +1. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**. -1. Click **{{< fa plus >}} Add New Stakeholder Type**. +1. Click **{{< fa plus >}} Add Stakeholder Type**. 1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type.^[Role names and stakeholder type names cannot be duplicated to reduce confusion.] -1. Once you click **{{< fa plus >}} Add Stakeholder Type**, you can: +1. Once you click **Add Stakeholder Type**, you can: - Configure stakeholder type selection available upon model registration^[[Configure stakeholder types on registration](/guide/configuration/manage-model-stakeholder-types.qmd#configure-stakeholder-types-on-registration)] - - Manage the model inventory field^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] permissions associated with that type + - Manage the model inventory field^[[Manage stakeholder type permissions](/guide/configuration/manage-model-stakeholder-types.qmd#manage-stakeholder-type-permissions)] permissions associated with that type :::: :::: {.content-hidden unless-format="revealjs"} a. In the left sidebar, click **{{< fa gear >}} Settings**. -a. Under Models, select **Model Stakeholder Types**. +a. Under {{< fa cube >}} Model Inventory, select **Model Stakeholder Types**. -a. Click **{{< fa plus >}} Add New Stakeholder Type**. +a. Click **{{< fa plus >}} Add Stakeholder Type**. a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type. -1. Once you click **{{< fa plus >}} Add Stakeholder Type**, you can: +1. Once you click **Add Stakeholder Type**, you can: - Configure stakeholder type selection available upon model registration - Manage the model inventory field permissions associated with that type diff --git a/site/guide/configuration/_add-remove-group-members.qmd b/site/guide/configuration/_add-remove-group-members.qmd index b2c002f381..c111aab92d 100644 --- a/site/guide/configuration/_add-remove-group-members.qmd +++ b/site/guide/configuration/_add-remove-group-members.qmd @@ -5,7 +5,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **Groups**. +1. Under {{< fa users >}} Users & Access, select **Groups**. ::: {.panel-tabset} @@ -13,13 +13,13 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Click on the group you want to add members to. -a. Click **{{< fa plus >}} Add New Member**. +a. Click **{{< fa user-plus >}} Add Member**. -a. Select members by checking the boxes next to their names in the pop-up. +a. Select members by checking the boxes next to their names. -a. Click **{{< fa plus >}} Add to Group**. +a. Click **Add # User(s) Group**. - Confirm that the new member is added to the correct group. + Confirm that the new members are added to the correct group. #### Remove members @@ -27,9 +27,10 @@ a. Click on the group you want to remove members from. a. Select members to be removed from the group by checking the boxes next to their names. -a. Click **{{< fa user-minus >}} Remove Member**. +a. Review the number of selected members to be removed, then click **{{< fa user-minus >}} Remove**. + +a. Click **{{< fa user-minus >}} Remove # member(s)** to confirm removal of selected members from that group. -a. After you confirm, the user will be removed from that group. ::: @@ -39,12 +40,12 @@ a. After you confirm, the user will be removed from that group. :::: {.content-hidden unless-format="revealjs"} 1. Click on the group you want to add members to. -1. Click **{{< fa plus >}} Add New Member**. +1. Click **{{< fa user-plus >}} Add Member**. -1. Select members by checking the boxes next to their names in the pop-up. +1. Select members by checking the boxes next to their names. -1. Click **{{< fa plus >}} Add to Group**. +1. Click **Add # User(s) Group** - Confirm that the new member is added to the correct group. + Confirm that the new members are added to the correct group. :::: \ No newline at end of file diff --git a/site/guide/configuration/_add-roles.qmd b/site/guide/configuration/_add-roles.qmd index f1bc6ddec5..73a824fcfb 100644 --- a/site/guide/configuration/_add-roles.qmd +++ b/site/guide/configuration/_add-roles.qmd @@ -2,26 +2,40 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -:::: {.content-visible unless-format="revealjs"} +:::: {.content-visible unless-format="revealjs" unless-meta="includes.quickstart"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **Roles**. +1. Under {{< fa users >}} Users & Access, select **Roles**. 1. Click **{{< fa plus >}} Add Role**. 1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and model stakeholder type names cannot be duplicated to reduce confusion.] -1. Once you click **{{< fa plus >}} Add Role**, you can proceed with managing the user permissions and users associated with that role. +1. Once you click **Add Role**, you can proceed with managing the user permissions and users associated with that role. +:::: + + +:::: {.content-visible when-format="html" when-meta="includes.quickstart"} +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +1. Under {{< fa users >}} Users & Access, select **Roles**. + +1. Click **{{< fa plus >}} Add Role**. + +1. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and model stakeholder type names cannot be duplicated to reduce confusion.] + +1. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role. + :::: :::: {.content-hidden unless-format="revealjs"} a. In the left sidebar, click **{{< fa gear >}} Settings**. -a. Under User Permissions, select **Roles**. +a. Under {{< fa users >}} Users & Access, select **Roles**. a. Click **{{< fa plus >}} Add Role**. a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role. -a. Once you click **{{< fa plus >}} Add Role**, you can proceed with managing the user permissions and users associated with that role. +a. Once you click **Add Role**, you can proceed with managing the user permissions associated with that role. :::: \ No newline at end of file diff --git a/site/guide/configuration/_add-use-cases.qmd b/site/guide/configuration/_add-use-cases.qmd index aeffa9943f..4203b86571 100644 --- a/site/guide/configuration/_add-use-cases.qmd +++ b/site/guide/configuration/_add-use-cases.qmd @@ -7,25 +7,19 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Models, select **Model Inventory Fields**. +1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. -1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups. +1. In the Default Fields group, click on the **Use Case** field to add or remove use cases and use case groups: :::: -#### Add use case group - -To add a grouping for use cases: - -a. Type in your group title under **[options and groups]{.smallcaps}**. - -a. Click **{{< fa chevron-down >}}** next to {{< fa plus >}} Add Option. +:::: {.content-visible when-format="html" when-meta="includes.quickstart"} +1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. -a. Select **{{< fa plus >}} Add Group** then click **{{< fa plus >}} Add Group** to insert the group. +1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups: -a. Click **Save Configuration** to save the inserted use case group. +:::: - After you save, confirm that the use case group was added as a new entry at the bottom of the group list. #### Add use case option @@ -37,4 +31,18 @@ a. Click **{{< fa plus >}} Add Option** to add the use case to the list. a. (Optional) Hover over your use case, then click and hold to drag and drop the use case to a group. -a. Click **Save Configuration** to save the inserted use case. \ No newline at end of file +a. Click **Save Configuration** to save the inserted use case. + +#### Add use case group + +To add a grouping for use cases: + +a. Type in your group title under **[options and groups]{.smallcaps}**. + +a. Click **{{< fa chevron-down >}}** next to {{< fa plus >}} Add Option. + +a. Select **{{< fa plus >}} Add Group** then click **{{< fa plus >}} Add Group** to insert the group. + +a. Click **Save Configuration** to save the inserted use case group. + + After you save, confirm that the use case group was added as a new entry at the bottom of the group list. \ No newline at end of file diff --git a/site/guide/configuration/_invite-users.qmd b/site/guide/configuration/_invite-users.qmd index a564e3bada..e475048f27 100644 --- a/site/guide/configuration/_invite-users.qmd +++ b/site/guide/configuration/_invite-users.qmd @@ -2,15 +2,44 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> +:::: {.content-visible unless-format="revealjs"} a. Under Invite By Email: - Enter the user's **[email]{.smallcaps}** address. - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. - - Click **{{< fa plus >}}** under [role]{.smallcap} to open the Assign Roles menu for that user: + - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. - 2. Click **Assign Roles to Invitee**. + 2. Click **Assign Additional Roles (Optional)**.[^basic-user-role] b. Click **{{< fa envelope >}} Send Invite**. - Users will receive an email invitation that they must accept to join your organization. \ No newline at end of file + Users will receive an email invitation that they must accept to join your organization. + +:::: + + + + + +[^basic-user-role]: + + - Users invited without additional roles applied will be automatically assigned to a [{{< fa wrench >}} Basic User]{.bubble} role with minimal permissions. + - [Manage user roles](/guide/configuration/manage-users.qmd#manage-user-roles) + +:::: {.content-hidden unless-format="revealjs"} +a. Under Invite By Email: + + - Enter the user's **[email]{.smallcaps}** address. + - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. + - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: + + 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. + 2. Click **Assign Additional Roles (Optional)**. + +b. Click **{{< fa envelope >}} Send Invite**. + + Users will receive an email invitation that they must accept to join your organization. + +:::: + diff --git a/site/guide/configuration/_manage-permissions.qmd b/site/guide/configuration/_manage-permissions.qmd index 1ba3ed7663..4a1b70838d 100644 --- a/site/guide/configuration/_manage-permissions.qmd +++ b/site/guide/configuration/_manage-permissions.qmd @@ -4,13 +4,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **Permissions**. +1. Under {{< fa users >}} Users & Access, select **Permissions**. 1. Add or delete roles from a specific permission: - - To assign a role to a permission, click **{{< fa plus >}}**, then select the role from the drop-down menu. + - To assign a role to a permission, click **{{< fa circle-plus >}}**, then select the role from the drop-down menu. - To remove a role from a permission, click **{{< fa x >}}** next to the specified role. - For example, to grant the [{{< fa code >}} Developer]{.bubble} role the permission to update an existing template: - - 1. Locate **Update Template** under {{< fa clipboard >}} Template. - 1. Click **{{< fa plus >}}** and select [**{{< fa code >}} Developer**]{.bubble} from the drop-down menu. +:::: {.content-hidden unless-format="revealjs"} + +:::: {.f5 .pr3 .pl3 .mt4 .embed} +For example, to grant the [{{< fa code >}} Developer]{.bubble} role the permission to update an existing template: + +1. Locate **Update Template** under {{< fa clipboard >}} Template. +1. Click **{{< fa plus >}}** and select [**{{< fa code >}} Developer**]{.bubble} from the drop-down menu. + +::: + +:::: diff --git a/site/guide/configuration/_manage-role-permissions.qmd b/site/guide/configuration/_manage-role-permissions.qmd index 2c20a80da2..052784ccde 100644 --- a/site/guide/configuration/_manage-role-permissions.qmd +++ b/site/guide/configuration/_manage-role-permissions.qmd @@ -5,29 +5,29 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. Click on the role whose user permissions you want to change. -1. Select the **Permissions** tab, where you can: +1. Select a permission type to manage: - - View the current user permissions assigned to that role. - - Select user permissions to be assigned to that role. + - **Feature Permissions** — Granular permissions for specific features within the {{< var validmind.platform >}}.^[[Manage permissions](/guide/configuration/manage-permissions.qmd)] + - **Field Permissions** — Read and update (write) permissions for model inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] 1. Select **Edit Permissions** to to add or remove user permissions to or from that role. -1. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. +1. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. + +1. Click **Save Changes** to apply the configuration for those permissions on that role. -1. Click **Save Permissions** to apply your changes. :::: :::: {.content-hidden unless-format="revealjs"} -a. Click on the role whose user permissions you want to change. +a. Select a permission type to manage: -a. Select the **Permissions** tab, where you can: + - [**Feature Permissions**](/guide/configuration/manage-permissions.qmd){target="_blank"} — Granular permissions for specific features within the {{< var validmind.platform >}}. + - **Field Permissions** — Read and update (write) permissions for [model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}. - - View the current user permissions assigned to that role. - - Select user permissions to be assigned to that role. +a. Select **Edit Permissions** to to add or remove user permissions to or from that role. -a. Select **Edit Permissions** to to add or remove user permissions to or from that role. +a. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. -a. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. +a. Click **Save Changes** to apply the configuration for those permissions on that role. -a. Click **Save Permissions** to apply your changes. :::: \ No newline at end of file diff --git a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd index 56e93943a6..3cf8782138 100644 --- a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd +++ b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd @@ -5,16 +5,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. Click on the stakeholder type whose permissions you want to change. -1. On the **Permissions** tab, you can: +1. Select a permission type to manage: - - View the current model inventory field permissions assigned to that type. - - Select model inventory field permissions to be assigned to that type. + - **Models** — Read and update (write) permissions for model inventory fields^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] and document types.^[[Manage document types](/guide/templates/manage-document-types.qmd)] + - **Artifacts** — Read and update (write) permissions for artifact fields,^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] and add, delete, read, and update (write) permissions for artifact types.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] -1. Select **Edit Permissions** to modify inventory field permissions to or from that type. +1. Select **Edit Permissions** to modify read and update permissions to or from that type. -1. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission. +1. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission. -1. Click **Save Permissions** to apply your changes. +1. Click **Save Changes** to apply your changes. :::: @@ -22,15 +22,15 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-hidden unless-format="revealjs"} a. Click on the stakeholder type whose permissions you want to change. -a. On the **Permissions** tab, you can: +a. Select a permission type to manage: - - View the current model inventory field permissions assigned to that type. - - Select model inventory field permissions to be assigned to that type. + - **Models** — Read and update (write) permissions for [model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd){target="_blank"} and [document types](/guide/templates/manage-document-types.qmd){target="_blank"}. + - **Artifacts** — Read and update (write) permissions for [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}, and add, delete, read, and update (write) permissions for [artifact types](/guide/model-validation/manage-artifact-types.qmd){target="_blank"}. -a. Select **Edit Permissions** to modify inventory field permissions to or from that type. +a. Select **Edit Permissions** to modify read and update permissions to or from that type. -a. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission. +a. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission. -a. Click **Save Permissions** to apply your changes. +a. Click **Save Changes** to apply your changes. :::: \ No newline at end of file diff --git a/site/guide/configuration/_manage-user-roles.qmd b/site/guide/configuration/_manage-user-roles.qmd index 68f1a215c9..0909f63c27 100644 --- a/site/guide/configuration/_manage-user-roles.qmd +++ b/site/guide/configuration/_manage-user-roles.qmd @@ -5,23 +5,23 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **User Directory**. +1. Under {{< fa users >}} Users & Access, select **User Directory**. ::: {.panel-tabset} #### Assign new roles to a user -a. Next to any individual user, click the {{< fa circle-plus >}} icon to open the Assign Roles menu for that user. +a. Next to any individual user, click the {{< fa circle-plus >}} icon to assign roles for that user. a. Click **{{< fa plus >}}** next to the role for each role to be assigned. -a. Click **{{< fa puzzle-piece >}} Assign Roles to User** to save changes. +a. Click **Assign Roles to User** to save changes. #### Remove roles from a user a. Click the {{< fa xmark >}} next to the role for the user that you want to remove. -a. After you confirm, that role will be removed from the user. +a. Click **Yes, Remove Role** to confirm removal of the role from the user. ::: @@ -33,20 +33,20 @@ a. After you confirm, that role will be removed from the user. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **User Directory**. +1. Under {{< fa users >}} Users & Access, select **User Directory**. -1. Next to any individual user, click the {{< fa circle-plus >}} icon to open the Assign Roles menu for that user. +1. Next to any individual user, click the {{< fa circle-plus >}} icon to assign roles for that user. #### Assign new roles to a user a. Click **{{< fa plus >}}** next to the role for each role to be assigned. -a. Click **{{< fa puzzle-piece >}} Assign Roles to User** to save changes. +a. Click **Assign Roles to User** to save changes. #### Remove roles from a user a. Click the {{< fa xmark >}} next to the role for the user that you want to remove. -a. After you confirm, that role will be removed from the user. +a. Click **Yes, Remove Role** to confirm removal of the role from the user. :::: \ No newline at end of file diff --git a/site/guide/configuration/_model-stakeholder-types.qmd b/site/guide/configuration/_model-stakeholder-types.qmd index 819331e925..389612fcca 100644 --- a/site/guide/configuration/_model-stakeholder-types.qmd +++ b/site/guide/configuration/_model-stakeholder-types.qmd @@ -5,9 +5,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> Model stakeholders determine specific responsibilities and access levels for model review and approval processes for each model in your model inventory, such as read or edit access to model inventory fields. :::: {.content-visible unless-format="revealjs"} -::: {.callout title="What permissions do model stakeholders have?"} -Each model stakeholder also belongs to user groups which determine which models they can see, and have user roles with attached role permissions which define the level of access they have to overarching {{< var validmind.platform >}} features. +
+ +::: {.callout-button .pl4 .nt4} +::: {.callout collapse="true" appearance="minimal"} +### What permissions do model stakeholders have? +Each model stakeholder also belongs to user groups which determine which models they can see, and have user roles with attached role permissions which define the level of access they have to overarching {{< var validmind.platform >}} features. +::: ::: :::: diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index a63d730d24..aff4c376d3 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -65,7 +65,7 @@ b. Make your edits then click **Save Changes** to apply your adjustments. a. To remove a dashboard, select **{{< fa trash-can >}} Delete**. -b. After you confirm, your dashboard will be deleted. +b. Click **Yes, Delete Dashboard** to confirm permanent deletion of that dashboard. ::: @@ -154,7 +154,7 @@ Removing a widget from a dashboard will not delete the linked view or analytics 5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Remove**]{.red}. -6. After you confirm, your widget will be removed from your dashboard. +6. Click **Yes, Delete Widget** to confirm permanent deletion of the widget from that dashboard. 7. Click **Done Editing** to exit the editor. diff --git a/site/guide/configuration/manage-groups.qmd b/site/guide/configuration/manage-groups.qmd index 7af0644c81..677e0ecacd 100644 --- a/site/guide/configuration/manage-groups.qmd +++ b/site/guide/configuration/manage-groups.qmd @@ -23,13 +23,13 @@ Users must belong to a default group of `All`, and can belong to mulitple groups ::: -## See group details +## View group details -1. In the left sidebar, click **{{< fa gear >}} Settings**. +1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **Groups**. +2. Under {{< fa users >}} Users & Access, select **Groups**. -3. Groups are listed with their names and any provided descriptions. +3. Groups are listed with their names and any provided descriptions. Click on a group to: - View the complete list of members in that group. @@ -45,15 +45,15 @@ Users must belong to a default group of `All`, and can belong to mulitple groups You can only remove non-default groups. ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **Groups**. +2. Under {{< fa users >}} Users & Access, select **Groups**. -3. Click on the group you want to remove to expand that group. +3. Click on the group you want to remove to expand that group and review details before proceeding with deletion. -4. Select **{{< fa trash-can >}} Delete Group** to remove it. +4. Click **{{< fa trash-can >}} Delete Group** to remove that group. -5. After you confirm, the group will be permanently removed. +5. Click **Yes, Delete Group** to confirm permanent deletion of that group. ## Add or remove group members diff --git a/site/guide/configuration/manage-model-stakeholder-types.qmd b/site/guide/configuration/manage-model-stakeholder-types.qmd index 3232f2e7ef..ae59f34665 100644 --- a/site/guide/configuration/manage-model-stakeholder-types.qmd +++ b/site/guide/configuration/manage-model-stakeholder-types.qmd @@ -25,11 +25,11 @@ Please note that the stock **Model Developer**, **Model Owner**, and **Model Val {{< include /guide/configuration/_add-model-stakeholder-types.qmd >}} -#### Configure stakeholder types on registration +### Configure stakeholder types on registration {{< include /guide/configuration/_stakeholder-type-on-registration.qmd >}} -#### Manage stakeholder type permissions +### Manage stakeholder type permissions {{< include /guide/configuration/_manage-stakeholder-type-permissions.qmd >}} @@ -43,7 +43,7 @@ Adding a model stakeholder type on one model in your inventory will not affect t 2. Select a model or find your model by applying a filter or searching for it.[^4] -3. Click **{{< fa user-plus >}} Manage Model Stakeholders**. +3. Click **{{< fa user-plus >}} Manage Stakeholders**. 4. Toggle the stakeholder types you would like to display for that model. diff --git a/site/guide/configuration/manage-permissions.qmd b/site/guide/configuration/manage-permissions.qmd index 9b8ba585fb..d64e1ad1ba 100644 --- a/site/guide/configuration/manage-permissions.qmd +++ b/site/guide/configuration/manage-permissions.qmd @@ -17,21 +17,24 @@ Permissions dictate user access controls within the {{< var validmind.platform > - [x] {{< var link.login >}} - [x] Roles must exist in order to be assigned permissions.[^1] -- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] ::: ## 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 [{{< fa hand >}} Customer Admin]{.bubble} role has the highest level of access and as such its permissions cannot be modified. +Note that the [{{< fa hand >}} Customer Admin]{.bubble} role is a [{{< fa lock >}} Locked]{.bubble} role with the highest level of access and, as such, cannot be modified.[^3] + ::: {{< include _manage-permissions.qmd >}} -### Default permissions + + + [^1]: [Manage roles](manage-roles.qmd) -[^2]: [Default permissions](#default-permissions) \ No newline at end of file +[^2]: [Default permissions](#default-permissions) + +[^3]: [Manage roles](manage-roles.qmd) \ No newline at end of file diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index 131adaaa9f..c11f32ec02 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -112,9 +112,9 @@ Enable or disable email notifications for specific events across your organizati 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Select the **Configuration** tab. +2. Under {{< fa building >}} Organization, select **Email Notifications**. -3. Under Email Notifications, toggle the options for each event on or off according to your requirements. +3. Toggle the options for each event on or off according to your requirements. 4. Click **Save Changes** to apply your adjustments. diff --git a/site/guide/configuration/manage-roles.qmd b/site/guide/configuration/manage-roles.qmd index 296a9a1e4e..f9efc602df 100644 --- a/site/guide/configuration/manage-roles.qmd +++ b/site/guide/configuration/manage-roles.qmd @@ -20,11 +20,13 @@ aliases: ## Add or update roles -::: {.callout-important title="Role permissions and role assignments determine a user's level of access."} +::: {.callout-important} +## Two special default roles provided by {{< var vm.product >}} have unique characteristics. -- The [{{< fa hand >}} Customer Admin]{.bubble} role has the highest level of access and, as such, cannot be modified. +1. **[{{< fa hand >}} Customer Admin]{.bubble}** — The [{{< fa lock >}} Locked]{.bubble} role with the highest level of access and, as such, cannot be modified. + +2. **[{{< fa wrench >}} Basic User]{.bubble}** — The [Basic]{.bubble} role with the lowest level of access, providing only limited access until an administrator grants additional optional permissions or roles to users.[^2] -- The [{{< fa wrench >}} Basic User]{.bubble} role has the lowest level of access, providing only limited access until an administrator grants further permissions. Since every user must hold this role to sign in, it is not typically shown on the platform. ::: {{< include _add-roles.qmd >}} @@ -40,23 +42,23 @@ aliases: 1. Select the **Users** tab, where you can: - View a list of users assigned to that role. - - Add a role to users already on that list. + - Add a role to users already on that list.[^3] ::: {.panel-tabset} #### Add roles to users -a. Click **{{< fa plus >}}** to open the Assign Roles menu for that user. +a. Click **{{< fa circle-plus >}}** to the right of a user's name to assign roles to that user. a. Click **{{< fa plus >}}** next to the role for each role to be assigned. -a. Click **{{< fa puzzle-piece >}} Assign Roles to User** to save changes. +a. Click **Assign Roles to User** to save changes. #### Delete roles from users a. Click **{{< fa x >}}** to delete a role from a user. -a. Once you confirm, that role will be removed from the user. +a. Click **Yes, Remove Role** to confirm removal of that role from the user. ::: @@ -64,19 +66,19 @@ a. Once you confirm, that role will be removed from the user. To rename a role after it has been created: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +1. Click on the role you want to rename. -2. Under User Permissions, select **Roles**. +2. On the role's detail view, click on the title of the role. -3. Select the role you want to rename. +3. Type in the new name of the role. -4. On the role's detail view, click on the title of the role. +4. Click **Save** to apply your changes. -5. Type in the new name of the role. -6. Click **Save** to apply your changes. + +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - +[^2]: Since every user must be a [{{< fa wrench >}} Basic User]{.bubble} to sign in, this role is not available for selection on role assignment menus or shown on the list of roles a user holds, but you can still edit the role's name and permissions. -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file +[^3]: **To add users to roles, refer to:** [Manage users](/guide/configuration/manage-users.qmd#manage-user-roles) \ No newline at end of file diff --git a/site/guide/configuration/manage-users.qmd b/site/guide/configuration/manage-users.qmd index b8b91b1256..738730076d 100644 --- a/site/guide/configuration/manage-users.qmd +++ b/site/guide/configuration/manage-users.qmd @@ -25,7 +25,7 @@ View a list of users in your organization that have access to the {{< var validm 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **User Directory**. +2. Under {{< fa users >}} Users & Access, select **User Directory**. Search the list of Organization Users by typing a keyword into the **{{< fa magnifying-glass >}} Search by name, email, title, or role...** box. @@ -35,7 +35,7 @@ Invite users in your organization to the {{< var validmind.platform >}}: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **Invite New Users**. +2. Under {{< fa users >}} Users & Access, select **Invite New Users**. ::: {.panel-tabset} @@ -51,11 +51,13 @@ Invite users in your organization to the {{< var validmind.platform >}}: ## Manage user roles -Adjust the roles users from your organization have within the {{< var validmind.platform >}}: +Adjust the roles[^2] users from your organization have within the {{< var validmind.platform >}}: {{< include _manage-user-roles.qmd >}} -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file +[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) + +[^2]: [Manage roles](/guide/configuration/manage-roles.qmd) \ No newline at end of file diff --git a/site/guide/configuration/manage-your-profile.qmd b/site/guide/configuration/manage-your-profile.qmd index 9603c3b525..dd5ad3f1f8 100644 --- a/site/guide/configuration/manage-your-profile.qmd +++ b/site/guide/configuration/manage-your-profile.qmd @@ -47,7 +47,7 @@ Access your profile via two methods: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Your Account, select **Profile**. +2. Under {{< fa circle-user >}} Your Account, select **Profile**. ::: @@ -64,6 +64,8 @@ The {{< var vm.platform >}} provides an interactive onboarding journey right in #### Restart onboarding +To restart onboarding after you've fully completed the getting started guide: + 1. Under Onboarding, ensure that [**getting started guide**]{.smallcaps} is toggled on. 2. Click **Restart** to reset your onboarding progress. diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd index 9d3cb9c100..2c23a62024 100644 --- a/site/guide/configuration/managing-your-organization.qmd +++ b/site/guide/configuration/managing-your-organization.qmd @@ -46,9 +46,9 @@ You will see the option to switch between organizations only if you belong to mo 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Organization**. +2. Under {{< fa building >}} Organization, select **Organization**. -3. Under **Organization**, select the organization you'd like to switch to.[^3] +3. Under the **Organization** drop-down, select the organization you'd like to switch to.[^3] ::: @@ -60,7 +60,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Organization**. +2. Under {{< fa building >}} Organization, select **Organization**. 3. Under **Organization Name**, type in your new name and click **Update** to save your changes. @@ -72,7 +72,7 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Organization**. +2. Under {{< fa building >}} Organization, select **Organization**. 3. Under Document Defaults, toggle whether you would like to **Enable Track Changes by default**[^5] for all content blocks within documents for your current active organization. diff --git a/site/guide/configuration/set-up-your-organization.qmd b/site/guide/configuration/set-up-your-organization.qmd index c05f6e60ae..d8a19a6194 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -25,7 +25,7 @@ This task involves managing organizations within {{< var vm.product >}}, allowin 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Organization**. +1. Under {{< fa building >}} Organization, select **Organization**. 1. Add, rename and delete business units as required. @@ -65,9 +65,9 @@ In order to delete a business unit, there must be no models attached to that uni 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. -3. In the Default Fields group, click on the **Use Case** field to add or delete use cases and use case groups as required.[^2] +3. In the Default Fields group, click on the **Use Case** field to add or delete use cases and use case groups as required:[^2] ::: {.panel-tabset} diff --git a/site/guide/integrations/configure-analytics-exports.qmd b/site/guide/integrations/configure-analytics-exports.qmd index c8a3c4dd8b..4ea573c847 100644 --- a/site/guide/integrations/configure-analytics-exports.qmd +++ b/site/guide/integrations/configure-analytics-exports.qmd @@ -23,7 +23,7 @@ Configure scheduled exports of analytics datasets to cloud storage so that BI to 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. On the Analytics Exports page, click **{{< fa plus >}} Create Analytics Export**. @@ -76,7 +76,7 @@ The export is created and runs on the schedule you set. Data is written to the c 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Click the export row you want to view, or hover over it and when the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **{{< fa eye >}} View Details**. @@ -86,7 +86,7 @@ You see the destination, schedule, datasets, and next run for that export. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Hover over the export you want to change. @@ -98,7 +98,7 @@ You see the destination, schedule, datasets, and next run for that export. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Hover over the export you want to run. @@ -110,7 +110,7 @@ A one-off export runs in addition to the scheduled runs. The status for a run is 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Hover over the export you want to inspect. @@ -122,7 +122,7 @@ You see past runs with their status, start time, duration, rows exported, and fi 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Hover over the export you want to pause. @@ -138,13 +138,13 @@ Data you exported previously will remain in the cloud storage destination unchan 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Analytics Exports**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Analytics Exports**. 3. Hover over the export you want to remove. 4. When the **{{< fa ellipsis-vertical >}}** menu appears, click it and select **Delete**. -5. In the confirmation dialog, select **OK** to confirm deletion. +5. In the confirmation dialog, click **Yes, Delete Export** to confirm deletion. ## What's next diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 230216cf1f..dfa716269e 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -144,7 +144,7 @@ Required configuration details: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click **{{< fa plus >}} Add Connection**. @@ -167,7 +167,7 @@ You can now [test the connection](#test-connections) to ensure it is working as 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click the connection you want to view. @@ -175,7 +175,7 @@ You can now [test the connection](#test-connections) to ensure it is working as 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click the connection you want to edit. @@ -192,7 +192,7 @@ You can now [test the connection](#test-connections) to ensure it is working as 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Hover over the connection you want to test. @@ -207,7 +207,7 @@ If the test is successful, the message **{{< fa check-circle >}} Connection succ 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Hover over the connection you want to remove. diff --git a/site/guide/integrations/implement-custom-integrations.qmd b/site/guide/integrations/implement-custom-integrations.qmd index 8c5f295b0e..48a764effd 100644 --- a/site/guide/integrations/implement-custom-integrations.qmd +++ b/site/guide/integrations/implement-custom-integrations.qmd @@ -173,7 +173,7 @@ When linking resources, {{< var vm.product >}} can write metadata back to your s 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click **{{< fa plus >}} Add Connection**. diff --git a/site/guide/integrations/integrations-examples.qmd b/site/guide/integrations/integrations-examples.qmd index 1bc9ebd66f..0622edcd9e 100644 --- a/site/guide/integrations/integrations-examples.qmd +++ b/site/guide/integrations/integrations-examples.qmd @@ -47,13 +47,17 @@ To create a Jira ticket when model validation requires attention: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workflows, select a workflow you can modify or click **{{< fa plus >}} Add Model Workflow**[^5] to start afresh. +2. Under {{< fa shield >}} Governance, select **Workflows**. -3. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^6] onto the canvas, then connect it to your workflow. +3. Select the **Model Workflows** tab. -4. Double-click the step to open the **Configure HTTP Request** modal. +4. Click on a workflow to modify or click **{{< fa plus >}} Add Model Workflow**[^5] to create a new workflow. -5. Configure the required fields, replacing the placeholder values with your own: +5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^6] onto the canvas, then connect it to your workflow. + +6. Double-click the step to open the **Configure HTTP Request** modal. + +7. Configure the required fields, replacing the placeholder values with your own: - **[url]{.smallcaps}** — `https://yourcompany.atlassian.net/rest/api/3/issue` - **[method]{.smallcaps}** — POST @@ -78,7 +82,7 @@ To create a Jira ticket when model validation requires attention: } ``` -6. Click **Update Step** to save your configuration. +8. Click **Update Step** to save your configuration. The HTTP request to create the Jira ticket is sent when the workflow executes the step. @@ -88,13 +92,18 @@ To create a ServiceNow incident when a data drift issue is detected during ongoi 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workflows, select a workflow you can modify or click **{{< fa plus >}} Add Model Workflow**[^7] to start afresh. -3. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^8] onto the canvas, then connect it to your workflow. +2. Under {{< fa shield >}} Governance, select **Workflows**. + +3. Select the **Model Workflows** tab. + +4. Click on a workflow to modify or click **{{< fa plus >}} Add Model Workflow**[^5] to create a new workflow. + +5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^7] onto the canvas, then connect it to your workflow. -4. Double-click the step to open the **Configure HTTP Request** modal. +6. Double-click the step to open the **Configure HTTP Request** modal. -5. Configure the required fields, replacing the placeholder values with your own: +7. Configure the required fields, replacing the placeholder values with your own: - **[url]{.smallcaps}** — `https://yourinstance.service-now.com/api/now/table/incident` - **[method]{.smallcaps}** — POST @@ -127,9 +136,9 @@ To start a {{< var vm.product >}} workflow from an external system: #### a. Configure workflow in {{< var vm.product >}} -1. Add a new workflow, selecting the **Via Webhook** workflow start option.[^9] +1. Add a new workflow, selecting the **Via Webhook** workflow start option.[^8] -2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^10] onto the canvas, then connect it to your workflow. +2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^9] onto the canvas, then connect it to your workflow. 3. Double-click the step to open the **Webhook Step Trigger** modal. @@ -152,7 +161,7 @@ To start a {{< var vm.product >}} workflow from an external system: - `x-api-secret`: `{{API Secret}}` - **[wait for webhook trigger when reached]{.smallcaps}** — When enabled, the workflow pauses execution when it reaches this step and waits for the external system to send the POST request. -5. Click **Save Workflow**. +5. Click **Save**. #### b. Start workflow from external system @@ -175,9 +184,9 @@ To trigger a waiting {{< var vm.product >}} workflow step to continue from an ex #### a. Configure workflow in {{< var vm.product >}} -1. Open the workflow you want to configure, or add a new workflow.[^11] +1. Open the workflow you want to configure, or add a new workflow.[^10] -2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^12] onto the canvas, then connect the step to your workflow. +2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^11] onto the canvas, then connect the step to your workflow. 3. Double-click the step to open the **Webhook Step Trigger** modal. @@ -235,7 +244,7 @@ To synchronize models registered in the {{< var vm.product >}} model inventory w 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click **{{< fa plus >}} Add Connection**. @@ -264,7 +273,7 @@ To synchronize models registered in the {{< var vm.product >}} model inventory w 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^13] +2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^12] 3. Scroll down until you locate the **Amazon Sagemaker** connection box in the right sidebar. @@ -294,7 +303,7 @@ AWS Bedrock exposes two primary integration surfaces: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click **{{< fa plus >}} Add Connection**. @@ -334,7 +343,7 @@ This builds a complete dependency graph showing how your AI applications relate 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^14] +2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^13] 3. Scroll down until you locate the **Amazon Bedrock** connection box in the right sidebar. @@ -370,7 +379,7 @@ Synchronize GitLab model registry with ValidMind model inventory for comprehensi 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Connections**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. 3. Click **{{< fa plus >}} Add Connection**. @@ -398,7 +407,7 @@ Synchronize GitLab model registry with ValidMind model inventory for comprehensi 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^15] +2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^14] 3. Scroll down until you locate the **GitLab** connection box in the right sidebar. @@ -428,20 +437,18 @@ Synchronize GitLab model registry with ValidMind model inventory for comprehensi [^6]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request) -[^7]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) +[^7]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request) -[^8]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request) +[^8]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) -[^9]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) +[^9]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) -[^10]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) +[^10]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) -[^11]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) +[^11]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) -[^12]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) +[^12]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) [^13]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) -[^14]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) - -[^15]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) \ No newline at end of file +[^14]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models) \ No newline at end of file diff --git a/site/guide/integrations/link-external-models.qmd b/site/guide/integrations/link-external-models.qmd index 70318c1d94..2597b9bfb7 100644 --- a/site/guide/integrations/link-external-models.qmd +++ b/site/guide/integrations/link-external-models.qmd @@ -95,7 +95,7 @@ After linking, the message **Pending initial sync** displays. This means that th 5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa unlink >}} Remove Link**. -6. In the confirmation modal that opens, click **Yes, unlink it**. +6. Click **Yes, Unlink Integration** to confirm removal of the link. The model is unlinked from the external system. diff --git a/site/guide/integrations/manage-secrets.qmd b/site/guide/integrations/manage-secrets.qmd index c047ef2ed7..744e00d53d 100644 --- a/site/guide/integrations/manage-secrets.qmd +++ b/site/guide/integrations/manage-secrets.qmd @@ -24,7 +24,7 @@ You store each secret once and then reuse it across supported integrations. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Integration Secrets**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**. 3. Click **{{< fa plus >}} Add Secret**. @@ -49,7 +49,7 @@ Recommended: Create a new secret and update integrations that should use it.
1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Integration Secrets**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**. 3. Click the secret you want to view. @@ -57,7 +57,7 @@ Recommended: Create a new secret and update integrations that should use it.
1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Integration Secrets**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**. 3. Click the secret you want to change. @@ -74,7 +74,7 @@ Recommended: Create a new secret and update integrations that should use it.
1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Integration Secrets**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**. 3. Hover over the secret you want to change. @@ -92,7 +92,7 @@ Be sure to update any connections that depend on this secret before deleting it. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Integrations, select **Integration Secrets**. +2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**. 3. Hover over the secret you want to remove. diff --git a/site/guide/model-documentation/collaborate-with-others.qmd b/site/guide/model-documentation/collaborate-with-others.qmd index 251ab76cc3..356bfa08fa 100644 --- a/site/guide/model-documentation/collaborate-with-others.qmd +++ b/site/guide/model-documentation/collaborate-with-others.qmd @@ -140,16 +140,11 @@ To edit a comment in a resolved thread, follow the same steps but click the **{{ 1. Click the highlighted text portion to access the comment thread. 2. Click the **{{< fa ellipsis-vertical >}}** icon for the corresponding comment and select **{{< fa trash-can >}} Remove**. - -3. After you confirm, the comment will be deleted. -To delete a comment in a resolved thread, follow the same steps but click the **{{< fa comments >}} Comments archive** button first to access the resolved thread. +3. Click [**{{< fa check >}}**]{.green} to confirm permanent deletion of that comment. - diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/model-documentation/work-with-content-blocks.qmd index e138a779a8..66f4d51f8c 100644 --- a/site/guide/model-documentation/work-with-content-blocks.qmd +++ b/site/guide/model-documentation/work-with-content-blocks.qmd @@ -161,7 +161,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block 7. Select **{{< fa trash >}} Delete** to remove the block. -8. After you confirm, the content block will be deleted. +8. Click **Yes, Remove Block** to confirm permanent deletion of that block. diff --git a/site/guide/model-inventory/_add-edit-inventory-fields.qmd b/site/guide/model-inventory/_add-edit-inventory-fields.qmd index 2317339d86..d6ccc83844 100644 --- a/site/guide/model-inventory/_add-edit-inventory-fields.qmd +++ b/site/guide/model-inventory/_add-edit-inventory-fields.qmd @@ -18,7 +18,7 @@ a. Include optional information for your field: - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - Check off whether or not the field should be **[required on new model registration]{.smallcaps}**. - - Assign a field to a group.^[Ungrouped fields will be listed under No Group: [Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] + - Assign a field to a **[group]{.smallcaps}**.^[Ungrouped fields will be listed under No Group: [Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access.[^edit-fields] a. When you are satisfied with the setup of your inventory field, click **Save**. @@ -27,35 +27,33 @@ a. When you are satisfied with the setup of your inventory field, click **Save** ### Edit inventory fields -#### Edit custom inventory fields - -Custom inventory fields are fields created by your organization. +#### Edit Default Fields -To edit an existing custom inventory field: +Default Fields are fields created by default by {{< var vm.product >}}.[^default-fields] To modify a default field: -a. Click on the custom inventory field you would like to edit. +a. Under the Default Fields grouping, click on the inventory field you would like to edit. Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] -a. Make your desired changes to your inventory field, then click **Save**. +a. Toggle the following options on or off: - Field keys for custom inventory field can be renamed under the **[actions]{.smallcaps}** column.^[[Rename custom field keys](/guide/model-inventory/manage-model-inventory-fields.qmd#rename-custom-field-keys)] + - **[disable field]{.smallcaps}** — Hide this field from all models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] + - **[show on registration]{.smallcaps}** — Show this field when registering models in your inventory.^[[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)] + - **[require on registration]{.smallcaps}** — Require input in this field when registering models in your inventory. -#### Edit core fields +a. Click **Save Configuration** to apply your changes. -Core fields are fields created by default by {{< var vm.product >}}.[^core-fields] To modify a core field: +#### Edit custom inventory fields -a. Click on the core inventory field you would like to edit. +Custom inventory fields are fields created by your organization. Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] - Expand any inventory field group to see more fields.^[[Add inventory field groups](/guide/model-inventory/manage-model-inventory-fields.qmd#add-inventory-field-groups)] +To edit an existing custom inventory field: -a. Toggle the following options on or off: +a. Click on the custom inventory field you would like to edit. - - **[disable field]{.smallcaps}** — Hide this field from all models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)] - - **[show on registration]{.smallcaps}** — Show this field when registering models in your inventory.^[[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)] - - **[require on registration]{.smallcaps}** — Require input in this field when registering models in your inventory. +a. Make your desired changes to your inventory field, then click **Save**. -a. Click **Save Configuration** to apply your changes. + Field keys for custom inventory field can be renamed under the **[actions]{.smallcaps}** column.^[[Rename custom field keys](/guide/model-inventory/manage-model-inventory-fields.qmd#rename-custom-field-keys)] @@ -74,9 +72,9 @@ a. Click **Save Configuration** to apply your changes. ::: -[^core-fields]: +[^default-fields]: - **{{< var vm.product >}} core fields:** + **{{< var vm.product >}} default fields:** - [Business Unit](/guide/configuration/set-up-your-organization.qmd#manage-business-units) - ID @@ -92,7 +90,7 @@ a. Click **Save Configuration** to apply your changes. :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Models, select **Model Inventory Fields**. Here you can edit existing inventory fields, or add a new custom one: +1. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. Here you can edit existing inventory fields, or add a new custom one: - Click **{{< fa plus >}} Add Field** to add a new field. - Click on an existing field to edit that field. @@ -105,10 +103,10 @@ a. Click **Save Configuration** to apply your changes. - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - Check off whether or not the field should be **[required on new model registration]{.smallcaps}**. - - Assign a field to a group. Ungrouped fields will be listed under No Group. + - Assign a field to a **[group]{.smallcaps}**. Ungrouped fields will be listed under No Group. - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access. -1. When you are satisfied with the setup of your inventory field, click **Save** for custom fields and **Save Configuration** for {{< var vm.product >}} default core fields. +1. When you are satisfied with the setup of your inventory field, click **Save** for custom fields and **Save Configuration** for {{< var vm.product >}} default fields. :::: diff --git a/site/guide/model-inventory/_remove-attachments.qmd b/site/guide/model-inventory/_remove-attachments.qmd index 4391f9af26..d3c5f4043e 100644 --- a/site/guide/model-inventory/_remove-attachments.qmd +++ b/site/guide/model-inventory/_remove-attachments.qmd @@ -4,10 +4,10 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Locate the file you want to remove, and click on the **{{< fa ellipsis-vertical >}}** menu. - - Select **{{< fa trash-can>}} Delete File** to remove the file. After you confirm, the attachment will be removed from the list. - - Select **Remove Notes** to delete any notes. + - Select **{{< fa trash-can>}} Delete File** to remove the file. Click **Yes, Delete File** to confirm permanent deletion of that file. + - Select **Remove Notes** to delete any notes. Removal of notes is saved automatically. -1. Click **Save** to apply the deletion. +1. Click **Save** to apply the deletion. After you save, the attachment or notes will be removed permanently. diff --git a/site/guide/model-inventory/_remove-layout-view.qmd b/site/guide/model-inventory/_remove-layout-view.qmd index 750a9bba78..e30d0574d1 100644 --- a/site/guide/model-inventory/_remove-layout-view.qmd +++ b/site/guide/model-inventory/_remove-layout-view.qmd @@ -9,6 +9,4 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. When the **{{< fa ellipsis-vertical >}}** appears, click on it to edit the name or description or to delete the view: - To edit a view, select **{{< fa pencil >}} Edit View**. Make your edits then click **Save Changes** to apply your adjustments. - - To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. - -1. After you confirm, the view will be deleted. \ No newline at end of file + - To remove a view, select [**{{< fa trash-can >}} Remove View**]{.red}. Click **Yes, Delete View** to confirm permanent deletion of that view. \ No newline at end of file diff --git a/site/guide/model-inventory/archive-delete-models.qmd b/site/guide/model-inventory/archive-delete-models.qmd index 3d1b915b18..6fdf5f82f6 100644 --- a/site/guide/model-inventory/archive-delete-models.qmd +++ b/site/guide/model-inventory/archive-delete-models.qmd @@ -58,18 +58,16 @@ a. Select **Archived** from the [model stage]{.smallcaps} drop-down menu. b. Click **Save** to proceed with archival. -c. After you confirm, the model is flagged as archived in the model inventory. +c. Click **Yes, Archive Model** to confirm archival of that model. Archived models can be reactivated to make them available for use again in the inventory. #### Activate models -a. Select **Active** from the [model stage]{.smallcaps} drop-down menu. +a. Select any stage other than Archived from the [model stage]{.smallcaps} drop-down menu. b. Click **Save** to proceed with activation. -d. After you confirm, the model is set to active in the model inventory. - ::: ## Delete models @@ -86,7 +84,7 @@ If a model was created in error, or you otherwise no longer require a model to b 3. Under the [model stage]{.smallcaps} section, select **Deleted**. -4. After you confirm deletion, the model is removed from the model inventory. +4. Click **Yes, Delete Model** to confirm permanent deletion of that model. diff --git a/site/guide/model-inventory/manage-model-inventory-fields.qmd b/site/guide/model-inventory/manage-model-inventory-fields.qmd index 1119c23448..6438d9875f 100644 --- a/site/guide/model-inventory/manage-model-inventory-fields.qmd +++ b/site/guide/model-inventory/manage-model-inventory-fields.qmd @@ -30,13 +30,13 @@ includes: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. Displayed in groups[^2] as lists are the inventory fields available to models in your organization with a quick view of:[^3] - Number of workflows that field is used in[^4] - The field key - - The field type[^5] + - The field type[^6] - Field description - Whether or not the field is required when creating models - Quick actions you can take on the inventory field @@ -61,8 +61,9 @@ a. Click **{{< fa filter >}} Filter** to filter fields by any of the following c - **[required on creation]{.smallcaps}** — Whether or not the field was set up as required on model registration. - **[types]{.smallcaps}** — What type of field it is. - - **[workflow triggered by field]{.smallcaps}** — What workflows are initiated when this field is edited.[^6] - - **[write permissions]{.smallcaps}** — Which model stakeholder types have permissions to edit this field.[^7] + - **[used in workflows]{.smallcaps}** — What workflows are using this field.[^5] + - **[workflow triggered by field]{.smallcaps}** — What workflows are initiated when this field is edited.[^7] + - **[write permissions]{.smallcaps}** — Which model stakeholder types have permissions to edit this field.[^8] b. Click **Apply Filters** to narrow down your results by your configured criteria. @@ -79,7 +80,7 @@ For example, if you first search by keyword for `date` under **Title** without c 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. Here you can edit existing inventory fields, or add a new one: @@ -97,25 +98,29 @@ To group model inventory fields, first create an inventory field group: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. -3. Click **{{< fa plus >}} Add Group** and enter in a **[name]{.smallcaps}** and a **[description]{.smallcaps}** for the group. +3. Click **{{< fa folder-plus >}} Add Group** and enter in a **[name]{.smallcaps}** and a optional **[description]{.smallcaps}** for the group. 4. Click **Create Group** to add the new group. -5. Assign the desired fields to the group.[^8] +5. Assign the desired fields to the group.[^9] ## Delete inventory fields +::: {.callout-important title="Inventory field deletion is permanent."} +Deleting an inventory field will remove it from all models using that field, even if the field has been populated on a model. +::: + 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Model Inventory, select **Model Inventory Fields**. 3. Hover over the field you would like to delete. 4. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. -5. After you confirm, the field will be removed. +5. Click **Yes, Delete Field** to confirm permanent deletion. @@ -136,10 +141,12 @@ To group model inventory fields, first create an inventory field group: [Working with workflows](/guide/workflows/working-with-workflows.qmd) -[^5]: [Inventory field types](#inventory-field-types) +[^5]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) + +[^6]: [Inventory field types](#inventory-field-types) -[^6]: [Configure workflows](/guide/workflows/configure-workflows.qmd) +[^7]: [Configure workflows](/guide/workflows/configure-workflows.qmd) -[^7]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) +[^8]: [Manage model stakeholder types](/guide/configuration/manage-model-stakeholder-types.qmd) -[^8]: [Add or edit inventory fields](#add-or-edit-inventory-fields) \ No newline at end of file +[^9]: [Add or edit inventory fields](#add-or-edit-inventory-fields) \ No newline at end of file diff --git a/site/guide/model-validation/_add-artifact-severities.qmd b/site/guide/model-validation/_add-artifact-severities.qmd index 2b3054cdfa..b844dbece9 100644 --- a/site/guide/model-validation/_add-artifact-severities.qmd +++ b/site/guide/model-validation/_add-artifact-severities.qmd @@ -9,7 +9,7 @@ To add additional severities: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Artifacts, select **Artifact Severities**. +1. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. 1. Click **{{< fa plus >}} Add Artifact Severity**. @@ -29,7 +29,7 @@ To add additional severities: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Artifacts, select **Artifact Severities**. +1. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. 1. Click **{{< fa plus >}} Add Artifact Severity**. diff --git a/site/guide/model-validation/_add-edit-artifact-fields.qmd b/site/guide/model-validation/_add-edit-artifact-fields.qmd index 565807d742..ea7d666efd 100644 --- a/site/guide/model-validation/_add-edit-artifact-fields.qmd +++ b/site/guide/model-validation/_add-edit-artifact-fields.qmd @@ -18,19 +18,19 @@ a. Include optional information for your artifact field: - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - Check off whether or not the field should be **[required on artifact creation]{.smallcaps}**. - - Assign a field to a group.^[Ungrouped fields will be listed under No Group: [Add artifact field groups](/guide/model-validation/manage-artifact-fields.qmd#add-artifact-field-groups)] + - Assign a field to a **[group{.smallcaps}]**.^[Ungrouped fields will be listed under No Group: [Add artifact field groups](/guide/model-validation/manage-artifact-fields.qmd#add-artifact-field-groups)] - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access.[^edit-artifact-fields] a. When you are satisfied with the setup of your artifact field, click **Save**. #### Edit artifact fields +Expand any inventory field group to see more fields.^[[Add artifact field groups](/guide/model-validation/manage-artifact-fields.qmd#add-artifact-field-groups)] + To edit an existing artifact field: a. Click on the artifact field you would like to edit. - Expand any inventory field group to see more fields.^[[Add artifact field groups](/guide/model-validation/manage-artifact-fields.qmd#add-artifact-field-groups)] - a. Make your desired changes to your artifact field, then click **Save**. Field keys for artifact fields can be renamed under the **[actions]{.smallcaps}** column.^[[Rename artifact field keys](/guide/model-validation/manage-artifact-fields.qmd#rename-artifact-field-keys)] @@ -55,7 +55,7 @@ a. Make your desired changes to your artifact field, then click **Save**. :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Artifacts, select **Artifact Fields**. Here you can edit existing artifact fields, or add a new one: +1. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. Here you can edit existing artifact fields, or add a new one: - Click **{{< fa plus >}} Add Field** to add a new field. - Click on an existing field to edit that field. @@ -68,7 +68,7 @@ a. Make your desired changes to your artifact field, then click **Save**. - Enter a **[description]{.smallcaps}** to indicate the purpose of the field displayed on the list of fields. - Enter **[help text]{.smallcaps}** to provide guidance to users on how best to fill out that field. - Check off whether or not the field should be **[required on artifact creation]{.smallcaps}**. - - Assign a field to a group. Ungrouped fields will be listed under No Group. + - Assign a field to a **[group]{.smallcaps}**. Ungrouped fields will be listed under No Group. - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by model stakeholder types or user roles. Leave this field blank for default permissions where only the [{{< fa hand >}} Customer Admin]{.bubble} role has write access. 1. When you are satisfied with the setup of your artifact field, click **Save**. diff --git a/site/guide/model-validation/_add-edit-artifact-statuses.qmd b/site/guide/model-validation/_add-edit-artifact-statuses.qmd index 8d445e1269..79fb4e0dd4 100644 --- a/site/guide/model-validation/_add-edit-artifact-statuses.qmd +++ b/site/guide/model-validation/_add-edit-artifact-statuses.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Click **{{< fa plus >}} Add Status**. -b. Enter in a **[name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +b. Enter in a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. c. When you are done, click **Add Status** to create your new status. @@ -18,8 +18,8 @@ a. Hover over the artifact status you'd like to modify. b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select: - - **{{< fa pencil >}} Edit Details** to change the **[name]{.smallcaps}** or **[color]{.smallcaps}** of the status, then click **Update Status** to apply your changes. - - [**{{< fa trash-can >}} Delete Status**]{.red} to remove the status. After you confirm, the status will be deleted. + - **{{< fa pencil >}} Edit Details** to change the **[status name]{.smallcaps}** or **[color]{.smallcaps}** of the status, then click **Update Status** to apply your changes. + - [**{{< fa trash-can >}} Delete Status**]{.red} to remove the status. Click **OK** to confirm permanent deletion of that status. ::: {.callout-important title="Artifact status deletion is permanent and cannot be undone."} @@ -36,7 +36,7 @@ Artifact statuses cannot be deleted if in use on an artifact. Ensure that the st a. Click **{{< fa plus >}} Add Status**. -b. Enter in a **[name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +b. Enter in a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. c. When you are done, click **Add Status** to create your new status. @@ -48,7 +48,7 @@ c. When you are done, click **Add Status** to create your new status. a. Hover over the artifact status you'd like to modify. -b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Details** to change the **[name]{.smallcaps}** or **[color]{.smallcaps}** of the status. +b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa pencil >}} Edit Details** to change the **[status name]{.smallcaps}** or **[color]{.smallcaps}** of the status. c. Click **Update Status** to apply your changes. diff --git a/site/guide/model-validation/_add-edit-artifact-types.qmd b/site/guide/model-validation/_add-edit-artifact-types.qmd index a0cb3cb627..dd003097f9 100644 --- a/site/guide/model-validation/_add-edit-artifact-types.qmd +++ b/site/guide/model-validation/_add-edit-artifact-types.qmd @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Types**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Types**. 3. Click **{{< fa plus >}} Add Artifact Type**. @@ -19,20 +19,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 7. Enter in the artifact type's details: - - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact.[^add-fields-callout] - - **[model fields display]{.smallcaps}**[^add-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type. + - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^add-fields-callout] + - **[model fields display]{.smallcaps}**[^add-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. - **[artifact statuses]{.smallcaps}** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] 8. Select the artifact type's permissions: - - **[create permissions]{.smallcaps}** — Model stakeholder types or user roles[^add-permissions] that can create this type of artifact. - - **[update permissions]{.smallcaps}** — Model stakeholder types or user roles that can update existing artifacts of this type. + - **[create artifact]{.smallcaps}** — Model stakeholder types or user roles[^add-permissions] that can create this type of artifact. + - **[update artifact]{.smallcaps}** — Model stakeholder types or user roles that can update existing artifacts of this type. ## Edit artifact types 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Types**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Types**. 3. Click the existing artifact type you want to edit. @@ -40,14 +40,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - **[name]{.smallcaps}** - **[description]{.smallcaps}** - - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact.[^edit-fields-callout] - - **[model fields display]{.smallcaps}**[^edit-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type. + - **[fields]{.smallcaps}** — Select the default artifact fields that should appear on this type of artifact and click **Save Fields** to apply your changes.[^edit-fields-callout] + - **[model fields display]{.smallcaps}**[^edit-model-fields-config] — Select which upstream model inventory fields^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)] to display as read-only under the Model Information section on artifacts of this type and click **Save Model Fields Configuration** to apply your changes. - **[artifact statuses]{.smallcaps}** — Configure the statuses available to this artifact type.^[[Manage artifact type statuses](#manage-artifact-type-statuses)] 5. Make your desired changes to the artifact type's permissions: - - **[create permissions]{.smallcaps}** — Model stakeholder types or user roles[^edit-permissions] that can create this type of artifact. - - **[update permissions]{.smallcaps}** — Model stakeholder types or user roles that can update existing artifacts of this type. + - **[create artifact]{.smallcaps}** — Model stakeholder types or user roles[^edit-permissions] that can create this type of artifact. + - **[update artifact]{.smallcaps}** — Model stakeholder types or user roles that can update existing artifacts of this type. :::: @@ -101,7 +101,10 @@ c. Click **Create** to create your new artifact type. d. Click on your newly created artifact type to edit its details and permissions. - Most changes are saved automatically. For **[model fields display]{.smallcaps}** configuration, click **Save Model Fields Configuration** to apply changes. + Most changes are saved automatically. + + - For **[fields]{.smallcaps}** configuration, click **Save Fields** to apply changes. + - For **[model fields display]{.smallcaps}** configuration, click **Save Model Fields Configuration** to apply changes. #### Edit artifact types @@ -109,7 +112,10 @@ a. Click the existing artifact type you want to edit. b. Make your desired changes to the artifact type's details and permissions. - Most changes are saved automatically. For **[model fields display]{.smallcaps}** configuration, click **Save Model Fields Configuration** to apply changes. + Most changes are saved automatically. + + - For **[fields]{.smallcaps}** configuration, click **Save Fields** to apply changes. + - For **[model fields display]{.smallcaps}** configuration, click **Save Model Fields Configuration** to apply changes. :::: diff --git a/site/guide/model-validation/_reorder-artifact-severities.qmd b/site/guide/model-validation/_reorder-artifact-severities.qmd index 0eb6673d13..b3d4938b91 100644 --- a/site/guide/model-validation/_reorder-artifact-severities.qmd +++ b/site/guide/model-validation/_reorder-artifact-severities.qmd @@ -8,7 +8,7 @@ To reorder severities: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Artifacts, select **Artifact Severities**. +1. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. 1. Click and hold to drag a severity up or down. diff --git a/site/guide/model-validation/add-manage-artifacts.qmd b/site/guide/model-validation/add-manage-artifacts.qmd index 859a3beb46..0f21add45e 100644 --- a/site/guide/model-validation/add-manage-artifacts.qmd +++ b/site/guide/model-validation/add-manage-artifacts.qmd @@ -109,7 +109,7 @@ If you logged an artifact in error or otherwise no longer need to track that art 2. On the artifact's detail page, click **{{< fa trash-can>}} Delete {Artifact Type}**[^14] in the right sidebar. -3. After you confirm, the artifact will be permanently deleted. +3. Click **Yes, Delete {Artifact Type}** to confirm permanent deletion of that artifact. diff --git a/site/guide/model-validation/configure-assessment-options.qmd b/site/guide/model-validation/configure-assessment-options.qmd index 728192fd2f..6684b4a7f5 100644 --- a/site/guide/model-validation/configure-assessment-options.qmd +++ b/site/guide/model-validation/configure-assessment-options.qmd @@ -26,7 +26,7 @@ To configure assessment options on individual validation report templates: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Templates**.[^2] +2. Under {{< fa file >}} Documents, select **Templates**.[^2] 3. Select the **Validation** tab. diff --git a/site/guide/model-validation/manage-artifact-fields.qmd b/site/guide/model-validation/manage-artifact-fields.qmd index 1f2d6d15d4..f259950b2f 100644 --- a/site/guide/model-validation/manage-artifact-fields.qmd +++ b/site/guide/model-validation/manage-artifact-fields.qmd @@ -29,7 +29,7 @@ includes: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Fields**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. Displayed in groups[^2] as lists are the artifacts fields available to artifacts in your organization with a quick view of:[^3] @@ -78,7 +78,7 @@ For example, if you first search by keyword for `Regression` under **Title** wit 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Fields**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. Here you can edit existing artifact fields, or add a new one: @@ -96,7 +96,7 @@ To group artifact fields, first create an artifact field group: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Fields**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. 3. Click **{{< fa plus >}} Add Group** and enter in a **[name]{.smallcaps}** and a **[description]{.smallcaps}** for the group. @@ -106,15 +106,19 @@ To group artifact fields, first create an artifact field group: ## Delete artifact fields +::: {.callout-important title="Artifact field deletion is permanent."} +Deleting an artifact field will remove it from all artifacts using that field, even if the field has been populated on an artifact. +::: + 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Fields**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Fields**. 3. Hover over the field you would like to delete. 4. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete Field**]{.red}. -5. After you confirm, the field will be removed. +5. Click **Yes, Delete Field** to confirm permanent deletion. diff --git a/site/guide/model-validation/manage-artifact-severities.qmd b/site/guide/model-validation/manage-artifact-severities.qmd index 2b6fa751e2..af178a353c 100644 --- a/site/guide/model-validation/manage-artifact-severities.qmd +++ b/site/guide/model-validation/manage-artifact-severities.qmd @@ -27,7 +27,7 @@ aliases: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Severities**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. 3. Hover over the severity you would like to edit. @@ -51,13 +51,13 @@ Severities can only be deleted if they are not in use by any artifacts. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Severities**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Severities**. 3. Hover over the severity you would like to delete. 4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete Severity**]{.red}. -5. After you confirm, the severity will be removed from the list. +5. Click **Delete Artifact Severity** to confirm permanent deletion. diff --git a/site/guide/model-validation/manage-artifact-types.qmd b/site/guide/model-validation/manage-artifact-types.qmd index 8f3669d081..a5ac2e9fe9 100644 --- a/site/guide/model-validation/manage-artifact-types.qmd +++ b/site/guide/model-validation/manage-artifact-types.qmd @@ -66,7 +66,7 @@ Custom artifact types support the same features as default types, including stat 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Types**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Types**. 3. Click the existing artifact type you want to edit,[^2] or create a new artifact type[^3] to add, edit, or delete artifact statuses. @@ -82,13 +82,15 @@ Custom artifact types support the same features as default types, including stat 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Types**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Types**. 3. Hover over the artifact type you want to archive or delete. 5. When the **{{< fa ellipsis-vertical >}}** appears, click [**{{< fa box-archive >}} Archive Artifact Type**]{.red} under the Actions column. -6. After you confirm, the artifact type will be archived. Once archived, custom artifact types can be deleted permanently or restored for use: +6. Click **Yes, Archive Artifact Type** to confirm archival. + + Once archived, custom artifact types can be deleted permanently or restored for use: ::: {.panel-tabset} @@ -101,13 +103,13 @@ Only artifact types with no active artifact records can be deleted. a. Hover over the artifact type you want to delete. b. When the **{{< fa ellipsis-vertical >}}** appears, click [**{{< fa trash-can >}} Delete**]{.red} under the Actions column. -c. After you confirm, the artifact type will be deleted permanently. +c. Click **Yes, Delete Artifact Type** to confirm permanent deletion. #### Restore artifact types a. Hover over the artifact type you want to restore. b. When the **{{< fa ellipsis-vertical >}}** appears, click **{{< fa undo >}} Restore** under the Actions column. -c. After you confirm, the artifact type will be restored. +c. Click **Yes, Restore Artifact Type** to confirm restoration. ::: diff --git a/site/guide/model-validation/manage-validation-guidelines.qmd b/site/guide/model-validation/manage-validation-guidelines.qmd index d33bc0a22e..e287064d37 100644 --- a/site/guide/model-validation/manage-validation-guidelines.qmd +++ b/site/guide/model-validation/manage-validation-guidelines.qmd @@ -29,7 +29,7 @@ To set up validation guidelines, you'll need to complete these two steps in sequ 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Risk Areas & Validation Guidelines**. +2. Under {{< fa shield >}} Governance, select **Risk Areas & Validation Guidelines**. 3. Add, edit, or delete risk areas and their associated guidelines as required. @@ -42,7 +42,7 @@ To set up validation guidelines, you'll need to complete these two steps in sequ 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Risk Areas & Validation Guidelines**. +2. Under {{< fa shield >}} Governance, select **Risk Areas & Validation Guidelines**. ::: {.panel-tabset} @@ -70,7 +70,7 @@ a. Hover over the risk area you want to remove. b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can>}} Delete Risk Area**]{.red}. -c. After you confirm, that risk area will be removed. +c. Click **Yes, Delete Risk Area** to confirm permanent deletion of that risk area. ::: @@ -80,7 +80,7 @@ c. After you confirm, that risk area will be removed. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Risk Areas & Validation Guidelines**. +2. Under {{< fa shield >}} Governance, select **Risk Areas & Validation Guidelines**. ::: {.panel-tabset} @@ -112,7 +112,7 @@ b. Hover over the guideline you want to delete. c. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select [**{{< fa trash-can>}} Delete Guideline**]{.red}. -d. After you confirm, that guideline will be removed. +d. Click **Yes, Delete Guideline** to confirm permanent deletion of that guideline. ::: @@ -122,9 +122,9 @@ d. After you confirm, that guideline will be removed. By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has all these permissions.[^4] ::: -1. In the left sidebar, click **{{< fa gear >}} Settings**. +1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Templates**.[^5] +2. Under {{< fa file >}} Documents, select **Templates**.[^5] 3. Select the **Validation** tab, then click on the template you want to edit. diff --git a/site/guide/reporting/_create-a-visualization.qmd b/site/guide/reporting/_create-a-visualization.qmd index f6a9c46724..4d26628c49 100644 --- a/site/guide/reporting/_create-a-visualization.qmd +++ b/site/guide/reporting/_create-a-visualization.qmd @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> If your analytics page is newly created, skip to **Step c.** ::: -a. On **{{< fa square-poll-vertical >}} Analytics**, click on the tab for your custom page you'd like to add a visualization to. +a. On **{{< fa square-poll-vertical >}} Analytics**, click on the tab for your custom page you'd like to add a visualization (widget) to. a. Click **{{< fa pencil >}} Edit Dashboard**. diff --git a/site/guide/reporting/manage-custom-reports.qmd b/site/guide/reporting/manage-custom-reports.qmd index 1cd95979a7..6ab7aa843e 100644 --- a/site/guide/reporting/manage-custom-reports.qmd +++ b/site/guide/reporting/manage-custom-reports.qmd @@ -114,16 +114,16 @@ You can either delete a entire custom analytics page, or remove a single custom a. Select **{{< fa trash-can >}} Delete**. -b. After you confirm, the page will be permanently removed. +b. Click **Yes, Delete Page** to confirm permanent deletion of that page. #### Delete visualizations -a. Hover over the visualization you'd like to remove. +a. Hover over the visualization (widget) you'd like to remove. b. When the **{{< fa ellipsis-vertical >}}** icon appears, click on it and select **{{< fa trash-can >}} Remove**. -c. After you confirm, the visualization will be permanently removed from that dashboard. +c. Click **Yes, Delete Visualization** to confirm permanent deletion of that visualization from all pages and dashboards. ::: diff --git a/site/guide/templates/_add-text-blocks.qmd b/site/guide/templates/_add-text-blocks.qmd index f063e29499..7f73778c79 100644 --- a/site/guide/templates/_add-text-blocks.qmd +++ b/site/guide/templates/_add-text-blocks.qmd @@ -10,7 +10,7 @@ To create a new text block via the block library: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Block Library**. +2. Under {{< fa file >}} Documents, select **Block Library**. 3. Click **Add Block** and enter: @@ -52,7 +52,7 @@ To create a new text block via the block library: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Block Library**. +1. Under {{< fa file >}} Documents, select **Block Library**. 1. Click **Add Block** and enter: diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index e18b543881..ce50f24704 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -20,7 +20,7 @@ Editing outlines for document templates from **{{< fa gear >}} Settings** will c 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for the type of template you want to edit: @@ -94,7 +94,7 @@ Customize {{< var vm.product >}}'s templates for model documents to fit your spe 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for the [type of template you want to edit](/guide/templates/manage-document-types.qmd){target="blank"}. @@ -108,7 +108,7 @@ Customize {{< var vm.product >}}'s templates for model documents to fit your spe a. **Expand sections** — Expand the menu for any sections with subsections by clicking **{{< fa chevron-down >}}**. a. **Rename sections** — Hover over a section until the **{{< fa pencil >}}** appears, then click on it to change the name. Save by clicking **{{< fa check >}}**. - a. **Remove sections** — Hover over the section you want to delete. When the **{{< fa trash-can >}}** appears, click on it. After you confirm, that section will be removed. + a. **Remove sections** — Hover over the section you want to delete. When the **{{< fa trash-can >}}** appears, click on it. Click **Yes, Delete Section** to confirm deletion of that section. a. **Reorder sections** — Click **{{< fa ellipsis-vertical >}}{{< fa ellipsis-vertical >}}** and hold firmly to drag to reorder sections. #### Add new sections and content diff --git a/site/guide/templates/_duplicate-template.qmd b/site/guide/templates/_duplicate-template.qmd index 5d27e52679..11d3e33995 100644 --- a/site/guide/templates/_duplicate-template.qmd +++ b/site/guide/templates/_duplicate-template.qmd @@ -7,7 +7,7 @@ To duplicate an existing template and start with version one of that new templat 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for the type of template you want to duplicate: @@ -32,7 +32,7 @@ To duplicate an existing template and start with version one of that new templat 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/working-with-model-documents.qmd){target="blank"}. diff --git a/site/guide/templates/_duplicate-text-blocks.qmd b/site/guide/templates/_duplicate-text-blocks.qmd index 3d25feb6c2..8ab45ebe2c 100644 --- a/site/guide/templates/_duplicate-text-blocks.qmd +++ b/site/guide/templates/_duplicate-text-blocks.qmd @@ -6,7 +6,7 @@ To make a copy of an existing text block in your block library: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Block Library**. +1. Under {{< fa file >}} Documents, select **Block Library**. 1. To the right of the text block you want to edit, click **{{< fa ellipsis-vertical >}}** and select **Duplicate Text Block**. diff --git a/site/guide/templates/_outline-editing-mode.qmd b/site/guide/templates/_outline-editing-mode.qmd index c4d3c4783c..d2b98119d6 100644 --- a/site/guide/templates/_outline-editing-mode.qmd +++ b/site/guide/templates/_outline-editing-mode.qmd @@ -18,7 +18,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> Remove sections : 1. Hover over the section you want to delete. 1. When the **{{< fa trash-can >}}** appears, click on it. - 1. After you confirm, that section will be removed. + 1. Click **Yes, Delete Section** to confirm deletion of that section. Reorder sections : Click **{{< fa ellipsis-vertical >}}{{< fa ellipsis-vertical >}}** and hold firmly to drag to reorder sections. diff --git a/site/guide/templates/_view-document-templates.qmd b/site/guide/templates/_view-document-templates.qmd index d659231431..aa6fc9ee86 100644 --- a/site/guide/templates/_view-document-templates.qmd +++ b/site/guide/templates/_view-document-templates.qmd @@ -7,7 +7,7 @@ To review the existing templates available to your organization: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for the document type with the templates you want to view: @@ -63,7 +63,7 @@ To review the existing templates available to your organization: :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Documents, select **Templates**. +1. Under {{< fa file >}} Documents, select **Templates**. 1. Select one of the tabs for [the document type with the templates you want to view](/guide/templates/working-with-model-documents.qmd){target="blank"}. diff --git a/site/guide/templates/customize-document-templates.qmd b/site/guide/templates/customize-document-templates.qmd index 78c6ab6641..209dce6695 100644 --- a/site/guide/templates/customize-document-templates.qmd +++ b/site/guide/templates/customize-document-templates.qmd @@ -50,7 +50,7 @@ Check the [document template]{.smallcaps} section[^3] in the right sidebar. 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Templates**. +2. Under {{< fa file >}} Documents, select **Templates**. 3. Select one of the tabs for the type of template you want to edit:[^5] @@ -105,7 +105,7 @@ To add shared text blocks to your templates via the YAML editor: a. In the left sidebar, click **{{< fa gear >}} Settings**. -b. Under Documents, select **Block Library**. +b. Under {{< fa file >}} Documents, select **Block Library**. c. Select **Shared Blocks** and click **{{< fa ellipsis-vertical >}}** under the right-most column for the block you'd like to insert into a template. diff --git a/site/guide/templates/customize-virtual-document-validator.qmd b/site/guide/templates/customize-virtual-document-validator.qmd index dfb5ca4220..7a0aaafd37 100644 --- a/site/guide/templates/customize-virtual-document-validator.qmd +++ b/site/guide/templates/customize-virtual-document-validator.qmd @@ -37,7 +37,7 @@ Default regulations provided by {{< var vm.product >}} cannot be edited.[^2] 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Regulations & Policies**. +2. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 3. Add or edit a regulation or policy: @@ -79,7 +79,7 @@ To manage an assessment: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Regulations & Policies**. +2. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 3. Select the regulation or policy you want to add or clone an assessment for by clicking on it. @@ -110,7 +110,7 @@ d. Once cloned, add or edit the assessment questions.[^3] 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Regulations & Policies**. +2. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 3. Select the regulation or policy you want to add or clone an assessment for by clicking on it. diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index beb6943e56..7fee8ead4c 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -109,7 +109,7 @@ Delete templates no longer required by your organization: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Templates**. +2. Under {{< fa file >}} Documents, select **Templates**. 3. Select one of the tabs for the document type with the templates you want to remove: @@ -124,7 +124,7 @@ Delete templates no longer required by your organization: 5. Click **Delete Template** to remove that template. - Once you confirm, the template will be deleted. +6. Click **Yes, Delete Template** to confirm permanent deletion of that template. diff --git a/site/guide/templates/manage-document-types.qmd b/site/guide/templates/manage-document-types.qmd index 624e29f133..35f06dece4 100644 --- a/site/guide/templates/manage-document-types.qmd +++ b/site/guide/templates/manage-document-types.qmd @@ -30,7 +30,7 @@ These stock document types cannot be deleted, only edited: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Document Types**. +2. Under {{< fa file >}} Documents, select **Document Types**. 3. Click **{{< fa plus >}} Add Document Type**. @@ -38,9 +38,9 @@ These stock document types cannot be deleted, only edited: - Provide a **[name]{.smallcaps}** and an optional **[description]{.smallcaps}**. - Toggle whether this document type should be automatically created **[when model is registered]{.smallcaps}**. - - Toggle an optional **[default template]{.smallcaps}** for this document type.[^2] + - (Optional) Toggle a **[default template]{.smallcaps}** for this document type.[^2] - Select the model stakeholder types[^3] that should have **[update document]{.smallcaps}** permissions for this document type.[^4] - - Select the model stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^5] + - (Optional) Select the model stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^5] 5. Click **Create Document Type** to add your document type. @@ -54,7 +54,7 @@ Once created, customize the available templates for your document type.[^6] 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Document Types**. +2. Under {{< fa file >}} Documents, select **Document Types**. 3. Edit or delete document types as desired. @@ -74,7 +74,7 @@ a. Hover over the document type you want to delete. b. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document type. -c. After you confirm, the document type will be deleted. +c. Click **Yes, Delete Document Type** to confirm permanent deletion of that document type. ::: {.callout-important} ## Model documentation, validation report, and ongoing monitoring report document types are stock types and cannot be deleted. @@ -95,7 +95,10 @@ In order to delete a document type, there must be no models using that document [^4]: [Manage model documents](manage-model-documents.qmd#edit-model-documents) -[^5]: [Manage document templates](/guide/templates/manage-document-templates.qmd#edit-document-template-outlines) +[^5]: + + - At least one model stakeholder type must be assigned to **[update document]{.smallcaps}** permissions in order to adjust **[update document outline]{.smallcaps}** permissions. + - [Manage document templates](/guide/templates/manage-document-templates.qmd#edit-document-template-outlines) [^6]: [Customize document templates](customize-document-templates.qmd) diff --git a/site/guide/templates/manage-model-documents.qmd b/site/guide/templates/manage-model-documents.qmd index d2cf0b3e4c..f52b4aad4a 100644 --- a/site/guide/templates/manage-model-documents.qmd +++ b/site/guide/templates/manage-model-documents.qmd @@ -167,7 +167,7 @@ Deletion of documents on models is permanent and cannot be undone. 5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document. -6. After you confirm, the document type will be deleted from the model. +6. Click **Yes, Delete Document** to confirm permanent deletion of that document from the model. ## What's next diff --git a/site/guide/templates/manage-text-block-library.qmd b/site/guide/templates/manage-text-block-library.qmd index 3d86f54c9e..d80d979ea0 100644 --- a/site/guide/templates/manage-text-block-library.qmd +++ b/site/guide/templates/manage-text-block-library.qmd @@ -60,7 +60,7 @@ To modify an existing text block in your block library: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Block Library**. +2. Under {{< fa file >}} Documents, select **Block Library**. 3. To the right of the text block you want to edit, click **{{< fa ellipsis-vertical >}}** and select **Edit Details**. @@ -83,12 +83,11 @@ To remove an existing text block from your block library: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Documents, select **Block Library**. +2. Under {{< fa file >}} Documents, select **Block Library**. 3. To the right of the text block you want to remove, click **{{< fa ellipsis-vertical >}}** and select **[{{< fa trash-can >}} Delete Text Block]{.red}**. -4. After you confirm, the text block will be removed from your block library. - +4. Click **Yes, Delete Block** to confirm permanent deletion of that block from your block library. diff --git a/site/guide/workflows/_add-model-stages.qmd b/site/guide/workflows/_add-model-stages.qmd index f2ae204643..3c482342c1 100644 --- a/site/guide/workflows/_add-model-stages.qmd +++ b/site/guide/workflows/_add-model-stages.qmd @@ -4,16 +4,12 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Models, select **Model Stages**: +1. Under {{< fa cube >}} Model Inventory, select **Model Stages**: - To add a stage, click **{{< fa plus >}} Add Model Stage**. - To edit a stage, click on the stage itself. -1. On the Add New Model Stage modal that appears: - - a. Provide a stage **[name]{.smallcaps}** - b. Provide a stage **[description]{.smallcaps}** - c. Assign a **[color]{.smallcaps}** to the stage +1. Provide a stage **[name]{.smallcaps}** and a stage **[description]{.smallcaps}**, then assign a **[color]{.smallcaps}** to the stage. 1. When you are done, click **Save** to apply your changes. diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd index 827fbb3d74..ed4bc66476 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -7,7 +7,7 @@ To add a new blank workflow: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflows**. +1. Under {{< fa shield >}} Governance, select **Workflows**. 1. Select the tab for the type of workflow to add: @@ -26,7 +26,7 @@ a. Under **[workflow start]{.smallcaps}**, select when the workflow should be in - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - **On Model Registration** — Start this workflow when a model is registered in your model inventory.[^on-model-registration] - - **On Custom Field Change** — Start this workflow on a change to a specific model inventory field.[^on-field-change] To configure, select a field under **[model field to monitor]{.smallcaps}**. + - **On Field Change** — Start this workflow on a change to a specific model inventory field.[^on-field-change] To configure, select a field under **[model field to monitor]{.smallcaps}**. - **Via Webhook** — Start this workflow when a webhook event is received. a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. @@ -43,6 +43,7 @@ a. Under **[workflow start]{.smallcaps}**, select when the workflow should be in - **Manually** — Start this workflow manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] - **On Artifact Registration** — Start this workflow when a artifact is logged on a model.[^on-artifact-registration] + - **Via Webhook** — Start this workflow when a webhook event is received. a. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] this workflow applies to. @@ -83,7 +84,7 @@ a. Click **Add Artifact Workflow** to save your blank workflow, and then [config :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflows**. +1. Under {{< fa shield >}} Governance, select **Workflows**. 1. Select the tab for the type of workflow to add: @@ -100,7 +101,7 @@ a. Under **[workflow start]{.smallcaps}**, select when the workflow should be in - **Manually** — Start this workflow manually. - **On Model Registration** — Start this workflow when a model is registered in your model inventory. - - **On Custom Field Change** — Start this workflow on a change to a specific model inventory field. To configure, select a field under **[model field to monitor]{.smallcaps}**. + - **On Field Change** — Start this workflow on a change to a specific model inventory field. To configure, select a field under **[model field to monitor]{.smallcaps}**. - **Via Webhook** — Start this workflow when a webhook event is received. a. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index db18079854..787992a996 100644 --- a/site/guide/workflows/_configure-workflow-steps.qmd +++ b/site/guide/workflows/_configure-workflow-steps.qmd @@ -7,7 +7,7 @@ To add or edit workflow steps: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflows**. +1. Under {{< fa shield >}} Governance, select **Workflows**. 1. Click on the workflow you'd like to modify, then: @@ -41,7 +41,7 @@ To add or edit workflow steps: a. In the left sidebar, click **{{< fa gear >}} Settings**. -a. Under Workspace, select **Workflows**. +a. Under {{< fa shield >}} Governance, select **Workflows**. a. Click on the workflow you'd like to modify, then: diff --git a/site/guide/workflows/_link-workflow-together.qmd b/site/guide/workflows/_link-workflow-together.qmd index da8bc6a78f..a188a59095 100644 --- a/site/guide/workflows/_link-workflow-together.qmd +++ b/site/guide/workflows/_link-workflow-together.qmd @@ -51,7 +51,7 @@ a. Designate the end of your workflow by dragging an **{{< fa circle-stop >}} En a. Link relevant previous steps to the **{{< fa circle-stop >}} End** step by clicking on the bottom **{{< fa circle >}}** of those steps, and dragging to the top **{{< fa circle >}}** of the **{{< fa circle-stop >}} End** step. -a. When you are finished configuring your workflow, click **Save Workflow** to apply your changes. +a. When you are finished configuring your workflow, click **Save** to apply your changes. ::: @@ -84,6 +84,6 @@ a. Designate the end of your workflow by dragging an **{{< fa circle-stop >}} En a. Link relevant previous steps to the **{{< fa circle-stop >}} End** step by clicking on the bottom **{{< fa circle >}}** of those steps, and dragging to the top **{{< fa circle >}}** of the **{{< fa circle-stop >}} End** step. -a. When you are finished configuring your workflow, click **Save Workflow** to apply your changes. +a. When you are finished configuring your workflow, click **Save** to apply your changes. :::: diff --git a/site/guide/workflows/_workflow-states.qmd b/site/guide/workflows/_workflow-states.qmd index fb42594997..f20acfe891 100644 --- a/site/guide/workflows/_workflow-states.qmd +++ b/site/guide/workflows/_workflow-states.qmd @@ -9,7 +9,7 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflow States**. +1. Under {{< fa shield >}} Governance, select **Workflow States**. 1. Select the tab for the type of state to add: @@ -18,7 +18,7 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. Click on the workflow you'd like to modify workflow states for. -1. Click **{{< fa gear >}} Add Workflow State**. +1. Click **{{< fa plus >}} Add Workflow State**. 1. Enter in a **[name]{.smallcaps}** and a **[description]{.smallcaps}**, then select a **[color]{.smallcaps}** for your workflow state. @@ -28,7 +28,7 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflow States**. +1. Under {{< fa shield >}} Governance, select **Workflow States**. 1. Select the tab for the type of state you want to edit: @@ -37,7 +37,9 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. Click on the workflow you'd like to edit the states for. -1. Hover over the workflow state until **{{< fa pencil >}} Edit Details** appears, then click on it. +1. Hover over the workflow state you want to edit until the **{{< fa ellipsis-vertical >}}** appears, then click on it. + +1. Select **{{< fa pencil >}} Edit Details**. 1. Make your changes to the **[name]{.smallcaps}**, **[description]{.smallcaps}**, and **[color]{.smallcaps}** for your workflow state. @@ -51,7 +53,7 @@ If a state is or was previously in use on a workflow within a {{< fa wifi >}} W 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under Workspace, select **Workflow States**. +1. Under {{< fa shield >}} Governance, select **Workflow States**. 1. Select the tab for the type of state you want to delete: @@ -60,9 +62,11 @@ If a state is or was previously in use on a workflow within a {{< fa wifi >}} W 1. Click on the workflow you'd like to delete workflow states for. -1. Hover over the workflow state until [**{{< fa trash-can >}} Delete Workflow State**]{.red} appears, then click on it. +1. Hover over the workflow state you want to delete until the **{{< fa ellipsis-vertical >}}** appears, then click on it. + +1. Select [**{{< fa trash-can >}} Delete Workflow State**]{.red}. -1. After you confirm, the workflow state will be removed. +1. Click **Yes, Delete Workflow State** to confirm permanent deletion of that workflow state. :::: diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index f5f0f325a6..5cfbaaafba 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -52,7 +52,7 @@ To create a copy of an existing workflow: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Workflows**. +2. Under {{< fa shield >}} Governance, select **Workflows**. 3. Select the tab for the type of workflow to clone: @@ -85,7 +85,7 @@ You can edit a workflow in several ways: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Workflows**. +2. Under {{< fa shield >}} Governance, select **Workflows**. 3. Select the type of workflow, then click on the workflow you'd like to modify to edit the configuration for that workflow. @@ -128,9 +128,9 @@ Deleting workflow steps on workflows active on models may result in malfunctioni 2. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa gear >}} Delete**. - On the confirmation dialogue that appears, select **OK** to confirm deletion. +3. Click **Yes, Delete Step** to confirm removal of the step. -3. When you are finished, click **Save Workflow** to apply your changes. +4. When you are finished, click **Save New Version** to apply your changes. ### Remove links between steps @@ -138,9 +138,9 @@ Deleting workflow steps on workflows active on models may result in malfunctioni 2. Click **{{< fa trash-can >}}** to delete the connection. - On the confirmation dialogue that appears, select **OK** to confirm deletion. +3. Click **Yes, Delete Connection** to confirm removal of the connection. -3. When you are finished, click **Save Workflow** to apply your changes. +4. When you are finished, click **Save New Version** to apply your changes. ## Delete existing workflows @@ -151,13 +151,13 @@ Deleting workflow steps on workflows active on models may result in malfunctioni 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Workflows**. +2. Under {{< fa shield >}} Governance, select **Workflows**. 3. Hover over the workflow you would like to remove. -3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa ban >}} Delete Workflow**. +3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa trash-can >}} Delete Workflow**. -5. After you confirm, the workflow will be removed and inaccessible by models for any future runs. +5. Click **Yes, Delete Workflow** to permanently remove that workflow and make it inaccessible for any future runs. ## What's next diff --git a/site/guide/workflows/manage-model-stages.qmd b/site/guide/workflows/manage-model-stages.qmd index 2e473b48d8..6b762c7d49 100644 --- a/site/guide/workflows/manage-model-stages.qmd +++ b/site/guide/workflows/manage-model-stages.qmd @@ -29,7 +29,7 @@ aliases: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Models, select **Model Stages**. +2. Under {{< fa cube >}} Model Inventory, select **Model Stages**. 3. Hover over the stage you'd like to modify. diff --git a/site/reference/validmind-rest-api-vm.qmd b/site/reference/validmind-rest-api-vm.qmd index a52fe3150b..4b4cb42804 100644 --- a/site/reference/validmind-rest-api-vm.qmd +++ b/site/reference/validmind-rest-api-vm.qmd @@ -60,7 +60,7 @@ curl -X GET "https://api.prod.validmind.ai/vm/api/v1/models" \ 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Your Account, select **Profile**. +2. Under {{< fa circle-user >}} Your Account, select **Profile**. 3. Under Access Keys: diff --git a/site/training/administrator-fundamentals/_invite-new-user.qmd b/site/training/administrator-fundamentals/_invite-new-user.qmd index c45409febd..104a05816f 100644 --- a/site/training/administrator-fundamentals/_invite-new-user.qmd +++ b/site/training/administrator-fundamentals/_invite-new-user.qmd @@ -5,16 +5,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under User Permissions, select **Invite New Users**. +1. Under {{< fa users >}} Users & Access, select **Invite New Users**. 1. Under Invite By Email: - Enter the user's **[email]{.smallcaps}** address. - Assign the user to a group from the **[group]{.smallcaps}** dropdown menu. - - Click **{{< fa plus >}}** under [role]{.smallcap} to open the Assign Roles menu for that user: + - Click **{{< fa plus >}}** under [role (optional)]{.smallcaps} to assign roles to that user: 1. Click **{{< fa plus >}}** next to the role for each role to be assigned. - 2. Click **Assign Roles to Invitee**. + 2. Click **Assign Additional Roles (Optional)**.^[Users invited without additional roles applied will be automatically assigned to a [{{< fa wrench >}} Basic User]{.bubble} role with minimal permissions.] 1. Click **{{< fa envelope >}} Send Invite**. diff --git a/site/training/administrator-fundamentals/customizing-your-model-inventory.qmd b/site/training/administrator-fundamentals/customizing-your-model-inventory.qmd index a2daae311d..5b05b68603 100644 --- a/site/training/administrator-fundamentals/customizing-your-model-inventory.qmd +++ b/site/training/administrator-fundamentals/customizing-your-model-inventory.qmd @@ -260,8 +260,9 @@ Please note that the stock **Model Developer**, **Model Owner**, and **Model Val **Add a model stakeholder type** ::: -1. Click **{{< fa plus >}} Add New Stakeholder Type**. +1. Click **{{< fa plus >}} Add Stakeholder Type**. 2. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the stakeholder type. +3. Click **Add Stakeholder Type** to create the stakeholder type. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -276,9 +277,20 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. 1. Click on the stakeholder type you added previously. 2. Toggle whether or not you want to select users for this stakeholder type during model registration. +3. On the **Models** tab, click **Edit Permissions**. +4. Toggle specific permissions for that stakeholder type by checking or unchecking the boxes next to the permission. +5. Click **Save Changes** to apply your changes. +6. Repeat steps 3-5 for the **Artifacts** tab. + + + + + When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -303,7 +315,7 @@ Manage artifact (finding) types 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Artifacts, select **Artifact Types**. +2. Under {{< fa expand >}} Artifacts, select **Artifact Types**. ::: {.panel-tabset} @@ -341,7 +353,7 @@ Manage artifact (finding) types 3. Click **Create** to create your new artifact type. 4. Click on your newly created artifact type to edit its details and permissions. 5. Click **{{< fa plus >}} Add Status** to add a status for this artifact type. -6. Enter in a **[name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. +6. Enter in a **[status name]{.smallcaps}** and assign a **[color]{.smallcaps}** to your artifact status. 7. When you are done, click **Add Status** to create your new status. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/administrator-fundamentals/onboarding-your-organization.qmd b/site/training/administrator-fundamentals/onboarding-your-organization.qmd index fd0d754751..b709132c53 100644 --- a/site/training/administrator-fundamentals/onboarding-your-organization.qmd +++ b/site/training/administrator-fundamentals/onboarding-your-organization.qmd @@ -159,14 +159,14 @@ Get your organization ready for use by first defining business units and use cas ## {background-iframe="https://app.prod.validmind.ai/settings/organization" background-interactive="true" data-preload="yes"} -:::: {.slideover--r .three-quarters .auto-collapse-10} +:::: {.slideover--l .three-quarters .auto-collapse-10} ::: {.tc} **Add a business unit** ::: -1. Click **{{< fa plus >}} Add New Business Unit** under Business Units. +1. Click **{{< fa plus >}} Add Business Unit** under Business Units. 2. Enter in your **[business unit name]{.smallcaps}**. -3. Click **{{< fa plus >}} Add Business Unit** to save your changes. +3. Click **Add Business Unit** to save your changes. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -174,7 +174,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. ## {background-iframe="https://app.prod.validmind.ai/settings/inventory-model-custom-fields" background-interactive="true" data-preload="yes"} -:::: {.slideover--r .three-quarters .auto-collapse-10} +:::: {.slideover--l .three-quarters .auto-collapse-10} ::: {.tc} **Add a use case** ::: @@ -207,7 +207,7 @@ Next, define your risk areas and validation guidelines: 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Risk Areas & Validation Guidelines**. +2. Under {{< fa shield >}} Governance, select **Risk Areas & Validation Guidelines**. ::: {.panel-tabset} @@ -277,7 +277,7 @@ Manage user groups 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **Groups**. +2. Under {{< fa users >}} Users & Access, select **Groups**. ::: {.panel-tabset} @@ -302,10 +302,10 @@ Manage user groups **Add a user group** ::: -1. Next to All Groups, click **{{< fa plus >}} Create New Group** to open the Create New Group menu. +1. Click **{{< fa plus >}} Create Group**. 2. Enter a **[group name]{.smallcaps}** and **[group description]{.smallcaps}** for the new group and click **Continue**. 3. Select users from the list to add them to the group. -4. Click **{{< fa check >}} Create Group** to save. +4. Click **Create Group** to save. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -351,9 +351,9 @@ Manage user roles **Create new role** ::: -1. Click **{{< fa plus >}} Add New Role**. +1. Click **{{< fa plus >}} Add Role**. 2. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role. -3. Click **{{< fa plus >}} Add Role**. +3. Click **Add Role**. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -367,9 +367,10 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. ::: 1. Select the role you created previously. -2. On the **Permissions** tab, select **Edit Permissions**. -3. Toggle specific user permissions for that role by checking or unchecking the boxes next to the permission. -4. Click **Save Permissions** to apply your changes. +2. On the **Feature Permissions** tab, click **Edit Permissions**. +3. Toggle specific permissions for that role by checking or unchecking the boxes next to the permission. +4. Click **Save Changes** to apply your changes. +5. Repeat steps 2-4 for the **Field Permissions** tab. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -405,7 +406,7 @@ In addition to assigning permissions via individual user roles, you can add role **Modify global permissions** ::: -1. **Add the role you created earlier** to two permissions by clicking **{{< fa plus >}}**, then selecting the role from the drop-down menu. +1. **Add the role you created earlier** to two permissions by clicking **{{< fa circle-plus >}}**, then selecting the role from the drop-down menu. 2. **Remove the role you created earlier** from one of the permissions you added above by clicking **{{< fa x >}}** next to the role. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -425,6 +426,12 @@ Invite users via email :::
Try it **live** on the next page. {{< fa hand-point-right >}} + +:::: {.mt5 .f5 .pa2 .embed} +Users invited without additional roles applied will be automatically assigned to a [{{< fa wrench >}} Basic User]{.bubble} role with minimal permissions. + +::: + ::: ::: {.column width="70%" .bl .pl4 .f3} @@ -433,7 +440,7 @@ Once you've set up the basics, grant users access to the {{< var validmind.platf 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under User Permissions, select **Invite New Users**. +2. Under {{< fa users >}} Users & Access, select **Invite New Users**. ::: {.panel-tabset} @@ -491,7 +498,7 @@ After granting access to your users, you can adjust their roles as needed: 1. **For the user you invited earlier,** click the {{< fa circle-plus >}} icon to open the Assign Roles menu for that user. 2. Click **{{< fa plus >}}** next to a role to assign that role to the user. -3. Click **{{< fa puzzle-piece >}} Assign Roles to User** to save changes. +3. Click **Assign Roles to User** to save changes. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd index 0110612344..73a54e2bc2 100644 --- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd +++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd @@ -203,16 +203,13 @@ Manage model stages ## {background-iframe="https://app.prod.validmind.ai/settings/statuses" background-interactive="true" data-preload="yes"} -:::: {.slideover--b .half .auto-collapse-10} +:::: {.slideover--b .three-quarters .auto-collapse-10} ::: {.tc} **Add a model stage** ::: 1. Click **{{< fa plus >}} Add Model Stage**. -2. On the Add New Model Stage modal that appears: - a. Provide a stage **[name]{.smallcaps}** - b. Provide a stage **[description]{.smallcaps}** - c. Assign a **[color]{.smallcaps}** to the stage +2. Provide a stage **[name]{.smallcaps}** and a stage **[description]{.smallcaps}**, then assign a **[color]{.smallcaps}** to the stage. 3. When you are done, click **Save** to apply your changes. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -300,7 +297,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. - Drag from the **{{< fa circle >}}** at the bottom of [**Start**]{.bubble .green .green-bg} to the top **{{< fa circle >}}** on the step you added previously. 4. Designate the end of your workflow by dragging an **{{< fa circle-stop >}} End** step onto the canvas. 5. Link your previous step to the **{{< fa circle-stop >}} End** step by clicking on the bottom **{{< fa circle >}}** of that step, and dragging to the top **{{< fa circle >}}** of the **{{< fa circle-stop >}} End** step. -6. Click **Save Workflow** to apply your changes. +6. Click **Save** to apply your changes. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -429,7 +426,7 @@ Add regulations & policies 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Regulations & Policies**. +2. Under {{< fa shield >}} Governance, select **Regulations & Policies**. {{< include /guide/templates/_add-regulations-policies.qmd >}} @@ -471,7 +468,7 @@ Add assessments 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under Workspace, select **Regulations & Policies**. +2. Under {{< fa shield >}} Governance, select **Regulations & Policies**. 3. Select the regulation or policy you want to add an assessment for by clicking on it.