From cd9bde635300b69da1d34c83141daf7777c9175a Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Tue, 7 Apr 2026 12:24:47 -0700
Subject: [PATCH 01/27] Edit: Managing your organization > Manage document
defaults (#1268)
---
.../managing-your-organization.qmd | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd
index 90c1ffb3a9..9d3cb9c100 100644
--- a/site/guide/configuration/managing-your-organization.qmd
+++ b/site/guide/configuration/managing-your-organization.qmd
@@ -66,12 +66,27 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss
## Manage document defaults
+::: {.panel-tabset}
+
+### Tracked changes
+
1. In the left sidebar, click **{{< fa gear >}} Settings**.
2. Under Workspace, 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.
+### Numbered table and figure captions
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa building >}} Organization, select **Organization**.
+
+3. Under Document Defaults, toggle whether you would like to **Enable numbered table and figure captions** for test results inserted within documents[^6] for your current active organization.
+
+
+:::
+
## Organization setup
@@ -92,3 +107,5 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss
[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
[^5]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#tracking-changes)
+
+[^6]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd)
From ec41a3599ba4a622c4dcc934a1c97a28f8df07a6 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Tue, 7 Apr 2026 14:09:46 -0700
Subject: [PATCH 02/27] docs: Settings redesign / overhaul (#1266)
* Managing your organization + Manage business units
* Set up your organization
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Save point
* Update: Manage platform notifications > Customize email notifications
* Cleanup: Integrations examples
* Edit: Manage groups
* proofread
* proofread x2
* proofread x3
* Edit
* Edit: Manage roles
* proofread
* proofread x2
* Edited: Manage model stakeholder types
* Proofread: Admin quickstart + related includes
* Proofread: Manage users
* Proofread: Manage roles
* Proofread: Manage model stakeholder types
* Proofread: Manage permissions
* Proofread: Workflow states
* Proofread: Manage model stages
* Proofread: Configure workflows
* Proofread: Manage model inventory fields
* Proofread: Manage document types
* Proofread: Manage artifact types
* Save point
* Proofread: Manage artifact severities
* Proofread: Manage artifact fields
* UI adjustments
Made-with: Cursor
* Edit
* Edit 2
* Fixing some weird footnotes
* Edit
* Edit
* Not sure why settings file was included
---
.../quickstart-administrator.qmd | 10 +--
site/guide/attestation/_add-attestations.qmd | 4 +-
.../attestation/_configure-attestations.qmd | 2 +-
.../guide/attestation/manage-attestations.qmd | 10 +--
.../configuration/_add-business-units.qmd | 27 ++++++--
site/guide/configuration/_add-groups.qmd | 10 +--
.../_add-model-stakeholder-types.qmd | 16 ++---
.../_add-remove-group-members.qmd | 23 +++----
site/guide/configuration/_add-roles.qmd | 24 +++++--
site/guide/configuration/_add-use-cases.qmd | 34 ++++++----
site/guide/configuration/_invite-users.qmd | 35 +++++++++-
.../configuration/_manage-permissions.qmd | 19 ++++--
.../_manage-role-permissions.qmd | 24 +++----
.../_manage-stakeholder-type-permissions.qmd | 24 +++----
.../configuration/_manage-user-roles.qmd | 16 ++---
.../_model-stakeholder-types.qmd | 9 ++-
.../customize-your-dashboard.qmd | 4 +-
site/guide/configuration/manage-groups.qmd | 18 ++---
.../manage-model-stakeholder-types.qmd | 6 +-
.../configuration/manage-permissions.qmd | 17 +++--
.../manage-platform-notifications.qmd | 4 +-
site/guide/configuration/manage-roles.qmd | 32 ++++-----
site/guide/configuration/manage-users.qmd | 10 +--
.../configuration/manage-your-profile.qmd | 4 +-
.../managing-your-organization.qmd | 8 +--
.../set-up-your-organization.qmd | 6 +-
.../configure-analytics-exports.qmd | 16 ++---
.../integrations/configure-connections.qmd | 10 +--
.../implement-custom-integrations.qmd | 2 +-
.../integrations/integrations-examples.qmd | 65 ++++++++++---------
.../integrations/link-external-models.qmd | 2 +-
site/guide/integrations/manage-secrets.qmd | 10 +--
.../collaborate-with-others.qmd | 9 +--
.../work-with-content-blocks.qmd | 2 +-
.../_add-edit-inventory-fields.qmd | 42 ++++++------
.../model-inventory/_remove-attachments.qmd | 6 +-
.../model-inventory/_remove-layout-view.qmd | 4 +-
.../model-inventory/archive-delete-models.qmd | 8 +--
.../manage-model-inventory-fields.qmd | 35 ++++++----
.../_add-artifact-severities.qmd | 4 +-
.../_add-edit-artifact-fields.qmd | 10 +--
.../_add-edit-artifact-statuses.qmd | 10 +--
.../_add-edit-artifact-types.qmd | 30 +++++----
.../_reorder-artifact-severities.qmd | 2 +-
.../model-validation/add-manage-artifacts.qmd | 2 +-
.../configure-assessment-options.qmd | 2 +-
.../manage-artifact-fields.qmd | 14 ++--
.../manage-artifact-severities.qmd | 6 +-
.../manage-artifact-types.qmd | 12 ++--
.../manage-validation-guidelines.qmd | 14 ++--
.../reporting/_create-a-visualization.qmd | 2 +-
.../guide/reporting/manage-custom-reports.qmd | 6 +-
site/guide/templates/_add-text-blocks.qmd | 4 +-
.../_customize-document-templates.qmd | 6 +-
site/guide/templates/_duplicate-template.qmd | 4 +-
.../templates/_duplicate-text-blocks.qmd | 2 +-
.../guide/templates/_outline-editing-mode.qmd | 2 +-
.../templates/_view-document-templates.qmd | 4 +-
.../customize-document-templates.qmd | 4 +-
.../customize-virtual-document-validator.qmd | 6 +-
.../templates/manage-document-templates.qmd | 4 +-
.../guide/templates/manage-document-types.qmd | 15 +++--
.../templates/manage-model-documents.qmd | 2 +-
.../templates/manage-text-block-library.qmd | 7 +-
site/guide/workflows/_add-model-stages.qmd | 8 +--
site/guide/workflows/_add-new-workflows.qmd | 9 +--
.../workflows/_configure-workflow-steps.qmd | 4 +-
.../workflows/_link-workflow-together.qmd | 4 +-
site/guide/workflows/_workflow-states.qmd | 18 +++--
site/guide/workflows/configure-workflows.qmd | 18 ++---
site/guide/workflows/manage-model-stages.qmd | 2 +-
site/reference/validmind-rest-api-vm.qmd | 2 +-
.../_invite-new-user.qmd | 6 +-
.../customizing-your-model-inventory.qmd | 20 ++++--
.../onboarding-your-organization.qmd | 39 ++++++-----
.../using-validmind-for-risk-management.qmd | 13 ++--
76 files changed, 521 insertions(+), 403 deletions(-)
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 b93073f467..fa9a80c68c 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 18622cbdd0..c3c6b3a2bd 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.
From 31f394b7fe87281ea5bc4c8b3c55ebc510c85164 Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Tue, 7 Apr 2026 16:56:21 -0700
Subject: [PATCH 03/27] docs: Edit active workflow end dates (#1270)
* WIP
* Edit: Manage workflows > Update active workflows
---
site/guide/workflows/_abort-workflows.qmd | 8 ++--
site/guide/workflows/_reset-workflows.qmd | 8 ++--
site/guide/workflows/manage-workflows.qmd | 46 ++++++++++++++++++-
.../using-validmind-for-risk-management.qmd | 2 +-
4 files changed, 53 insertions(+), 11 deletions(-)
diff --git a/site/guide/workflows/_abort-workflows.qmd b/site/guide/workflows/_abort-workflows.qmd
index 62ad11b3be..6897a6082f 100644
--- a/site/guide/workflows/_abort-workflows.qmd
+++ b/site/guide/workflows/_abort-workflows.qmd
@@ -21,7 +21,7 @@ To cancel a run of a workflow:
1. Click on the name of the workflow you'd like to abort to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow.
@@ -31,7 +31,7 @@ To cancel a run of a workflow:
1. Click on the name of the workflow you'd like to abort to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow.
@@ -55,7 +55,7 @@ To cancel a run of a workflow:
1. Click on the name of the workflow you'd like to abort to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow.
@@ -65,7 +65,7 @@ To cancel a run of a workflow:
1. Click on the name of the workflow you'd like to abort to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, make sure **[restart workflow after aborting]{.smallcaps}** is untoggled, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to abort your workflow.
diff --git a/site/guide/workflows/_reset-workflows.qmd b/site/guide/workflows/_reset-workflows.qmd
index b8403f5393..9a770911ca 100644
--- a/site/guide/workflows/_reset-workflows.qmd
+++ b/site/guide/workflows/_reset-workflows.qmd
@@ -21,7 +21,7 @@ To reset a workflow to the beginning:
1. Click on the name of the workflow you'd like to reset to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow.
@@ -31,7 +31,7 @@ To reset a workflow to the beginning:
1. Click on the name of the workflow you'd like to reset to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow.
@@ -55,7 +55,7 @@ To reset a workflow to the beginning:
1. Click on the name of the workflow you'd like to reset to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow.
@@ -65,7 +65,7 @@ To reset a workflow to the beginning:
1. Click on the name of the workflow you'd like to reset to open that specific workflow's details.
-1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+1. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
1. On the confirmation page, toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow.
diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd
index 372a02f986..b92ba7d702 100644
--- a/site/guide/workflows/manage-workflows.qmd
+++ b/site/guide/workflows/manage-workflows.qmd
@@ -63,7 +63,9 @@ To manually resume a workflow in a {{< fa clock >}} Wait state:[^4]
::::
-## Update workflow versions
+## Update active workflows
+
+### Update workflow versions
::: {.callout-important}
Applying the latest version of a workflow will reset the workflow to the beginning.
@@ -76,6 +78,42 @@ If you have updated a workflow's configuration and want to apply the newest vers
2. Manually initiate the workflow again.[^9]
+### Edit workflow end dates
+
+To adjust the expected end date for a workflow:
+
+::: {.panel-tabset}
+
+#### On models
+
+1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
+
+2. Select a model or find your model by applying a filter or searching for it.[^10]
+
+3. On the landing page of your model, locate the [active workflows]{.smallcaps} section.
+
+4. Click on the name of the workflow you'd like to edit the end date for to open that specific workflow's details.
+
+5. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa calendar >}} Edit Expected End Date**.
+
+6. Enter in the new [expected end date]{.smallcaps} for the workflow.
+
+7. Click **Save Expected End Date** to apply the new date.
+
+#### On artifacts
+
+1. On the details page of your artifact,[^11] locate the [active workflows]{.smallcaps} section.
+
+2. Click on the name of the workflow you'd like to edit the end date for to open that specific workflow's details.
+
+3. On the workflow's detail modal, click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa calendar >}} Edit Expected End Date**.
+
+4. Enter in the new [expected end date]{.smallcaps} for the workflow.
+
+5. Click **Save Expected End Date** to apply the new date.
+
+:::
+
## Abort workflows
{{< include /guide/workflows/_abort-workflows.qmd >}}
@@ -99,4 +137,8 @@ If you have updated a workflow's configuration and want to apply the newest vers
[^8]: [Abort workflows](/guide/workflows/manage-workflows.qmd#abort-workflows)
-[^9]: [Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)
\ No newline at end of file
+[^9]: [Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)
+
+[^10]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
+
+[^11]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)
\ No newline at end of file
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 73a54e2bc2..4ad4380a80 100644
--- a/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd
+++ b/site/training/administrator-fundamentals/using-validmind-for-risk-management.qmd
@@ -388,7 +388,7 @@ As an administrator, you may need to reset or abort workflows as required:
1. Select the name of your model you registered for this course to open up the model details page.
2. On the landing page of your model, locate the [active workflows]{.smallcaps} section.
3. Click on the name of the workflow you manually initiated earlier to open that workflow's details.
-4. Click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select **{{< fa ban >}} Abort Workflow**.
+4. Click on the **{{< fa ellipsis-vertical >}}** in the top-right hand corner and select [**{{< fa ban >}} Abort Workflow**]{.red}.
5. Toggle **[restart workflow after aborting]{.smallcaps}** on, then click **{{< fa arrow-right >}} Yes, Abort Workflow** to restart your workflow.
When you're done, click [{{< fa chevron-right >}}]() to continue.
From 2751a69115c2fcf381c36198496adb2088231193 Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Thu, 9 Apr 2026 08:36:26 -0700
Subject: [PATCH 04/27] docs: add HTTP proxy guide for ValidMind Library
- New page covering proxy env vars and troubleshooting
- Link from ValidMind Library sidebar
---
site/developer/_sidebar.yaml | 2 +
.../use-http-proxy-with-validmind-library.qmd | 86 +++++++++++++++++++
2 files changed, 88 insertions(+)
create mode 100644 site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
diff --git a/site/developer/_sidebar.yaml b/site/developer/_sidebar.yaml
index d96b29d0f3..758c7187d9 100644
--- a/site/developer/_sidebar.yaml
+++ b/site/developer/_sidebar.yaml
@@ -23,6 +23,8 @@ website:
- text: "Install and initialize the library for R"
file: developer/model-documentation/install-and-initialize-validmind-for-r.qmd
- developer/model-documentation/store-credentials-in-env-file.qmd
+ - text: "Use an HTTP proxy with the library"
+ file: developer/model-documentation/use-http-proxy-with-validmind-library.qmd
- text: "---"
- text: "End-to-End Tutorials"
# USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
diff --git a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
new file mode 100644
index 0000000000..39b188e961
--- /dev/null
+++ b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
@@ -0,0 +1,86 @@
+---
+# Copyright © 2023-2026 ValidMind Inc. All rights reserved.
+# Refer to the LICENSE file in the root of this repository for details.
+# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
+title: "Use an HTTP proxy with the ValidMind Library"
+date: last-modified
+listing:
+ - id: whats-next
+ type: grid
+ max-description-length: 250
+ sort: false
+ fields: [title, description]
+ grid-columns: 2
+ contents:
+ - ../how-to/testing-overview.qmd
+ - ../how-to/feature-overview.qmd
+---
+
+The {{< var validmind.developer >}} does not provide a `proxy` argument on `vm.init()`. Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clients that honor proxy-related environment variables, which lets you work behind corporate or regional proxies without custom library configuration.
+
+::: {.attn}
+
+## Prerequisites
+
+- [x] {{< var link.login >}}
+- [x] You can set environment variables for the user or service account that runs Python or Jupyter.[^1]
+- [x] You have proxy connection details from your network administrator (host, port, and authentication rules if required).
+
+:::
+
+## 1. Set proxy environment variables
+
+Set the variables **before** you start the Python process or Jupyter kernel so the process inherits them when the library opens HTTP connections.
+
+Common variables:
+
+| Variable | Purpose |
+|----------|---------|
+| `HTTP_PROXY` | Proxy URL for `http` requests. |
+| `HTTPS_PROXY` | Proxy URL for `https` requests (typical for the ValidMind API). |
+| `ALL_PROXY` | Fallback when a scheme-specific variable is not set (behavior depends on the client library). |
+| `NO_PROXY` | Comma-separated hostnames, domains, or IP ranges that should **not** use the proxy (for example `localhost`, `127.0.0.1`, or an internal API hostname). |
+
+Example for a POSIX shell:
+
+```bash
+export HTTPS_PROXY=http://proxy.example.com:8080
+export HTTP_PROXY=http://proxy.example.com:8080
+export NO_PROXY=localhost,127.0.0.1,.corp.example.com
+```
+
+If your organization assigns these values automatically when you log in, confirm they are visible in the same environment where you launch Jupyter or your IDE.
+
+## 2. Restart your notebook or Python session
+
+If you change proxy variables after a session has already started, restart the kernel or Python interpreter so every library reload sees the updated environment.
+
+## What do I need to know?
+
+### Other outbound traffic
+
+Features that generate text with OpenAI or Azure OpenAI use those vendors’ Python SDKs. Those clients usually respect the same `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` values, but authentication, regional endpoints, and enterprise policies can add requirements. Consult your provider’s documentation when something works for the ValidMind API but not for LLM calls.[^2]
+
+### Underlying behavior
+
+Proxy handling is implemented by the underlying HTTP stacks (including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients). Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version. If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^3]
+
+## Troubleshooting
+
+- You see connection timeouts or “connection refused” when calling `vm.init()` or logging results — verify `HTTPS_PROXY` matches your proxy URL and that the host running Python can reach the proxy host and port.
+- Traffic should bypass the proxy for a specific API host — add that host or domain to `NO_PROXY` and restart the session.
+- Variables do not appear to apply — in a notebook, run `import os` and `print(os.environ.get("HTTPS_PROXY"))` in a fresh cell after restart; if it is empty, the variables were not set for that process (for example, they were only set in a different terminal).
+
+## What's next
+
+:::{#whats-next}
+:::
+
+
+
+
+[^1]: If you have not installed the library yet, start with [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd).
+
+[^2]: See for example [OpenAI](https://platform.openai.com/docs/guides/production-best-practices) and [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/) for service-specific networking guidance.
+
+[^3]: For example, [aiohttp client advanced topics](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support), [Requests proxies](https://requests.readthedocs.io/en/latest/user/advanced/#proxies), and [HTTPX proxies](https://www.python-httpx.org/advanced/proxies/).
From 0c2692372d41e9c219aeeb90645648858492c9db Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Thu, 9 Apr 2026 09:01:39 -0700
Subject: [PATCH 05/27] Edits
---
site/developer/_sidebar.yaml | 4 +-
.../use-http-proxy-with-validmind-library.qmd | 38 ++++++++++---------
2 files changed, 23 insertions(+), 19 deletions(-)
diff --git a/site/developer/_sidebar.yaml b/site/developer/_sidebar.yaml
index 758c7187d9..6456483182 100644
--- a/site/developer/_sidebar.yaml
+++ b/site/developer/_sidebar.yaml
@@ -22,9 +22,9 @@ website:
file: developer/model-documentation/install-and-initialize-validmind-library.qmd
- text: "Install and initialize the library for R"
file: developer/model-documentation/install-and-initialize-validmind-for-r.qmd
+ - text: "Use an HTTP proxy with the library"
+ file: developer/model-documentation/use-http-proxy-with-validmind-library.qmd
- developer/model-documentation/store-credentials-in-env-file.qmd
- - text: "Use an HTTP proxy with the library"
- file: developer/model-documentation/use-http-proxy-with-validmind-library.qmd
- text: "---"
- text: "End-to-End Tutorials"
# USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
diff --git a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
index 39b188e961..df0f1cb8fa 100644
--- a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
+++ b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
@@ -12,11 +12,11 @@ listing:
fields: [title, description]
grid-columns: 2
contents:
- - ../how-to/testing-overview.qmd
- - ../how-to/feature-overview.qmd
+ - ../../notebooks/quickstart/quickstart_model_documentation.ipynb
+ - ../../notebooks/quickstart/quickstart_model_validation.ipynb
---
-The {{< var validmind.developer >}} does not provide a `proxy` argument on `vm.init()`. Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clients that honor proxy-related environment variables, which lets you work behind corporate or regional proxies without custom library configuration.
+Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clients that honor proxy-related environment variables, which lets you work behind corporate or regional proxies without custom library configuration.
::: {.attn}
@@ -28,7 +28,21 @@ The {{< var validmind.developer >}} does not provide a `proxy` argument on `vm.i
:::
-## 1. Set proxy environment variables
+## What do I need to know?
+
+### Underlying behavior
+
+The {{< var validmind.developer >}} does not provide a `proxy` argument on `vm.init()`: proxy handling is implemented by the underlying HTTP stacks (including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients). Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version.
+
+If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^2]
+
+### Other outbound traffic
+
+Features that generate text with OpenAI or Azure OpenAI use those vendors’ Python SDKs. Those clients usually respect the same `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` values, but authentication, regional endpoints, and enterprise policies can add requirements.
+
+Consult your provider’s documentation when something works for the ValidMind API but not for LLM calls.[^3]
+
+## Step 1: Set proxy environment variables
Set the variables **before** you start the Python process or Jupyter kernel so the process inherits them when the library opens HTTP connections.
@@ -51,20 +65,10 @@ export NO_PROXY=localhost,127.0.0.1,.corp.example.com
If your organization assigns these values automatically when you log in, confirm they are visible in the same environment where you launch Jupyter or your IDE.
-## 2. Restart your notebook or Python session
+## Step 2: Restart your notebook or Python session
If you change proxy variables after a session has already started, restart the kernel or Python interpreter so every library reload sees the updated environment.
-## What do I need to know?
-
-### Other outbound traffic
-
-Features that generate text with OpenAI or Azure OpenAI use those vendors’ Python SDKs. Those clients usually respect the same `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` values, but authentication, regional endpoints, and enterprise policies can add requirements. Consult your provider’s documentation when something works for the ValidMind API but not for LLM calls.[^2]
-
-### Underlying behavior
-
-Proxy handling is implemented by the underlying HTTP stacks (including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients). Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version. If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^3]
-
## Troubleshooting
- You see connection timeouts or “connection refused” when calling `vm.init()` or logging results — verify `HTTPS_PROXY` matches your proxy URL and that the host running Python can reach the proxy host and port.
@@ -81,6 +85,6 @@ Proxy handling is implemented by the underlying HTTP stacks (including aiohttp a
[^1]: If you have not installed the library yet, start with [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd).
-[^2]: See for example [OpenAI](https://platform.openai.com/docs/guides/production-best-practices) and [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/) for service-specific networking guidance.
+[^2]: For example, [aiohttp client advanced topics](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support), [Requests proxies](https://requests.readthedocs.io/en/latest/user/advanced/#proxies), and [HTTPX proxies](https://www.python-httpx.org/advanced/proxies/).
-[^3]: For example, [aiohttp client advanced topics](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support), [Requests proxies](https://requests.readthedocs.io/en/latest/user/advanced/#proxies), and [HTTPX proxies](https://www.python-httpx.org/advanced/proxies/).
+[^3]: See for example [OpenAI](https://platform.openai.com/docs/guides/production-best-practices) and [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/) for service-specific networking guidance.
From 49289d7acdb413e3d857bc1404e68376a9da516c Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Thu, 9 Apr 2026 13:24:41 -0700
Subject: [PATCH 06/27] docs: View, sort, and filter workflows (#1273)
* Edit
* wip
* Edit: Workflow step types
* Edit: Confitional requirements
* Glossary fix
* Fixing About library & platform page
* Fixing a broken breadcrumb
* Edit: Configure workflows
* proofread
* Setting up workflows: +View, sort, and filter workflows
* Proofread
* Edit: John's suggestions
---
site/about/glossary/_models.qmd | 23 +++++++++-
site/about/glossary/glossary.qmd | 2 +
.../about/glossary/key_concepts/_template.qmd | 36 +++++++++++++++
site/about/library-and-platform.qmd | 42 +----------------
site/about/overview.qmd | 3 +-
site/guide/workflows/_add-new-workflows.qmd | 16 ++++---
.../workflows/_conditional-requirements.qmd | 13 ++++--
site/guide/workflows/_workflow-step-types.qmd | 46 +++++++++++--------
site/guide/workflows/configure-workflows.qmd | 29 +++++-------
site/guide/workflows/manage-workflows.qmd | 2 +-
site/guide/workflows/setting-up-workflows.qmd | 41 +++++++++++++++++
site/guide/workflows/transition-workflows.qmd | 2 +-
12 files changed, 165 insertions(+), 90 deletions(-)
diff --git a/site/about/glossary/_models.qmd b/site/about/glossary/_models.qmd
index d6c493c1eb..ca9a222101 100644
--- a/site/about/glossary/_models.qmd
+++ b/site/about/glossary/_models.qmd
@@ -12,8 +12,29 @@ model development
{{< include key_concepts/_docs.qmd >}}
+
+
+:::: {.content-visible when-format="html" when-meta="includes.glossary"}
model inventory^[**Refer also to:** [{{< var vm.product >}} model inventory](./glossary.qmd#platform-model-inventory)]
-: A systematic and organized record of all quantitative and qualitative models used within an organization. This inventory facilitates oversight, tracking, and assessment by listing each model's purpose, characteristics, owners, validation status, and associated risks.
+: A systematic and organized record of all quantitative and qualitative models used within an organization. This inventory facilitates oversight, tracking, and assessment by listing each model's purpose, characteristics, owners, validation status, and associated risks.
+
+::::
+
+
+
+:::: {.content-visible when-format="html" unless-meta="includes.glossary"}
+model inventory
+: A systematic and organized record of all quantitative and qualitative models used within an organization. This inventory facilitates oversight, tracking, and assessment by listing each model's purpose, characteristics, owners, validation status, and associated risks.
+
+::::
model lifecycle
: Subset of stages defining the lifecycle of a model; encompasses all steps for operating, governing, and maintaining a model until it is decommissioned (model development, model validation, model approval, model implementation, retirement).
diff --git a/site/about/glossary/glossary.qmd b/site/about/glossary/glossary.qmd
index 7dc163ae7a..cbf0c8ab03 100644
--- a/site/about/glossary/glossary.qmd
+++ b/site/about/glossary/glossary.qmd
@@ -5,6 +5,8 @@
title: "Glossary"
date: last-modified
toc-depth: 4
+includes:
+ glossary: true
---
+
+
+:::: {.content-visible when-format="html" when-meta="includes.glossary"}
document template
: Lays out the structure of model documents, segmented into various sections and sub-sections, and function as test suites to help automate your development, validation, monitoring, and other risk management processes. Document templates are available for default {{< var vm.product >}} document types[^default-documents] as well as custom document types.
@@ -14,8 +21,33 @@ document template
monitoring template, monitoring report template^[**Refer also to:** [Ongoing monitoring](/about/glossary/glossary.qmd#ongoing-monitoring)]
: A default {{< var vm.product >}} document type that serves as a standardized framework for ongoing model monitoring, including sections designated for test results, performance metrics, and drift analyses. By outlining required monitoring checks and expected routine tests, monitoring templates ensure consistency and completeness across monitoring reports and help guide model owners through a systematic monitoring process while promoting early detection of model performance degradation.
+::::
+
+
+
+:::: {.content-visible when-format="html" unless-meta="includes.glossary"}
+document template
+: Lays out the structure of model documents, segmented into various sections and sub-sections, and function as test suites to help automate your development, validation, monitoring, and other risk management processes. Document templates are available for default {{< var vm.product >}} document types as well as custom document types.
+
+documentation template
+: A default {{< var vm.product >}} document type that serves as a standardized framework for developing and documenting models, including sections designated for model details, data descriptions, test results, and performance metrics. By outlining required documentation and recommended analyses, document templates ensure consistency and completeness across model documentation and help guide developers through a systematic development process while promoting comparability and traceability of development outcomes.
+
+validation report template
+: A default {{< var vm.product >}} document type that serves as a standardized framework for conducting and documenting model validation, including sections designated for attaching test results, evidence, or artifacts (findings). By outlining required documentation, recommended analyses, and expected validation tests, validation report templates ensure consistency and completeness across validation reports and help guide validators through a systematic review process while promoting comparability and traceability of validation outcomes.
+
+monitoring template, monitoring report template
+: A default {{< var vm.product >}} document type that serves as a standardized framework for ongoing model monitoring, including sections designated for test results, performance metrics, and drift analyses. By outlining required monitoring checks and expected routine tests, monitoring templates ensure consistency and completeness across monitoring reports and help guide model owners through a systematic monitoring process while promoting early detection of model performance degradation.
+
+::::
+
+
+:::: {.content-visible when-format="html" when-meta="includes.glossary"}
[^default-documents]:
Default {{< var vm.product >}} document type templates:
@@ -24,3 +56,7 @@ document template
- [validation report template](#validation-report-template)
- [monitoring template](#monitoring-template)
+::::
+
+
+
diff --git a/site/about/library-and-platform.qmd b/site/about/library-and-platform.qmd
index 473d8f18d3..7f776107c8 100644
--- a/site/about/library-and-platform.qmd
+++ b/site/about/library-and-platform.qmd
@@ -52,44 +52,4 @@ The *{{< var validmind.platform >}}* is an easy-to-use web-based interface that
## Product highlights
:::{#library-and-platform}
-:::
-
-
-
-
-
- B[Initial
validation]
- B --> C[Validation
approval]
- C --> D[In production]
- D --> E[Periodic review
and revalidation]
- E --> B
-```
--->
-
-
-
-
-
-
+:::
\ No newline at end of file
diff --git a/site/about/overview.qmd b/site/about/overview.qmd
index 54a938ad41..8b1ef72853 100644
--- a/site/about/overview.qmd
+++ b/site/about/overview.qmd
@@ -2,7 +2,8 @@
# Copyright © 2023-2026 ValidMind Inc. All rights reserved.
# Refer to the LICENSE file in the root of this repository for details.
# SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
-title: "About {{< var vm.product >}}"
+# USING THE VARIABLE IN THE TITLE MESSES UP THE BREADCRUMB
+title: "About ValidMind"
date: last-modified
listing:
- id: use-cases
diff --git a/site/guide/workflows/_add-new-workflows.qmd b/site/guide/workflows/_add-new-workflows.qmd
index ed4bc66476..a13c05b965 100644
--- a/site/guide/workflows/_add-new-workflows.qmd
+++ b/site/guide/workflows/_add-new-workflows.qmd
@@ -9,10 +9,12 @@ To add a new blank workflow:
1. Under {{< fa shield >}} Governance, select **Workflows**.
-1. Select the tab for the type of workflow to add:
+1. Click **{{< fa plus >}} Add Workflow**.
- - **Model Workflows** — Workflows that apply to models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)]
- - **Artifact Workflows** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)]
+1. Select the [workflow target]{.smallcaps} type to add:
+
+ - **Inventory Model** — Workflows that apply to models in your inventory.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)]
+ - **Artifact** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)]
::: {.panel-tabset}
@@ -86,10 +88,12 @@ a. Click **Add Artifact Workflow** to save your blank workflow, and then [config
1. Under {{< fa shield >}} Governance, select **Workflows**.
-1. Select the tab for the type of workflow to add:
+1. Click **{{< fa plus >}} Add Workflow**.
+
+1. Select the [workflow target]{.smallcaps} type to add:
- - **Model Workflows** — Workflows that apply to models in your inventory.
- - **Artifact Workflows** — Workflows that apply to logged artifacts.
+ - **Inventory Model** — Workflows that apply to models in your inventory.
+ - **Artifact** — Workflows that apply to logged artifacts.
#### Add Model Workflows
diff --git a/site/guide/workflows/_conditional-requirements.qmd b/site/guide/workflows/_conditional-requirements.qmd
index 95257ad888..3faacf4cda 100644
--- a/site/guide/workflows/_conditional-requirements.qmd
+++ b/site/guide/workflows/_conditional-requirements.qmd
@@ -28,9 +28,9 @@ Conditional requirements are required or optional for the following step types:^
- Click **{{< fa plus >}} Add Rule** to add an independent rule.
- Click **{{< fa plus-minus >}} Add Group** to add a linked group of rules that all must be true to qualify.
-#### Request model inventory fields
+#### Request model or artifact fields
-- Select any **[requested fields]{.smallcaps}**^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)] to be entered by users during the action.
+- Select any **[requested fields]{.smallcaps}**[^request-fields] to be entered by users during the action.
**Toggle Optional** to ON if the field should be optional and not required.
@@ -103,11 +103,11 @@ Set the **[wait duration]{.smallcaps}** in minutes, hours, or days.
Set a time to **[wait until]{.smallcaps}** as defined by a specific timestamp.
-#### At Specified Date on Model Field
+#### At Specified Date on Custom Field
Set the **[model field]{.smallcaps}**^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis.
-##### Time Delta from Specified Date on Model Field
+#### Time Delta from Specified Date on Custom Field
a. Set the **[model field]{.smallcaps}**^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type model inventory field that defines the specific timestamp on a per model basis.
@@ -154,6 +154,11 @@ Enter in optional headers to include with your request:
::::
+[^request-fields]:
+
+ - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
+ - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)
+
:::: {.content-hidden unless-format="revealjs"}
diff --git a/site/guide/workflows/_workflow-step-types.qmd b/site/guide/workflows/_workflow-step-types.qmd
index dded8cef05..1d34ce2663 100644
--- a/site/guide/workflows/_workflow-step-types.qmd
+++ b/site/guide/workflows/_workflow-step-types.qmd
@@ -36,7 +36,7 @@ Creates a button that performs an action on behalf of the user.
|---:|---|
| [display action button when]{.smallcaps} (optional) | Add conditional requirements for displaying this step.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#user-action)] |
| [action button label]{.smallcaps} | Text that displays on your action button. |
-| [requested fields]{.smallcaps} (optional) | Include inventory fields alongside your action.[^step-types-1] |
+| [requested fields]{.smallcaps} (optional) | Include model or artifact fields alongside your action.[^user-action] |
| [user action deadline]{.smallcaps} (optional) | Include a deadline for when users should complete this action by.^[Toggle **Enable deadline** on to configure a deadline.] |
: **{{< fa arrow-pointer >}} User Action** step configuration {.hover tbl-colwidths="[40,60]"}
@@ -46,12 +46,12 @@ Creates a button that performs an action on behalf of the user.
Display a preconfigured message to users in the selected **[approval group]{.smallcaps}**.
- Select from either **User Roles**, **Model Stakeholder Types**, or either **User Role** or **User Type** inventory field.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#approval-required)]
-- Must be connected to both a rejection and approval {{< fa cube >}} Model Stage Change step.[^step-types-2]
+- Must be connected to both a rejection and approval {{< fa cube >}} Model Stage Change step.[^approval-1]
| Field | Description |
|---:|---|
| [approval group]{.smallcaps} | Select the roles, stakeholders, or user fields responsible for approval. |
-| [fields to review]{.smallcaps} (optional) | Select the model inventory fields shown to approvers for read-only review. |
+| [fields to review]{.smallcaps} (optional) | Select the model or artifact fields shown to approvers for read-only review.[^approval-2] |
| Approval Message | When your workflow reaches this {{< fa users >}} Approval step, the selected [approval group]{.smallcaps} is shown this message.^[Enter in a **[title]{.smallcaps}** and a **[message]{.smallcaps}** to display.] |
: **{{< fa users >}} Approval** step configuration {.hover tbl-colwidths="[35,65]"}
@@ -64,8 +64,8 @@ Display a preconfigured message to users in the selected **[approval group]{.sma
| Field | Description |
|---:|---|
| Select roles | Select the **Model Stakeholder Types** or **User Roles** to receive the email. |
-| [subject]{.smallcaps} | Enter the subject of the email. |
-| [message]{.smallcaps} | Enter the body of the email.[^step-types-3] |
+| [subject]{.smallcaps} | Enter the subject of the email.[^broadcast] |
+| [message]{.smallcaps} | Enter the body of the email. |
: **{{< fa bullhorn >}} Broadcast** step configuration {.hover tbl-colwidths="[25,75]"}
### {{< fa maximize >}} Condition Branch
@@ -104,10 +104,10 @@ To configure a wait step, select when you would like to [resume workflow]{.small
| Option | Required field(s) | Description |
|---:|---|---|
-| After Time Interval | [wait duration]{.smallcaps} | Wait for a set amount of time. Applies to all models under the workflow. |
-| At Specified Date | [wait until]{.smallcaps} | Wait until a specific timestamp. Applies to all models under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. |
-| At Specified Date on Model Field | [model field]{.smallcaps}^[[Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)] | Wait until a specific timestamp as defined by a model inventory field on a per model basis. If the selected field is empty^[Make model inventory fields **[required when creating models]{.smallcaps}** to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. |
-| Time Delta from Specified Date on Model Field | [model field]{.smallcaps}, [time delta direction]{.smallcaps}, [wait duration]{.smallcaps} | Wait for a calculated time relative to a date in a model field on a per model basis. If the selected field is empty^[Make model inventory fields **[required when creating models]{.smallcaps}** to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. |
+| After Time Interval | [wait duration]{.smallcaps} | Wait for a set amount of time. Applies to all models or artifacts under the workflow. |
+| At Specified Date | [wait until]{.smallcaps} | Wait until a specific timestamp. Applies to all models or artifacts under the workflow. If the milestone date inputted is in the past, the next workflow step will display immediately. |
+| At Specified Date on Custom Field | [custom field]{.smallcaps}[^wait] | Wait until a specific timestamp as defined by a model or artifact field on a per model or per artifact basis. If the selected field is empty^[Make model or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. |
+| Time Delta from Specified Date on Custom Field | [custom field]{.smallcaps}, [time delta direction]{.smallcaps}, [wait duration]{.smallcaps} | Wait for a calculated time relative to a date in a model or artifact field on a per model or per artifact basis. If the selected field is empty^[Make model or artifact fields required on registration to ensure necessary fields have valid values.] or the milestone date inputted is in the past, the next workflow step will display immediately. |
: **{{< fa clock >}} Wait** step configuration {.hover tbl-colwidths="[30,15,45]"}
### {{< fa arrow-right-arrow-left >}} Run Workflow
@@ -172,25 +172,35 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem
-[^step-types-1]:
+[^user-action]:
- - Select from the drop-down to add it to your User Action step.
- - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
-
- Users must have write permissions for the field in order to enter values.
+ Select from the drop-down to add it to your User Action step. Users must have write permissions for the field in order to enter values.
+
+ - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
+ - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)
-[^step-types-2]: **[Configure workflows](/guide/workflows/configure-workflows.qmd#create-custom-workflows):**
+[^approval-1]: **[Configure workflows](/guide/workflows/configure-workflows.qmd#create-custom-workflows):**
1. Configure two **{{< fa cube >}} Model Stage Change** steps for your associated rejection and approval stages.
2. Then, from the bottom of your **{{< fa users >}} Approval** step:
a. Connect the left [**{{< fa circle >}}**]{.red} (red) to your rejection step.
b. Connect the right [**{{< fa circle >}}**]{.green} (green) to your approval step.
-[^step-types-3]: Use the rich text editor to compose your message:
+[^approval-2]:
+
+ - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd)
+ - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)
+
+[^broadcast]: Use the rich text editor to compose your **[subject]{.smallcaps}** and **[message]{.smallcaps}**:
+
+ 1. Include optional details about the model or artifact the workflow is running on using the **{ } Insert Variable** drop-down.
+ 2. Click on the **Preview** tab and choose a model or artifact under **[select {model/artifact} for preview]{.smallcaps}** to confirm how the notification will appear when rendered.
+
+[^wait]:
- 1. Include optional details about the model the workflow is running on using the **{ } Insert Variable** drop-down.
- 2. Click on the **Preview** tab and choose a model under **[select model for preview]{.smallcaps}** to confirm how the notification will appear when rendered.
+ - [Manage model inventory fields](/guide/model-inventory/manage-model-inventory-fields.qmd#inventory-field-types)
+ - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types)
[^request-types]: `PUT` and `POST` requests have additional configuration fields:
diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd
index 5cfbaaafba..22609a3427 100644
--- a/site/guide/workflows/configure-workflows.qmd
+++ b/site/guide/workflows/configure-workflows.qmd
@@ -52,20 +52,13 @@ To create a copy of an existing workflow:
1. In the left sidebar, click **{{< fa gear >}} Settings**.
-2. Under {{< fa shield >}} Governance, select **Workflows**.
-
-3. Select the tab for the type of workflow to clone:
-
- - **Model Workflows** — Workflows that apply to models in your inventory.[^3]
- - **Artifact Workflows** — Workflows that apply to logged artifacts.[^4]
+2. Hover over the workflow you'd like to clone.[^3]
-4. Hover over the workflow you'd like to clone.
+3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa copy >}} Clone Workflow**.
-5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa copy >}} Clone Workflow**.
+4. Make your changes to the workflow's **[title]{.smallcaps}** and **[workflow type]{.smallcaps}**.
-6. Make your changes to the workflow's **[title]{.smallcaps}** and **[workflow type]{.smallcaps}**.
-
- Additional changes can be made to the cloned workflow after cloning by editing.[^5]
+ Additional changes can be made to the cloned workflow after cloning by editing.[^4]
## Edit existing workflows
@@ -87,7 +80,7 @@ You can edit a workflow in several ways:
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.
+3. Click on the workflow you'd like to modify to edit the configuration for that workflow.[^5]
#### Via workflows applied to models
@@ -153,9 +146,9 @@ Deleting workflow steps on workflows active on models may result in malfunctioni
2. Under {{< fa shield >}} Governance, select **Workflows**.
-3. Hover over the workflow you would like to remove.
+3. Hover over the workflow you would like to remove.[^11]
-3. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa trash-can >}} Delete Workflow**.
+4. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa trash-can >}} Delete Workflow**.
5. Click **Yes, Delete Workflow** to permanently remove that workflow and make it inaccessible for any future runs.
@@ -171,11 +164,11 @@ Deleting workflow steps on workflows active on models may result in malfunctioni
[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
-[^3]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
+[^3]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows)
-[^4]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)
+[^4]: If a cloned workflow's [workflow start]{.smallcaps} trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead.
-[^5]: If a cloned workflow's [workflow start]{.smallcaps} trigger conflicts with an existing workflow, the cloned workflow will be set to manual initiation instead.
+[^5]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows)
[^6]: [Manage workflows](/guide/workflows/manage-workflows.qmd#update-workflow-versions)
@@ -187,3 +180,5 @@ Deleting workflow steps on workflows active on models may result in malfunctioni
[^10]: [Link workflow together](#link-workflow-together)
+[^11]: [Setting up workflows](setting-up-workflows.qmd#view-sort-and-filter-workflows)
+
diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd
index b92ba7d702..a0dae5f127 100644
--- a/site/guide/workflows/manage-workflows.qmd
+++ b/site/guide/workflows/manage-workflows.qmd
@@ -8,7 +8,7 @@ aliases:
- /guide/model-workflows/manage-model-workflows.html
---
-Review workflows associated with your models, and initiate or abort workflows configured for your organization on your models.
+Review workflows associated with your models or artifacts, and initiate or abort workflows configured for your organization on your models or artifacts.
::: {.attn}
diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd
index 0c5554c5a5..56e91b25aa 100644
--- a/site/guide/workflows/setting-up-workflows.qmd
+++ b/site/guide/workflows/setting-up-workflows.qmd
@@ -20,6 +20,47 @@ aliases:
{{< include /guide/workflows/_set-up-workflows.qmd >}}
+## View, sort, and filter workflows
+
+To view workflows set up for your organization:
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa shield >}} Governance, select **Workflows**.
+
+3. Sort and filter the list of workflows to narrow down results:
+
+::: {.panel-tabset}
+
+### Sort workflows
+
+Click on any column header to sort the list of workflows by that column:
+
+ - Click **{{< fa angle-up >}}** to sort by ascending order.
+ - Click **{{< fa angle-down >}}** to sort by descending order.
+
+### Filter workflows
+
+Click **{{< fa filter >}} Filter** to filter for workflows using different [workflow fields]{.smallcaps}:
+
+ - **Target Type** — The subcategory of workflow target. For example: Validation Issue (artifact workflow)
+ - **Trigger** — The type of trigger that initiates the workflow.
+ - **Workflow Target** — The type of workflow: Artifact, Inventory Model
+
+
+
+::: {.callout-button .pl4 .nt4}
+::: {.callout collapse="true" appearance="minimal"}
+### How do I create effective filters?
+
+{{< include /guide/shared/_work-with-filters.qmd >}}
+:::
+:::
+
+:::
+
+## Set up workflows
+
:::{#workflow-setup}
:::
diff --git a/site/guide/workflows/transition-workflows.qmd b/site/guide/workflows/transition-workflows.qmd
index aa6a82e73f..2e49744b0f 100644
--- a/site/guide/workflows/transition-workflows.qmd
+++ b/site/guide/workflows/transition-workflows.qmd
@@ -8,7 +8,7 @@ aliases:
- /guide/model-workflows/transition-model-workflows.html
---
-Transition a model's workflow into its next state, or reset a workflow on a model.
+Transition a model's or artifact's workflow into its next state, or reset a workflow on a model or artifact.
::: {.attn}
From 77712011afe64aae6a6f83f8457ad84bf0c0ec39 Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Thu, 9 Apr 2026 15:09:22 -0700
Subject: [PATCH 07/27] Address review comments from Spencer
---
.../use-http-proxy-with-validmind-library.qmd | 17 ++++++++++++-----
site/support/troubleshooting.qmd | 2 +-
2 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
index df0f1cb8fa..0ae6f75d72 100644
--- a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
+++ b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
@@ -55,6 +55,10 @@ Common variables:
| `ALL_PROXY` | Fallback when a scheme-specific variable is not set (behavior depends on the client library). |
| `NO_PROXY` | Comma-separated hostnames, domains, or IP ranges that should **not** use the proxy (for example `localhost`, `127.0.0.1`, or an internal API hostname). |
+::: {.callout}
+Many tools and Linux environments use lowercase names instead: `http_proxy`, `https_proxy`, and `no_proxy`. On Unix-like systems, Python and common HTTP clients often treat uppercase and lowercase as equivalent for these variables, but some scripts or containers only read one convention. Use the names your organization or image already exports, or standardize on a single case for your team.
+:::
+
Example for a POSIX shell:
```bash
@@ -71,9 +75,10 @@ If you change proxy variables after a session has already started, restart the k
## Troubleshooting
-- You see connection timeouts or “connection refused” when calling `vm.init()` or logging results — verify `HTTPS_PROXY` matches your proxy URL and that the host running Python can reach the proxy host and port.
-- Traffic should bypass the proxy for a specific API host — add that host or domain to `NO_PROXY` and restart the session.
-- Variables do not appear to apply — in a notebook, run `import os` and `print(os.environ.get("HTTPS_PROXY"))` in a fresh cell after restart; if it is empty, the variables were not set for that process (for example, they were only set in a different terminal).
+- If you see SSL or certificate verification errors when calling `vm.init()` behind a proxy: refer to our troubleshooting guide.[^4]
+- If you see connection timeouts or “connection refused” when calling `vm.init()` or logging results: verify `HTTPS_PROXY` matches your proxy URL and that the host running Python can reach the proxy host and port.
+- If traffic should bypass the proxy for a specific API host: add that host or domain to `NO_PROXY` and restart the session.
+- If variables do not appear to apply: in a notebook, run `import os` and `print(os.environ.get("HTTPS_PROXY"))` in a fresh cell after restart; if it is empty, the variables were not set for that process (for example, they were only set in a different terminal).
## What's next
@@ -85,6 +90,8 @@ If you change proxy variables after a session has already started, restart the k
[^1]: If you have not installed the library yet, start with [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd).
-[^2]: For example, [aiohttp client advanced topics](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support), [Requests proxies](https://requests.readthedocs.io/en/latest/user/advanced/#proxies), and [HTTPX proxies](https://www.python-httpx.org/advanced/proxies/).
+[^2]: For example, refer to [aiohttp client advanced topics](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support), [Requests proxies](https://requests.readthedocs.io/en/latest/user/advanced/#proxies), and [HTTPX proxies](https://www.python-httpx.org/advanced/proxies/).
+
+[^3]: For example, refer to [OpenAI](https://platform.openai.com/docs/guides/production-best-practices) and [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/) for service-specific networking guidance.
-[^3]: See for example [OpenAI](https://platform.openai.com/docs/guides/production-best-practices) and [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/) for service-specific networking guidance.
+[^4]: Refer to [SSL verification errors when initializing the library](/support/troubleshooting.qmd#ssl-verification-when-initializing-library).
diff --git a/site/support/troubleshooting.qmd b/site/support/troubleshooting.qmd
index fcc7e31a45..22427e52a6 100644
--- a/site/support/troubleshooting.qmd
+++ b/site/support/troubleshooting.qmd
@@ -68,7 +68,7 @@ Make sure that you are using the correct initialization credentials for the mode
Follow the steps in [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd) for detailed instructions on how to integrate the {{< var vm.developer >}} and upload to the {{< var vm.platform >}}.
-## SSL verification errors when initializing the {{< var validmind.developer >}}
+## SSL verification errors when initializing the {{< var validmind.developer >}} {#ssl-verification-when-initializing-library}
### Issue
From 9142859234182f7b324f5feeeda326a1568db2cc Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Thu, 9 Apr 2026 16:38:19 -0700
Subject: [PATCH 08/27] Edit
---
.../use-http-proxy-with-validmind-library.qmd | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
index 0ae6f75d72..ce0ab5755b 100644
--- a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
+++ b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
@@ -32,7 +32,7 @@ Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clien
### Underlying behavior
-The {{< var validmind.developer >}} does not provide a `proxy` argument on `vm.init()`: proxy handling is implemented by the underlying HTTP stacks (including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients). Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version.
+The {{< var validmind.developer >}} does not provide a way to set a proxy on `vm.init()`. Instead, proxy handling is implemented by the underlying HTTP stacks, including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients. Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version.
If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^2]
From 89fc680541bf083fef7229efa9263aebab8814dc Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Thu, 9 Apr 2026 17:23:02 -0700
Subject: [PATCH 09/27] Final edits
---
.../use-http-proxy-with-validmind-library.qmd | 30 ++++++++++---------
1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
index ce0ab5755b..233e18aae8 100644
--- a/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
+++ b/site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd
@@ -24,7 +24,7 @@ Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clien
- [x] {{< var link.login >}}
- [x] You can set environment variables for the user or service account that runs Python or Jupyter.[^1]
-- [x] You have proxy connection details from your network administrator (host, port, and authentication rules if required).
+- [x] You have proxy connection details from your network administrator, such as the host, port, and authentication rules.
:::
@@ -32,34 +32,38 @@ Outbound HTTPS traffic to the ValidMind API relies on standard Python HTTP clien
### Underlying behavior
-The {{< var validmind.developer >}} does not provide a way to set a proxy on `vm.init()`. Instead, proxy handling is implemented by the underlying HTTP stacks, including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients. Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version.
+Proxy handling is implemented by the underlying HTTP stacks, including aiohttp and requests for ValidMind API traffic, and httpx in some third-party clients. The {{< var validmind.developer >}} itself does not provide a way to set a proxy on `vm.init()`.
-If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^2]
+Precedence between `ALL_PROXY` and scheme-specific variables, and exact `NO_PROXY` matching rules, can vary by library version. If results differ from what you expect, refer to the documentation for those libraries or your HTTP client.[^2]
### Other outbound traffic
-Features that generate text with OpenAI or Azure OpenAI use those vendors’ Python SDKs. Those clients usually respect the same `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` values, but authentication, regional endpoints, and enterprise policies can add requirements.
+Features that generate text with OpenAI or Azure OpenAI use the Python SDKs provided by those vendors. These clients usually respect the same `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` values, but authentication, regional endpoints, and enterprise policies can add requirements.
Consult your provider’s documentation when something works for the ValidMind API but not for LLM calls.[^3]
## Step 1: Set proxy environment variables
-Set the variables **before** you start the Python process or Jupyter kernel so the process inherits them when the library opens HTTP connections.
+Set the variables before you start the Python process or Jupyter kernel, so that the process inherits them when the library opens HTTP connections.
-Common variables:
+Common variables include:
| Variable | Purpose |
|----------|---------|
| `HTTP_PROXY` | Proxy URL for `http` requests. |
-| `HTTPS_PROXY` | Proxy URL for `https` requests (typical for the ValidMind API). |
-| `ALL_PROXY` | Fallback when a scheme-specific variable is not set (behavior depends on the client library). |
-| `NO_PROXY` | Comma-separated hostnames, domains, or IP ranges that should **not** use the proxy (for example `localhost`, `127.0.0.1`, or an internal API hostname). |
+| `HTTPS_PROXY` | Proxy URL for `https` requests typically used for the ValidMind API. |
+| `ALL_PROXY` | Fallback when a scheme-specific variable is not set. Behavior depends on the client library. |
+| `NO_PROXY` | Comma-separated hostnames, domains, or IP ranges that should NOT use the proxy. For example: `localhost`, `127.0.0.1`, or an internal API hostname. |
+
+Many tools and Linux environments use lowercase names, such as `http_proxy` or `https_proxy`. On Unix-like systems, Python and common HTTP clients often treat uppercase and lowercase as equivalent for these variables, but some scripts or containers only read one convention.
+
+If your organization assigns these values automatically when you log in, confirm they are visible in the same environment where you launch Jupyter or your IDE.
::: {.callout}
-Many tools and Linux environments use lowercase names instead: `http_proxy`, `https_proxy`, and `no_proxy`. On Unix-like systems, Python and common HTTP clients often treat uppercase and lowercase as equivalent for these variables, but some scripts or containers only read one convention. Use the names your organization or image already exports, or standardize on a single case for your team.
+**Tip**: Use the names your organization or image already exports, or standardize on a single case for your team.
:::
-Example for a POSIX shell:
+### Example for a POSIX shell
```bash
export HTTPS_PROXY=http://proxy.example.com:8080
@@ -67,11 +71,9 @@ export HTTP_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1,.corp.example.com
```
-If your organization assigns these values automatically when you log in, confirm they are visible in the same environment where you launch Jupyter or your IDE.
-
## Step 2: Restart your notebook or Python session
-If you change proxy variables after a session has already started, restart the kernel or Python interpreter so every library reload sees the updated environment.
+If you change proxy variables after a session has already started, restart the kernel or Python interpreter, so that every library reload sees the updated environment.
## Troubleshooting
From 36105e8eae329c793a655230e27f55f577afaab8 Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Fri, 10 Apr 2026 11:43:27 -0700
Subject: [PATCH 10/27] Start attestations FAQ & explain attestation visibility
before period starts
---
site/faq/_faq-attestations.qmd | 8 ++++++++
site/faq/faq-workflows.qmd | 11 +++++++++--
site/guide/attestation/working-with-attestations.qmd | 2 +-
3 files changed, 18 insertions(+), 3 deletions(-)
create mode 100644 site/faq/_faq-attestations.qmd
diff --git a/site/faq/_faq-attestations.qmd b/site/faq/_faq-attestations.qmd
new file mode 100644
index 0000000000..c29bb84f36
--- /dev/null
+++ b/site/faq/_faq-attestations.qmd
@@ -0,0 +1,8 @@
+
+
+## Why don't I see attestations in the Attestations area right after I create them?
+
+- The {{< fa clipboard-check >}} Attestations area and attestation period selectors only show _active_ or _past_ periods. If the only periods you have configured are _future-dated_ (start date in the future), nothing appears there until the _start date_ — this is expected behavior, not a configuration error.
+- After you configure attestation templates and periods,[^4] participants are notified when the period begins. For where to access the dashboard and how timing works, see Working with attestations.[^5]
diff --git a/site/faq/faq-workflows.qmd b/site/faq/faq-workflows.qmd
index 58ce301c58..df527cf44c 100644
--- a/site/faq/faq-workflows.qmd
+++ b/site/faq/faq-workflows.qmd
@@ -17,7 +17,8 @@ listing:
- ../guide/workflows/working-with-workflows.qmd
- ../guide/workflows/manage-model-stages.qmd
- ../guide/model-inventory/manage-model-inventory-fields.qmd
-categories: ["workflows", "model lifecycle", "lifecycle statuses", "validmind platform", "validmind library"]
+ - ../guide/attestation/working-with-attestations.qmd
+categories: ["workflows", "model lifecycle", "lifecycle statuses", "attestations", "validmind platform", "validmind library"]
---
## Can I customize workflows within {{< var vm.product >}}?
@@ -49,6 +50,8 @@ Yes, {{< var vm.product >}} supports disconnected workflows natively at the data
You do not need to use the {{< var validmind.platform >}} while you are in the exploration or R&D phase of model development.
:::
+{{< include _faq-attestations.qmd >}}
+
{{< include _faq-tracking.qmd >}}
## Learn more
@@ -63,4 +66,8 @@ You do not need to use the {{< var validmind.platform >}} while you are in the e
[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
-[^3]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd)
\ No newline at end of file
+[^3]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd)
+
+[^4]: [Manage attestations](/guide/attestation/manage-attestations.qmd)
+
+[^5]: [Working with attestations](/guide/attestation/working-with-attestations.qmd)
\ No newline at end of file
diff --git a/site/guide/attestation/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd
index 2863077e1a..af03ebab03 100644
--- a/site/guide/attestation/working-with-attestations.qmd
+++ b/site/guide/attestation/working-with-attestations.qmd
@@ -56,7 +56,7 @@ When an attestation period is active or has been completed in the past, **{{< fa
Attestation participants can also access their individual tasks via **{{< fa inbox >}} My Inbox** in the left sidebar, where tasks appear under the Tasks tab with the current attestation status.
::: {.callout-note}
-The Attestations sidebar item only appears when there is at least one active or completed attestation period. If your organization has not yet configured attestations, this option is not visible.
+The Attestations sidebar item only appears when there is at least one active or completed attestation period. If your organization has not yet configured attestations, this option is not visible. If you have configured attestations but every period has a _future_ start date, the Attestations area stays empty until the first period becomes active.
:::
### How does the attestation process work?
From 86e33ca6be49d527d52251007ca8f3d5f55939ab Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Fri, 10 Apr 2026 12:00:13 -0700
Subject: [PATCH 11/27] docs(attestation): tighten callout wording for sidebar
visibility
---
site/guide/attestation/working-with-attestations.qmd | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/site/guide/attestation/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd
index af03ebab03..25c1b9f0ca 100644
--- a/site/guide/attestation/working-with-attestations.qmd
+++ b/site/guide/attestation/working-with-attestations.qmd
@@ -56,7 +56,7 @@ When an attestation period is active or has been completed in the past, **{{< fa
Attestation participants can also access their individual tasks via **{{< fa inbox >}} My Inbox** in the left sidebar, where tasks appear under the Tasks tab with the current attestation status.
::: {.callout-note}
-The Attestations sidebar item only appears when there is at least one active or completed attestation period. If your organization has not yet configured attestations, this option is not visible. If you have configured attestations but every period has a _future_ start date, the Attestations area stays empty until the first period becomes active.
+The Attestations sidebar item appears only when there is _at least one_ active or completed attestation period. If your organization has not yet configured attestations, this option is not visible. If you have configured attestations but every period has a _future_ start date, the Attestations area stays empty until the first period becomes active.
:::
### How does the attestation process work?
From f3f0f7225c76c3d489ca8ea98d78cee205b3ca79 Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Fri, 10 Apr 2026 12:23:39 -0700
Subject: [PATCH 12/27] Add new export option, fix smallercaps placement
---
site/guide/reporting/export-documents.qmd | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/site/guide/reporting/export-documents.qmd b/site/guide/reporting/export-documents.qmd
index 9f89a276d9..786e2976d6 100644
--- a/site/guide/reporting/export-documents.qmd
+++ b/site/guide/reporting/export-documents.qmd
@@ -46,15 +46,16 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor
6. Configure what is exported in your document by checking off the relevant boxes:
- - [validation reports only]{.smallercaps .pink} Include compliance summary[^10]
- - [validation reports only]{.smallercaps .pink} Include validation guidelines information[^11]
- - [validation reports only]{.smallercaps .pink} Include validation guideline adherence details
+ - Include compliance summary[^10] [validation reports only]{.smallercaps .pink}
+ - Include validation guidelines information[^11] [validation reports only]{.smallercaps .pink}
+ - Include validation guideline adherence details [validation reports only]{.smallercaps .pink}
- Include comments left on document[^12]
+ - Include tables and figures appendix[^13] [development reports only]{.smallercaps .pink}
7. Choose your file format:
- - **DOCX**[^13] — To update the table of contents, click **Yes** when Word prompts you to update fields.
- - **PDF**[^14] — Your document will be exported as a PDF with formatting preserved. The table of contents and links are generated automatically.
+ - **DOCX**[^14] — To update the table of contents, click **Yes** when Word prompts you to update fields.
+ - **PDF**[^15] — Your document will be exported as a PDF with formatting preserved. The table of contents and links are generated automatically.
8. Click **{{< fa file-arrow-down >}} Download File** to download the file locally on your machine.
@@ -86,6 +87,8 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor
[^12]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting)
-[^13]: To update the table of contents, click **Yes** when Word prompts you to update fields.
+[^13]: If your organization [enabled numbered table and figure captions](/guide/configuration/managing-your-organization.qmd#numbered-table-and-figure-captions), this option adds an appendix that includes tables, charts, and figures that use captions in the document. If the organization setting is off, the checkbox cannot be selected.
-[^14]: Your document will be exported as a PDF with formatting preserved. The table of contents and links are generated automatically.
+[^14]: To update the table of contents, click **Yes** when Word prompts you to update fields.
+
+[^15]: Your document will be exported as a PDF with formatting preserved. The table of contents and links are generated automatically.
From f553ea6540053b1c7eab00f3ffb0b690bfdbbb12 Mon Sep 17 00:00:00 2001
From: Nik Richers
Date: Tue, 14 Apr 2026 08:50:23 -0700
Subject: [PATCH 13/27] Webhook secrets updates (#1282)
* Initial draft with edits
* Edits after testing
* Fix render warnings
---
.../glossary/integrations/_http-request.qmd | 2 +-
site/about/glossary/integrations/_secret.qmd | 2 +-
.../integrations/integrations-examples.qmd | 18 ++-
site/guide/integrations/manage-secrets.qmd | 112 ++++++++++++++++--
.../workflows/_conditional-requirements.qmd | 2 +
site/guide/workflows/_workflow-step-types.qmd | 2 +
6 files changed, 120 insertions(+), 18 deletions(-)
diff --git a/site/about/glossary/integrations/_http-request.qmd b/site/about/glossary/integrations/_http-request.qmd
index af44d81d66..eb89bdccca 100644
--- a/site/about/glossary/integrations/_http-request.qmd
+++ b/site/about/glossary/integrations/_http-request.qmd
@@ -3,5 +3,5 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
HTTP request
-: A workflow step that sends data from {{< var vm.product >}} to another service.
+: A workflow step that sends data from {{< var vm.product >}} to another service. Header values can reference webhook secrets using `{{secret:name}}` syntax to avoid storing credentials in plaintext.
diff --git a/site/about/glossary/integrations/_secret.qmd b/site/about/glossary/integrations/_secret.qmd
index 8c30197a58..fa7b702549 100644
--- a/site/about/glossary/integrations/_secret.qmd
+++ b/site/about/glossary/integrations/_secret.qmd
@@ -3,5 +3,5 @@ Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
secret
-: A credential that stores the API key, password, or token required by an external service for authentication.
+: A credential that stores the API key, password, or token required by an external service for authentication. There are two types: _integration secrets_ for authenticating persistent connections to external platforms, and _webhook secrets_ for authenticating outgoing HTTP Request steps in workflows via `{{secret:name}}` syntax.
diff --git a/site/guide/integrations/integrations-examples.qmd b/site/guide/integrations/integrations-examples.qmd
index 0622edcd9e..c8ed27c0f1 100644
--- a/site/guide/integrations/integrations-examples.qmd
+++ b/site/guide/integrations/integrations-examples.qmd
@@ -23,7 +23,7 @@ Adapt these usage examples for your own workflows or connections to interact wit
- [x] {{< var link.login >}}
- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure workflows.[^1]
- [x] You understand how to configure workflows and add steps to workflows.[^2]
-- [x] Secrets are configured for any external systems that require authentication.[^3]
+- [x] Secrets are configured for any external systems that require authentication: integration secrets for connections, webhook secrets for HTTP Request step headers.[^3]
- [x] Connections are configured for any external systems you plan to integrate with.[^4]
- [x] You have admin access to the external systems you plan to integrate with.
@@ -31,11 +31,11 @@ Adapt these usage examples for your own workflows or connections to interact wit
## Workflow examples
-These examples use HTTP request or webhooks to integrate with external systems:
+These examples use HTTP requests or webhooks to integrate with external systems:
-- An *HTTP request* step sends data from {{< var vm.product >}} to another service. A workflow can notify a partner tool when a model reaches a certain state or request an update in an external system. This pattern is useful when {{< var vm.product >}} owns the event and needs to push it outward.
+- An _HTTP request_ step sends data from {{< var vm.product >}} to another service. A workflow can notify a partner tool when a model reaches a certain state or request an update in an external system. This pattern is useful when {{< var vm.product >}} owns the event and needs to push it outward.
-- A *webhook* step does the opposite. Another system sends a POST request to start a {{< var vm.product >}} workflow or to continue a workflow that is paused while waiting for a webhook to continue. This lets external tools trigger actions inside {{< var vm.product >}} when an event occurs on their side.
+- A _webhook_ step does the opposite. Another system sends a POST request to start a {{< var vm.product >}} workflow or to continue a workflow that is paused while waiting for a webhook to continue. This lets external tools trigger actions inside {{< var vm.product >}} when an event occurs on their side.
### Create a Jira ticket
@@ -64,6 +64,11 @@ To create a Jira ticket when model validation requires attention:
- **[headers]{.smallcaps}** — Add:
- `Content-Type`: `application/json`
- `Authorization`: `Bearer {{Jira Personal Access Token}}`
+
+ ::: {.callout-tip title="Use webhook secrets for credentials"}
+ Instead of entering credentials in plaintext, use a webhook secret: `Bearer {{secret:jira_pat}}`. See [Manage secrets](manage-secrets.qmd#webhook-secrets).
+ :::
+
- **[body type]{.smallcaps}** — JSON
- **[body]{.smallcaps}** — Use the following JSON payload:
@@ -110,6 +115,11 @@ To create a ServiceNow incident when a data drift issue is detected during ongoi
- **[headers]{.smallcaps}** — Add:
- `Content-Type`: `application/json`
- `Authorization`: `Basic {{ServiceNow Credentials}}`
+
+ ::: {.callout-tip title="Use webhook secrets for credentials"}
+ Instead of entering credentials in plaintext, use a webhook secret: `Basic {{secret:servicenow_creds}}`. See [Manage secrets](manage-secrets.qmd#webhook-secrets).
+ :::
+
- **[body type]{.smallcaps}** — JSON
- **[body]{.smallcaps}** — Use the following JSON payload:
diff --git a/site/guide/integrations/manage-secrets.qmd b/site/guide/integrations/manage-secrets.qmd
index 744e00d53d..1b662bf52e 100644
--- a/site/guide/integrations/manage-secrets.qmd
+++ b/site/guide/integrations/manage-secrets.qmd
@@ -6,7 +6,7 @@ title: "Manage secrets"
date: last-modified
---
-Secrets centralize the credentials for your integrations so you can reference them in connection configurations.
+Secrets centralize the credentials for your integrations so you can reference them in connection configurations and HTTP Request workflow steps.
You store each secret once and then reuse it across supported integrations.
@@ -20,11 +20,15 @@ You store each secret once and then reuse it across supported integrations.
:::
-## Add secrets
+## Integration secrets
+
+Integration secrets authenticate persistent connections to external platforms. You store each secret once and then reuse it across supported integrations by selecting it from a dropdown when configuring a connection.
+
+### Add integration secrets
1. In the left sidebar, click **{{< fa gear >}} Settings**.
-2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**.
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab.
3. Click **{{< fa plus >}} Add Secret**.
@@ -32,7 +36,7 @@ You store each secret once and then reuse it across supported integrations.
- **[secret name]{.smallcaps}** — Enter an easily identifiable label that indicates which system the secret belongs to.
- **[description]{.smallcaps}** (optional) — Summarize when to use the secret or who owns it so other admins know whether it is safe to re-use.
- - **[secret value]{.smallcaps}** — Paste the credential exactly as issued by the external system. The value is encrypted and never displays it in plaintext again.
+ - **[secret value]{.smallcaps}** — Paste the credential exactly as issued by the external system. The value is encrypted and never displayed in plaintext again.
- **[expiration date]{.smallcaps}** (optional) — Set a rotation reminder if the external system enforces key expiry.
5. Click **Create Secret**.
@@ -45,19 +49,19 @@ Recommended: Create a new secret and update integrations that should use it.
:::
:::
-## View details
+### View integration secret details
1. In the left sidebar, click **{{< fa gear >}} Settings**.
-2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**.
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab.
3. Click the secret you want to view.
-## Edit secrets
+### Edit integration secrets
1. In the left sidebar, click **{{< fa gear >}} Settings**.
-2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**.
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab.
3. Click the secret you want to change.
@@ -70,11 +74,11 @@ Recommended: Create a new secret and update integrations that should use it.
6. Click **Update Secret** to save your changes.
-## Revoke secrets
+### Revoke integration secrets
1. In the left sidebar, click **{{< fa gear >}} Settings**.
-2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**.
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab.
3. Hover over the secret you want to change.
@@ -84,7 +88,7 @@ Recommended: Create a new secret and update integrations that should use it.
Revocation immediately disables the secret so it can no longer be used, but does not remove it.
-## Delete secrets
+### Delete integration secrets
::: {.callout-warning title="Deleting a secret is permanent."}
Be sure to update any connections that depend on this secret before deleting it.
@@ -92,7 +96,91 @@ 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 {{< fa puzzle-piece >}} Integrations, select **Secrets**.
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Integration Secrets** tab.
+
+3. Hover over the secret you want to remove.
+
+4. When **{{< fa ellipsis-vertical >}}** appears, click it, then select **{{< fa trash >}} Delete**.
+
+5. In the confirmation dialog, select **OK** to confirm deletion.
+
+## Webhook secrets
+
+Webhook secrets authenticate outgoing HTTP requests in workflows. Instead of hardcoding credentials directly into HTTP Request step header values, you store secrets once and reference them using `{{secret:name}}` syntax. HTTPS is enforced when secrets are used.
+
+### Add webhook secrets
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab.
+
+3. Click **{{< fa plus >}} Add Secret**.
+
+4. Fill in the details:
+
+ - **[secret name]{.smallcaps}** — Enter an easily identifiable label. Use this name to reference the secret: `{{secret:secret_name}}`.
+ - **[description]{.smallcaps}** (optional) — Summarize what the secret is used for.
+ - **[secret value]{.smallcaps}** — Paste the credential. The value is encrypted at rest and never displayed in plaintext again.
+ - **[expiration date]{.smallcaps}** (optional) — Set a rotation reminder if the credential expires.
+
+5. Click **Create Secret**.
+
+The secret can now be referenced in HTTP Request step headers using `{{secret:secret_name}}` syntax.
+
+#### Usage example
+In a workflow HTTP Request step, add a header:
+
+- **Header Name**: `Authorization`
+- **Header Value**: `Bearer {{secret:jira_pat}}`
+
+At runtime, the workflow engine replaces `{{secret:jira_pat}}` with the stored value and sends the request over HTTPS.
+
+### View webhook secret details
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab.
+
+3. Click the secret you want to view.
+
+### Edit webhook secrets
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab.
+
+3. Click the secret you want to change.
+
+4. Make your changes. For example:
+
+ - **[secret value]{.smallcaps}** — Paste a new value if the credential was rotated.
+ - **[expiration date]{.smallcaps}** (optional) — Extend the expiry window.
+
+5. Click **Update Secret** to save your changes.
+
+### Revoke webhook secrets
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab.
+
+3. Hover over the secret you want to revoke.
+
+4. When **{{< fa ellipsis-vertical >}}** appears, click on it and select **{{< fa triangle-exclamation >}} Revoke**.
+
+5. On the confirmation dialogue that appears, select **OK** to confirm revocation.
+
+Revocation immediately disables the secret. Any HTTP Request workflow steps referencing it will fail until you update them to use an active secret.
+
+### Delete webhook secrets
+
+::: {.callout-warning title="Deleting a secret is permanent."}
+Be sure to update any HTTP Request workflow steps that depend on this secret before deleting it.
+:::
+
+1. In the left sidebar, click **{{< fa gear >}} Settings**.
+
+2. Under {{< fa puzzle-piece >}} Integrations, select **Secrets**, then open the **Webhook Secrets** tab.
3. Hover over the secret you want to remove.
diff --git a/site/guide/workflows/_conditional-requirements.qmd b/site/guide/workflows/_conditional-requirements.qmd
index 3faacf4cda..901bd0cbc1 100644
--- a/site/guide/workflows/_conditional-requirements.qmd
+++ b/site/guide/workflows/_conditional-requirements.qmd
@@ -149,6 +149,8 @@ Enter in optional headers to include with your request:
2. Provide a **Header Name** and **Header Value**.
+To avoid storing credentials in plaintext, use `{{secret:name}}` syntax to reference a webhook secret.^[[Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets)]
+
:::
diff --git a/site/guide/workflows/_workflow-step-types.qmd b/site/guide/workflows/_workflow-step-types.qmd
index 1d34ce2663..af7c86bcba 100644
--- a/site/guide/workflows/_workflow-step-types.qmd
+++ b/site/guide/workflows/_workflow-step-types.qmd
@@ -213,6 +213,8 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem
1. Click **{{< fa plus >}} Add Header** to enter a header.
2. Provide a **Header Name** and **Header Value**.
+
+ To avoid storing credentials in plaintext, use webhook secrets: enter `{{secret:name}}` as the header value. At runtime, the workflow engine replaces the placeholder with the stored secret value. See [Manage secrets](/guide/integrations/manage-secrets.qmd#webhook-secrets).
From 75662a2e795da0cb33dd4f459a1a1ba929b730aa Mon Sep 17 00:00:00 2001
From: Beck <164545837+validbeck@users.noreply.github.com>
Date: Fri, 17 Apr 2026 10:40:39 -0700
Subject: [PATCH 14/27] docs: Document Checker expansion & Guides update
(#1284)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* sidebar shuffle
* Renaming document checker guide
* wip edit: Customize document checker
* Save point
* Save point
* Unhiding generate assessment from PDF
* Rename: Check documents for compliance
* Edit
* Edit: Check documents for compliance
* Adding check documents for compliance to validation
* Admin training edit
* Screenshot rename or update
* Validation training — + Document Checker
* Proofreading
* Fixing the cookie issue for the external previews
* Edit
* Shuffling wip
* guides landing reshuffle
* Save point
* Testing...
* More testing
* more
* Save point
* Save point
* Edit
* Edit
* Tweak
* Editing extension README
* Edit
* Edit
* Forgot the footer links, standarizing breadcrumb casing
* Kam's suggestions
* Oops, accidentally committed Cursor plans
---
.../validbeck/sidebar-slim/README.md | 72 +++++
.../validbeck/sidebar-slim/_extension.yml | 7 +
.../validbeck/sidebar-slim/sidebar-slim.css | 89 ++++++
.../validbeck/sidebar-slim/sidebar-slim.js | 139 +++++++++
.../validbeck/sidebar-slim/sidebar-slim.lua | 53 ++++
site/_quarto.yml | 12 +-
site/_variables.yml | 2 +-
.../overview-llm-features-check-document.png | Bin 16044 -> 24010 bytes
site/about/overview-llm-features.qmd | 33 +-
site/assets/styles/_links.scss | 2 +-
site/faq/faq-integrations.qmd | 6 +-
site/guide/_metadata.yml | 10 +
site/guide/_sidebar.yaml | 293 +++++++++---------
...idmind.qmd => personalizing-validmind.qmd} | 6 +-
.../set-up-your-organization.qmd | 2 +-
site/guide/guides.css | 34 ++
site/guide/guides.qmd | 153 +++------
.../_check-model-documentation.qmd | 98 ------
.../_check-model-documents.qmd | 179 +++++++++++
.../model-documentation/_document-checker.qmd | 8 +-
.../check-documentation-for-compliance.qmd | 80 -----
.../check-documents-for-compliance.qmd | 53 ++++
...ntified.png => checker-gap-identified.png} | Bin
...ps.png => checker-no-significant-gaps.png} | Bin
...artial-gap.png => checker-partial-gap.png} | Bin
.../model-documentation/checker-selection.png | Bin 0 -> 88011 bytes
.../model-documentation/vdv-selection.png | Bin 113683 -> 0 bytes
.../working-with-model-documentation.qmd | 2 +-
.../preparing-validation-reports.qmd | 5 +-
site/guide/monitoring/enable-monitoring.qmd | 4 -
.../templates/_add-assessment-questions.qmd | 38 +--
site/guide/templates/_add-assessments.qmd | 14 +-
.../templates/_add-regulations-policies.qmd | 10 +-
.../templates/_what-is-document-checker.qmd | 55 ++++
...tor.qmd => customize-document-checker.qmd} | 21 +-
.../working-with-model-documents.qmd | 3 +-
site/styles.css | 13 +-
.../using-validmind-for-risk-management.qmd | 44 +--
site/training/assets/training.css | 2 +-
.../common-slides/_document-checker.qmd | 2 +-
.../finalizing-model-documentation.qmd | 2 +-
.../finalizing-validation-reports.qmd | 47 ++-
.../what-is-validmind/what-is-validmind.qmd | 2 +-
43 files changed, 1051 insertions(+), 544 deletions(-)
create mode 100644 site/_extensions/validbeck/sidebar-slim/README.md
create mode 100644 site/_extensions/validbeck/sidebar-slim/_extension.yml
create mode 100644 site/_extensions/validbeck/sidebar-slim/sidebar-slim.css
create mode 100644 site/_extensions/validbeck/sidebar-slim/sidebar-slim.js
create mode 100644 site/_extensions/validbeck/sidebar-slim/sidebar-slim.lua
create mode 100644 site/guide/_metadata.yml
rename site/guide/configuration/{personalize-validmind.qmd => personalizing-validmind.qmd} (89%)
create mode 100644 site/guide/guides.css
delete mode 100644 site/guide/model-documentation/_check-model-documentation.qmd
create mode 100644 site/guide/model-documentation/_check-model-documents.qmd
delete mode 100644 site/guide/model-documentation/check-documentation-for-compliance.qmd
create mode 100644 site/guide/model-documentation/check-documents-for-compliance.qmd
rename site/guide/model-documentation/{vdv-gap-identified.png => checker-gap-identified.png} (100%)
rename site/guide/model-documentation/{vdv-no-significant-gaps.png => checker-no-significant-gaps.png} (100%)
rename site/guide/model-documentation/{vdv-partial-gap.png => checker-partial-gap.png} (100%)
create mode 100644 site/guide/model-documentation/checker-selection.png
delete mode 100644 site/guide/model-documentation/vdv-selection.png
create mode 100644 site/guide/templates/_what-is-document-checker.qmd
rename site/guide/templates/{customize-virtual-document-validator.qmd => customize-document-checker.qmd} (86%)
diff --git a/site/_extensions/validbeck/sidebar-slim/README.md b/site/_extensions/validbeck/sidebar-slim/README.md
new file mode 100644
index 0000000000..2e191076e4
--- /dev/null
+++ b/site/_extensions/validbeck/sidebar-slim/README.md
@@ -0,0 +1,72 @@
+# Sidebar slim
+
+When `sidebar-slim: true` is set, users can collapse the docked side navigation to a narrow vertical strip to reduce visual clutter. State is kept for the browser tab (`sessionStorage`).
+
+## Usage
+
+### Setup
+
+Enable the filter globally in the project `format` section (`site/_quarto.yml`) so that its functionality can be called:
+
+```yaml
+filters:
+ - tachyons
+ - preview
+ - validbeck/sidebar-slim
+```
+
+This is the currently applied functionality.
+
+### Enabling
+
+#### Enable for a single page
+
+In the `.qmd` YAML frontmatter set:
+
+```yaml
+sidebar-slim: true
+```
+
+#### Enable for an entire section (directory)
+
+In that directory's `_metadata.yml` set:
+
+```yaml
+sidebar-slim: true
+```
+
+Any `.qmd` under that directory inherits this unless overridden per file.
+
+This is the current functionality that applies to `site/guide/`.
+
+#### Enable for the entire project
+
+In the project configuration (`site/_quarto.yml`), set default metadata so every page inherits it:
+
+```yaml
+metadata:
+ sidebar-slim: true
+```
+
+Per-directory `_metadata.yml` or a single document’s YAML can still override this (for example, `sidebar-slim: false` on one page).
+
+### Configuration
+
+#### Default to collapsed (narrow) sidebar
+
+Use **`sidebar-narrow: true`** so the first visit in a tab starts **collapsed** (until the user toggles). Preference is stored in `sessionStorage` (`1` = collapsed, `0` = expanded).
+
+Example:
+
+```yaml
+sidebar-narrow: true
+```
+
+This is the functionality currently set on `site/guide/guides.qmd`.
+
+## Notes
+
+- Extension only applies to **HTML** (`html:js`) output.
+- Toolbar appears at **≥992px** width; below that, Quarto’s own responsive sidebar behavior applies and this extension removes its UI.
+- When collapsed, the **main column width stays the same**; only the sidebar UI narrows inside its layout area (the grid tracks for the article are unchanged).
+- Does not replace Quarto’s built-in **reader mode** (`website: reader-mode`); you can use either or both.
diff --git a/site/_extensions/validbeck/sidebar-slim/_extension.yml b/site/_extensions/validbeck/sidebar-slim/_extension.yml
new file mode 100644
index 0000000000..a5494d300d
--- /dev/null
+++ b/site/_extensions/validbeck/sidebar-slim/_extension.yml
@@ -0,0 +1,7 @@
+title: Sidebar slim toggle
+author: validbeck
+version: 1.0.4
+quarto-required: ">=1.4.0"
+contributes:
+ filters:
+ - sidebar-slim.lua
diff --git a/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css b/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css
new file mode 100644
index 0000000000..7e18972967
--- /dev/null
+++ b/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css
@@ -0,0 +1,89 @@
+/*
+ Collapsible site sidebar: narrows to a slim vertical strip (desktop).
+ Activated when sidebar-slim metadata is true (see sidebar-slim.lua).
+*/
+
+@media (min-width: 992px) {
+ .quarto-sidebar-slim-toolbar {
+ display: flex;
+ align-items: center;
+ justify-content: flex-end;
+ gap: 0.25rem;
+ padding: 0.35rem 0.4rem 0.45rem;
+ flex-shrink: 0;
+ }
+
+ body.quarto-sidebar-slim-enabled #quarto-sidebar.sidebar {
+ display: flex;
+ flex-direction: column;
+ transition:
+ width 0.22s ease,
+ min-width 0.22s ease,
+ max-width 0.22s ease,
+ flex 0.22s ease;
+ }
+
+ body.quarto-sidebar-slim-enabled #quarto-sidebar .quarto-sidebar-slim-toolbar {
+ order: -1;
+ }
+
+ /*
+ Collapsed: narrow the sidebar element inside its grid cell only — do not change
+ grid-column on the sidebar or main content, so the article column does not widen.
+ */
+ body.quarto-sidebar-slim-enabled.quarto-sidebar-slim-collapsed
+ #quarto-sidebar.sidebar {
+ width: 100% !important;
+ max-width: 2.75rem !important;
+ min-width: 0 !important;
+ justify-self: start;
+ overflow: hidden;
+ }
+
+ /*
+ #quarto-sidebar is