From 470d5f63b5268561a5cf91703baa1ffc3e351c63 Mon Sep 17 00:00:00 2001 From: Nik Richers Date: Tue, 5 May 2026 09:41:59 -0700 Subject: [PATCH 1/2] docs: Add Databricks integration documentation (#1301) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: Add Databricks Unity Catalog integration documentation Add documentation for the new Databricks integration that enables linking ValidMind inventory records to Databricks Unity Catalog resources including models, datasets, and agents. - Add Databricks to supported connections in configure-connections.qmd - Add Databricks to model inventory integrations in managing-integrations.qmd - Add step-by-step connection and linking examples in integrations-examples.qmd Closes sc-14813 * Add placeholder columns to integrations grid layout * Fix Databricks connection field names to match UI - databricks host → workspace url - client id → sql warehouse id - client secret → personal access token * Fix Databricks link model steps to match UI * docs: Fix Databricks connection field descriptions - client id: Update to describe SQL Warehouse ID - client secret: Update to describe PAT token secret * docs: Add developer workflow for running validations on Databricks data Add a new section explaining how to run validation notebooks against Databricks-hosted data, with a link to the quickstart notebook and a mermaid diagram showing the data flow between platforms. * Split examples up into separate files. * File rename * Remove terminology ambiguity * Edits * Add missing headings for steps * Add configuration screenshot --- site/guide/_sidebar.yaml | 10 +- .../integrations/configure-connections.qmd | 15 + .../integrations/integrations-examples.qmd | 462 +----------------- .../configure-databricks.png | Bin 0 -> 72235 bytes .../create-jira-ticket.qmd | 85 ++++ .../create-servicenow-incident.qmd | 77 +++ ...ns-examples-aws-sagemaker-linked-model.png | Bin .../integrations-examples-aws-sagemaker.png | Bin .../integrations-examples-gitlab.png | Bin ...examples-http-request-open-jira-ticket.png | Bin ...-http-request-open-servicenow-incident.png | Bin ...integrations-examples-webhook-run_step.png | Bin .../synchronize-aws-bedrock.qmd | 99 ++++ .../synchronize-aws-sagemaker.qmd | 82 ++++ .../synchronize-gitlab.qmd | 80 +++ .../synchronize-with-databricks.qmd | 137 ++++++ .../use-webhooks-with-workflows.qmd | 128 +++++ .../integrations/managing-integrations.qmd | 26 +- 18 files changed, 746 insertions(+), 455 deletions(-) create mode 100644 site/guide/integrations/integrations-examples/configure-databricks.png create mode 100644 site/guide/integrations/integrations-examples/create-jira-ticket.qmd create mode 100644 site/guide/integrations/integrations-examples/create-servicenow-incident.qmd rename site/guide/integrations/{ => integrations-examples}/integrations-examples-aws-sagemaker-linked-model.png (100%) rename site/guide/integrations/{ => integrations-examples}/integrations-examples-aws-sagemaker.png (100%) rename site/guide/integrations/{ => integrations-examples}/integrations-examples-gitlab.png (100%) rename site/guide/integrations/{ => integrations-examples}/integrations-examples-http-request-open-jira-ticket.png (100%) rename site/guide/integrations/{ => integrations-examples}/integrations-examples-http-request-open-servicenow-incident.png (100%) rename site/guide/integrations/{ => integrations-examples}/integrations-examples-webhook-run_step.png (100%) create mode 100644 site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd create mode 100644 site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd create mode 100644 site/guide/integrations/integrations-examples/synchronize-gitlab.qmd create mode 100644 site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd create mode 100644 site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index f83571cac9..6017e69619 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -49,7 +49,15 @@ website: - guide/integrations/link-external-models.qmd - guide/mcp/connect-ai-assistants-via-mcp.qmd - guide/integrations/configure-analytics-exports.qmd - - guide/integrations/integrations-examples.qmd + - file: guide/integrations/integrations-examples.qmd + contents: + - guide/integrations/integrations-examples/create-jira-ticket.qmd + - guide/integrations/integrations-examples/create-servicenow-incident.qmd + - guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd + - guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd + - guide/integrations/integrations-examples/synchronize-with-databricks.qmd + - guide/integrations/integrations-examples/synchronize-gitlab.qmd + - guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd - text: "---" - section: "Workflows" contents: diff --git a/site/guide/integrations/configure-connections.qmd b/site/guide/integrations/configure-connections.qmd index 944a7fb98a..831f96e5aa 100644 --- a/site/guide/integrations/configure-connections.qmd +++ b/site/guide/integrations/configure-connections.qmd @@ -121,6 +121,21 @@ Required configuration details: **[personal access token]{.smallcaps}** : Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. +### Databricks + +A unified analytics platform for data engineering, data science, and machine learning, including Unity Catalog for centralized metadata management. + +Required configuration details: + +**[databricks host]{.smallcaps}** +: The URL of your Databricks workspace, such as `https://yourcompany.cloud.databricks.com`. + +**[client id]{.smallcaps}** +: The ID of your SQL Warehouse (found in Databricks SQL Warehouses settings). + +**[client secret]{.smallcaps}** +: The secret that stores your Databricks personal access token (PAT). + ### Custom A user-defined connection to a third-party system that implements the {{< var vm.product >}} reference API.[^4] diff --git a/site/guide/integrations/integrations-examples.qmd b/site/guide/integrations/integrations-examples.qmd index 9ee496a775..91c9a5c15e 100644 --- a/site/guide/integrations/integrations-examples.qmd +++ b/site/guide/integrations/integrations-examples.qmd @@ -4,461 +4,17 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Integrations examples" date: last-modified +listing: + - id: examples-listing + type: grid + grid-columns: 2 + max-description-length: 250 + sort: true + fields: [title, description] + contents: "integrations-examples/*.qmd" --- Adapt these usage examples for your own workflows or connections to interact with external systems. -- [Create a Jira ticket](#create-a-jira-ticket) -- [Create a ServiceNow incident](#create-a-servicenow-incident) -- [Start workflows via webhook](#start-workflows-via-webhook) -- [Add webhook step triggers](#add-webhook-step-triggers) -- [Synchronize models with AWS SageMaker](#synchronize-models-with-aws-sagemaker) -- [Synchronize models with AWS Bedrock](#synchronize-models-with-aws-bedrock) -- [Synchronize models with GitLab](#synchronize-models-with-gitlab) - -::: {.attn} - -## Prerequisites - -- [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: 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. - -::: - -## Workflow examples - -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. - -- 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 - -To create a Jira ticket when model validation requires attention: - -::: {.column-margin} -![Create a Jira issue](integrations-examples-http-request-open-jira-ticket.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a Jira ticket, showing the required fields described in step 4." .screenshot} -::: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -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[^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 - - **[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: - - ```json - { - "fields": { - "project": { - "key": "MODEL" - }, - "summary": "Model validation failed: {{Model Name}}", - "description": "The model [{{Model Name}}|{{Model URL}}] failed validation. Review artifacts in ValidMind.", - "issuetype": { - "name": "Bug" - } - } - } - ``` - -8. Click **Update Step** to save your configuration. - -The HTTP request to create the Jira ticket is sent when the workflow executes the step. - -### Create a ServiceNow incident - -To create a ServiceNow incident when a data drift issue is detected during ongoing monitoring: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - - -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. - -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://yourinstance.service-now.com/api/now/table/incident` - - **[method]{.smallcaps}** — POST - - **[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: - - ```json - { - "short_description": "Data drift issue detected: {{Model Name}}", - "description": "A potential issue has been identified for model {{Model Name}} (link: [{{Model URL}}]({{Model URL}})). Please review the ongoing monitoring documentation in ValidMind.", - "urgency": "2", - "category": "Model Risk" - } - ``` - -::: {.column-margin} -![Create a ServiceNow incident](integrations-examples-http-request-open-servicenow-incident.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a ServiceNow incident, showing the required fields described in step 4." .screenshot} -::: - -The HTTP request to create the ServiceNow incident is sent when the workflow executes the step. - -### Start workflows via webhook - -To start a {{< var vm.product >}} workflow from an external system: - -::: {.panel-tabset} - -#### a. Configure workflow in {{< var vm.product >}} - -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[^9] onto the canvas, then connect it to your workflow. - -3. Double-click the step to open the **Webhook Step Trigger** modal. - -4. Copy or select the webhook details: - - - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. - - **[select target model for payload]{.smallcaps}** — Select the model that is associated with the webhook payload from the dropdown. - - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: - - ```json - { - "action": "run_workflow", - "target": "", - "entity_name": "InventoryModel" - } - ``` - - - For the required authentication headers, click **{{< fa regular copy >}} Copy** for each of the following key-value pairs and paste them into your external system: - - `x-api-key`: `{{API Key}}` - - `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**. - -#### b. Start workflow from external system - -Send a POST request to the webhook URL with a JSON payload that includes the `run_workflow` action for the target model CUID: - -```bash -curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ - "action": "run_workflow", - "target": "", - "entity_name": "InventoryModel" -}' -``` +:::{#examples-listing} ::: - -### Add webhook step triggers - -To trigger a waiting {{< var vm.product >}} workflow step to continue from an external system: - -::: {.panel-tabset} - -#### a. Configure workflow in {{< var vm.product >}} - -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[^11] onto the canvas, then connect the step to your workflow. - -3. Double-click the step to open the **Webhook Step Trigger** modal. - -4. Copy or select the webhook details: - - - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. - - **[select target model for payload]{.smallcaps}** — Select the model that is associated with the webhook payload from the dropdown. - - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: - - ```json - { - "action": "run_step", - "target": "", - "entity_name": "InventoryModel" - } - ``` - - - For the required authentication headers, click **{{< fa regular copy >}} Copy** for each of the following key-value pairs and paste them into your external system: - - `x-api-key`: `{{API Key}}` - - `x-api-secret`: `{{API Secret}}` - -5. Click **Update Step** to save your configuration. - -When the workflow reaches this step, it pauses and waits for the external system. - -#### b. Trigger workflow to continue from external system - -Send a POST request to the webhook URL with a JSON payload containing the `run_step` action for the model CUID: - -```bash -curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ - "action": "run_step", - "target": "", - "entity_name": "InventoryModel" -}' -``` - -::: - -## Connection examples - -### Synchronize models with AWS SageMaker - -::: {.column-margin} -![Connect with AWS SageMaker](integrations-examples-aws-sagemaker.png){width=80% fig-alt="Screenshot of the AWS Sagemaker connection configured to synchronize models, showing the required fields described in step 5." .screenshot} -::: - -To synchronize models registered in the {{< var vm.product >}} model inventory with AWS SageMaker models, you need to first configure the connection and then link the models: - -#### Configure the connection - -::: {.column-margin} -![A linked AWS SageMaker model](integrations-examples-aws-sagemaker-linked-model.png){width=60% fig-alt="Screenshot of the model linked to AWS SageMaker, showing the required fields described in step 4." .screenshot} -::: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. - -3. Click **{{< fa plus >}} Add Connection**. - -4. In the modal that opens, select **AWS Sagemaker**. - -5. Complete: - - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[aws region]{.smallcaps}** - The primary region where your SageMaker model registry lives, for example `us-west-2`. - - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. - - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. - -6. Click **Save Integration**. - -7. Test the connection: - - a. Hover over the AWS SageMaker connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. - - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. - - -#### Link the models - -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.[^12] - -3. Scroll down until you locate the **Amazon Sagemaker** connection box in the right sidebar. - -4. Hover over the Amazon SageMaker box. - -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. - -6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the AWS SageMaker model to link. - -7. Optional: Click **Test Connection** to ensure the connection is working as expected. - - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. - -8. Click **Link Model**. - -### Synchronize models with AWS Bedrock - -The AWS Bedrock integration lets you link {{< var vm.product >}} models to foundation models and generative AI agents in Amazon Bedrock, supporting governance across your AI/ML ecosystem. - -AWS Bedrock exposes two primary integration surfaces: - -- **Foundation model layer** — Access to AWS-hosted and custom foundation models through the Bedrock model catalog (Discover and Tune views). - -- **Application layer** — Bedrock primitives such as agents, flows, and knowledge bases that represent built generative AI applications and workflows. - -#### Configure the connection - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. - -3. Click **{{< fa plus >}} Add Connection**. - -4. In the modal that opens, select **AWS Bedrock**. - -5. Complete: - - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[aws region]{.smallcaps}** — The primary region where your Bedrock resources are deployed, for example `us-east-1`. - - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. - - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. - -6. Click **Save Integration**. - -7. Test the connection: - - a. Hover over the AWS Bedrock connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. - - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. - -#### Link models from Bedrock - -Once the connection is configured, you can link {{< var vm.product >}} models to your Bedrock resources: - -::: {.callout title="Model dependencies"} -Bedrock agents, flows, and runtimes typically call foundation models (LLMs) under the hood. When you link these application-layer resources to {{< var vm.product >}}, consider also registering their underlying foundation models and creating dependency relationships between them. - -This builds a complete dependency graph showing how your AI applications relate to underlying models. Benefits include: - -- **Impact analysis** — See which applications are affected if a foundation model is deprecated or has compliance issues. -- **Full audit trails** — Documentation and risk assessments capture the entire model stack, not just the top-level application. -- **Governance visibility** — Track model versions and changes across your AI ecosystem. -::: - -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] - -3. Scroll down until you locate the **Amazon Bedrock** connection box in the right sidebar. - -4. Hover over the Amazon Bedrock box. - -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. - -6. In the modal that opens, use the tabs to filter by resource type: - - - **All** — View all available Bedrock resources. - - **Foundation Models** — AWS-hosted and custom foundation models from the Bedrock catalog. - - **Agents** — Generative AI agents you've built in Bedrock. - - **Flows** — Prompt flows and orchestration workflows. - - **AgentCore Runtimes** — Agent runtime environments. - -7. Click **[select model]{.smallcaps}** to choose the specific Bedrock resource to link. - -8. Optional: Click **Test Connection** to ensure the connection is working as expected. - - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. - -9. Click **Link Model**. - -### Synchronize models with GitLab - -Synchronize GitLab model registry with ValidMind model inventory for comprehensive model tracking. - -#### Configure the connection - -::: {.column-margin} -![Configure GitLab connection](integrations-examples-gitlab.png){width=80% fig-alt="Screenshot of the Configure GitLab dialog showing fields for integration name, description, project ID, GitLab instance URL, personal access token, and initial status." .screenshot} -::: - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. - -3. Click **{{< fa plus >}} Add Connection**. - -4. In the modal that opens, select **GitLab**. - -5. Complete: - - - **[integration name]{.smallcaps}** — How other admins can identify the connection. - - **[description]{.smallcaps}** (optional) — The intended usage or additional details. - - **[project id]{.smallcaps}** — The GitLab project ID or path containing ML models (required). - - **[gitlab instance url]{.smallcaps}** (optional) — Leave empty to use GitLab.com, or enter your self-hosted GitLab URL. - - **[personal access token]{.smallcaps}** — Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. - - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. - -6. Click **Save Integration**. - -7. Test the connection: - - a. Hover over the GitLab connection you just created. - b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. - - If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. - -#### Link the models - -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] - -3. Scroll down until you locate the **GitLab** connection box in the right sidebar. - -4. Hover over the GitLab box. - -5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. - -6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the GitLab model to link. - -7. Optional: Click **Test Connection** to ensure the connection is working as expected. - - If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. - -8. Click **Link Model**. - - - -[^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) - -[^2]: [Introduction to workflows](/guide/workflows/introduction-to-workflows.qmd) - -[^3]: [Manage secrets](manage-secrets.qmd) - -[^4]: [Configure connections](configure-connections.qmd) - -[^5]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) - -[^6]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request) - -[^7]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#http-request) - -[^8]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) - -[^9]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) - -[^10]: [Add new workflows](/guide/workflows/configure-workflows.qmd#add-new-workflows) - -[^11]: [Workflow step types](/guide/workflows/workflow-step-types.qmd#webhook) - -[^12]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) - -[^13]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) - -[^14]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) \ No newline at end of file diff --git a/site/guide/integrations/integrations-examples/configure-databricks.png b/site/guide/integrations/integrations-examples/configure-databricks.png new file mode 100644 index 0000000000000000000000000000000000000000..d524781af9ba8727d44ff260bbd2c846fd5eec8a GIT binary patch literal 72235 zcmeFZWpEtLvMnkGi(7*@9^J&fq@~($x5n&fkBdhfkEWK!GO+~t_Br= ze!yMTWyHbC#|RHVe@I&B$XO~WfzgAG;lRMdZNQ*@HvxU|L0{12-@w5jLBHU?&wYdV z_kSTtzCr%`7$Wa?!^+jzG%zqxFgZyv4Iub&Cae$UPn>>Zbgwg_JODU!5jiPokQ-_u z`DaWiG$^&#&p}9x^QdC6^bqoAZFl5`UT6nx$rEp9JcGTX&T^;B+q4ftBFQaFnW>o% zr^I89Yu+{B$-%*n2w$LN1OEDaND(zbY#85_`}?$PC+fHR^-xg=%0EBrI1rd5eqAHM zv0(6jepG$V@kzna|NNXIfPY5mFxeIRkNeRI1Cjo`6m)za3idPHnDvVEuX~AtZq*9& zA6Gw%2W%GS;Hk}CnLg|v zj)^FLlV>J z=(xZ;BKo;<tK_qeHzSw5F{1ht z2cP@nDHV&&-cRv*(8$rwyCZmbg1|~l7Nh5O43d+j4klD^<>7d$l3Irq`NNr#y=B6K zy^h)PL?r?q`I|#7O0z!1xTHFPHSaT_g&IIb>B|vI%V6%^4FUH+1R8~#dbYSA8c9zW zQo@?wlak-t3xH0qwos=3ymsR8OS*Yq1|J0YW^L}{%YKy^y{w1qja9LHpwB}_%R}m) zPZkD8I(;~BP@`TYD~4C+lsfOk=!mjcb3b2amt1SRqUW&EN;jIu{T@YMo6_a=OMAZ}&pRZ_?ABAzOq*^oaqH$nYKH&xK$bDsQxVTNu9Y~!#%P*70bkqpV8 z(vIu-x>#zC@5}vG%+B#b&E;W9g_m2cg+emEV{dMZ@L|>cd7&v!Xt72)<5u67gbY5{ z=7pmUB~)yTubSpCDg%XVX8A^CdY3xC$m6hfg#Ym4Kx=fTU0~-{ASz?44;rZ$iO0#} zO7g4Q(X7(#=>mn2*X{J+HA4_<_GG?-!Vkq%^W7*s%SprU;?PsqAeY-tHuhsPeb1m> z7LPgje&3v*QW_D^z$PbBmK9Z^T`|+%|qUBmtN0*Qg06W}qr6c4#}HgzT@P_m^8SBJ#7Px=I45`o2%MiNA7XhSwI8 zKQ2^%vhU&Cz7OVRF>19w#9`Ku9ZI63a6g(&EP7w?PI4N7rIi#Oof0*qR4H575C$2a zGJ#r&eG@6+t@jfK0U4|3r8$y4zx|`D_|rA$9mwdx8sc(TMqRv{DSO{f=zlz4wd+lG z0^4Wh*%E#6H5yRp#j*J_(n?Uldf0PS%LY!P+I;ZlIV_`LXE=FS`etal!gwtsvL_rx zL8T3Qwz%PkMv=NSX*UPAr03hiUUs#Z5Cd;E9R*sX)p%9{8wRy(r4g)h$+d=Ok#R{q ze2T9K$CvbrurtB51m!F@@gTOEj7HTZzhLb7=*)vH84_( z=_bt_ID5arCILOsa@KCQxY}$HNmrw^)Ki68ZGp52v&1a0*b7Cxp`hPj&p{5+o!b;` z`uhA}34wxk;gc&JbdrVNooeKBA=OlVoKy%F=zBHF1M)zeg(}|`(gKV9iSLuGo~|6b zS9{~b`3lL3O&mi=#0iCmDG-matA(>eDC9O%yQ9*WKCcgZmJK^6{L&G;PV;3!=$7M4 zB>vB2`@@VvG^nW@*DEs<4RdQiiQTbG8ZO&u)(>E2K6O$Ex~;&fLHMo*>&d)NXq@FY zCxC6>{4;V3(ivP`x3G4NCt3N@L*^e-!TKqxXats4oy+J&z#N55H&nItlvV}u_7u|= z290vcpno(W->Ga)pW%LY8kECHB(V?_;OEoz0mXU9H|Eo%j=829MxDw|Y>uqY@LqEQ zzK_@JCY@jjiqWVg$n+p@Wnxefya=J@5&3W_s0yD2T_9F@ti`5k_;W)0@Fc+WLx&;F z?dl@h2}>)Pr}&jtmjA2gr;;u4H&SvB+ercR)u)>ynl<0M%>L0}oa0KbAd^t8jADs! zWNJi&@8+>lO1R*+4X7JwGD8aGE*11 zcuF=4gZ_O%99olc0ztW*p+pSIJPE-v)n7V>&_B2$+CfvuAoz{=wH8XE&>b%TRSXxy zMcl)h7b_$SDYfP%^X#qA+Kr1c)oQ{H!jtqA5&j@C%WG(b*@5DZH86r2oHAL)oaksS z%33>Q$rqgj&OgXBo*=R8m%ywndIOmb$Pu}+(JY}%O64BOsqS zQkUPxFoZMdxFsSl_IbE8eY(P-B`u!KGb>QORGcYRSJb90$>+m|ql+9^_7p8nv9%O~*52Yh0PiASN_LD8<}6A&k3)SyCI7YZr=Zu` z4^xB6V|w$>A2nY7>q@x7K8+dg;}U4xJeLFD^sZ`=b@=;ZSxw2O$XhXIGoDVkpB%>1 z6Y^K~9;26WBZPoirH$gL$!-QhUe}!D$R%IfO30zebkFfU&ET5SguSDIF3fE<$rgXc ze9tPKG#7z`_KEbGO0>vHE$;a7Z7qPa^5OGxo`gxz3YI>Tb-d!E_>t%1B4)J;%?4n2 zJvE?Ar;5CEFp)t!%(oBrN$@ifez6%6;DmxhFdK3;7?Vyt4V8hBB1*eInrJ7Ir9Gn5 zw$b<8iBy-!RR5gX#DZ0Ep5ci8{rTAS^f@O%HD-B^A2>%!fqSg>hfw50`{hP(N9v6w zpNLJA-jJ57S^YM(0f4g}$_bAP-#XFbMmR~g2U!KR-7KRectC!$?VLV-T4)AINV$|b zT-D{QPtn#1o6etc4QR-p(;dGHKb`pA#%SC=vh7l8R3rV)W*(EeKgD`?C{e-4;kEj} zv_z{+@f13KFixOKdib?$Lms#aeJNnz%HuKX$6poatj{ zz^lt^x938UC!EeNcuSi5-N-GJ5bR49RG8ZZt8BS^`9vtWQ@AeM`O5DmGc15GDi1a` z8SBMBNLaUJf17rR0H24QWXpU8MuMnkSfG06b`-UJjK&5GLL5Fh-OWZwW!0gaxPVR- zeK9|+W75OP;>@-$DIKxg8k}R#{YL6#ufaIM*o8S#qC~s$XxiJ)yAANqXRTM!c#xNx zL;FKUa2f!3=kVi6_qGQ z6zpeS@i!wfW_ddEAbmGE?-tA->>sf2T=Ca74KRqe98F6VIG2r%t}xZr$z-6H$nj9X zQqy_FPOuR)s7RYV%KI*fwos@RKY?;!H?(DtI8_dOjoAl4J`++7fT;6B? zeZ&NVinz~5&-TC4E-?6BLGWyhF|&5Nc9OvE9)L%w++Qguo7DPuOcFNe$dmX#(=|{M zsSL^t|3A$s*P%gaD2quI?H?}^DKk$ zG|6r@Q(iu$OAU_0onpaM{;xjjuY)wXrGVRGK0eRO5c7dpv3N>3bPG@HfAFior$Dfu z{Vz_~^WiPZ>pkU$7H@%&8;he~=@MF(Ym24}jf9qO2iixnIAmxZX!0)psfqHOF zzaGdaENDBe^!+Q{`+>6#qy)^v@89G8cV_JDkq_A1G8L*JOop;;)GSNm>XGgAzBsh2 z80_o{{&Gjr6ehjW=q&L=Ii2}vwt^!Y0h5;W=5U(ryQ0Y52?Hz&G3SlQ+a^MhMpe#N z25sfBEFlIAYUQt)Ego{uz>9p1qImU_RI8DTZsZ>%NleDfuDfH2yw01lhW0g1-^DF? z>dW-%5*eUYQ4DQ4N z$GY)sq`Jp;1`i(b#moI@=;mn7B47E{bVc|x*K8>xk3_CLJvKh z@Z`Atn%8iM;mzv??9|!&0_DLgB!b^a%NH65`{}teS54kdZ&M^s@{S@J3ire5YVpv{ zr?;nU#FrDEhu0;e`iSkpO#R2ZBN{lA;6i77K?Vlx5`bhIm%Uy?l754O+!J6m?qsO} zL6Cg5lE^6aOFFmQo^obh#%GlIoS%_OnKAB&q3^K23VGk+s=&31asJ`x+Mvbv6w8zN zE(^8ML&zMOF+_YLblVk3Cmn-F0gFNu-@(-j?;+hroXT$5nj3?P0k@;q;Mexd?bAp& zQCS*EPsm)N-D?9v5xBb{mxe<8R_lG!Ya#^o%hJ$@H@L(6s)%FLzMGn%B8hJT))=(-WjbK)2H)IX!ci9?paMs$5G&);0ZJf2gXt~%J!T%APpF#(E;|DuG z&671<7-~218Vmk^?zk5(_q^lr6x8TM$OH0n1)p)7LnL4(il4h zD%r$ZVI=<~+MR1qr(gEACZU`7oEzVLkwY)o+Cx9z$FN)uq?dMx-nTLmQ(BGfq<25# zkI9A!p@f;MxXI8cy4R>(YQT8-jbv8m{qmn*s?Ves7Jt&I?lt4bYv;J`PgbtbYf)}? zdt25pZ1ZSCB$?z3K*EqGkX3h(Z4Af`IXX!%NuQf5T2rcUtl9|apW zS<>eyIv5o5G>?dAka;LiV|6#8abtyR&?wF$aM2)~FQY$WtoU{4wI z6O%@>lK1yNB_6Hp+ih}RQk{pm3i7p939nIfglTu7`c3aY>{+xjTRqJ#Ii^>Z zq;X{>RBiQ#h8l9&FZWVaEz_D8PN~+WZdMIvxK}-%rDO*T!mtJU&WG{0gQDBVmBfytKvQ7 zkNcOMQlBy705{;_U0vFvmu=?@CI>6pMt-`7hqlIl&oU6qu(0913B67zQ3Ym`XNRMO z81YMSyf$BDI8Ale0EwNGDr=1_wuVnhq!+>q-_75iCf$o#f4x!d6i_R^ z-%@k$+Iq1j$V%J&VthWRFqQv=W11C{X_xHnv;5RXnp7-Bi;=YHZUxuG@Bi95_`P#T zgH=$QqI_4cao3}9w&UCI9Sk&#T#h8XA;9yR2;!ZoK5#62bnm?IgEd)cPN+F>J6|+! z;vaWkH$sna9`8SCTiWTfI#IIL%wU1_-uW5OPjQ+oAvtXZ(Ng!J9V*H5(dg3aTa00c z))(03H@2Av;Ke4q5gH!#NqIMvsYjO1B;_xJpTTp~_KUSyghTdtK*95zKZ1i7QPRGj z;hjAjfyor?xTvgst~n(ielpaMSLaxgpyxU#lK?W=9vEVIVoWxPG+#q%i1EeSc3HU4 z6*;|q2&zYH5Jtg=l#p7RQKm0jCdhulVG8oeoW^Fc%#w~tXPhY-5?*bxiwo{ z8zIH%wc}|in!}^+M2?&fhi;xyp&`k~BYs2%d*Pia+F*IP^5$l=Y@Qxd9 zNU6*BgAb&m@En`tSWUZGodbk#e^pD!ydEq{b=_AHy@cp|9tg8ZWfA|0*Y~B885b(e zuEiR|H=WZZMdiCO+D+inpUB;*KLi`I@OoXq9wdYIMrgiURh~oauAgLWTA~tf@>V$I zKxD|3rTr>rf~!e?ruVXMxK1Ys$eTZbTDYm@w7=4tms~LvYI*!x2CEX08MWlQ>(C)Q zf&}9XaddHlV%ptf-|{^R{r&tX$rAUa@PzQk=xE3s2$t)m70T7!sP&Xo4hvSsWll$K zzR>WRm~;FWKxr*61hN10u7A?jEkdw~386s7O#93EWhR)YynZ+Mv0o;-5GI zf)##7R0oLS*RgKWZ*=b+kIA!=_hk*{#=y3hq+qMJ@o75gQaR@C3L{%u!bpQM&Zo%+(;%8ECoML4G^A_NvnRk9oMrrMgM zw2Q(*VsiZi?ERmRmgq6XI?e@n>A6ozV##%lZ+w$)IczHl-00`0nOIbo2rto*gmG9O zEPC~@kWXc*lAOnH zIzNSTMa+;8shtyN`^dFF9iJHax5uFJySr|lkrAU{Vf6)n_atoKexZVEX|A*RqU(oa zs>KTATLUtk9+!)q;8zXa}!7UH;Q zmg>}6JShJGnw+0wL^xld>1@M)Dk(ASDz^h-p^ugI_kMb8{GJsB z@0poW10e_chMb*XD3}mQTP2{(Ov3*d(7JR^IvqJsDe0gQ24!EMTLI%jLVg%yI6JF5 z{^03esNL5z>Q|qI1u%-tqqh}gW5h#r-4ps${Q69{1!Zc=x}810j5FtTj?Xkvogj^b zp#K4fych3sM=$(uGb;Z!<1r+}**TC`5)S>BDJl_dIRAOT`bLPD=23{JD7gT%M<^X- zm>D#Ub}(4w__Wh$k1LHy;od2-pX5!3{W=HrxiSM*+8nByziPcqMXXgg?-8HK8>dO- z5-JsC>XH+iAfQ*fCJ5=~99;xCxV*GSR@QQH5%emYBbO4Zw+8P&A zP<&s+g`cWnViDmxSajE(Yh0_Mz-jdcSyw5X zHA}<@Txc~rOF&`x%vG`gUaC$uiB3QZ{^IHXb!3qex7e#$HgSV}|cPXgvzdEGr(=%tLIpIE7HJk+D*_{D?$NX~1Tf>BhU zjZ!#4$%A4_Cg3g;6mx?DfW}z~->Yj!Ux>!G9>=9#fk%_4t>u`ljR&H0+QwVhm+Ga} z$t`kY2=d<9egW!J!0la!*O>79c!T3wk^vtvTg6wp_@&VwF}yH+fqs0WE)tu(k2}Zd zHH3YiE_8(999^SVbZ6@iycn%gTOJ-Fy!5%>UK$LVTy`9|y^ZUC(`gn!DV*m9$JoP4 zZDiV<+u<}_Od8bL&qy2@-CIz#^-Hy)IrMC~KFy2YgA_7}FrjW$OS>be?&@-FJy7$p z({r)bX0pTI|2KS7YEUOXmMO3|!^UFNOv!7-X0w_hvJ|t@0vOI}^FEpLek3L&BOJ59s|&ZoC=0TNgL&HScZE#)?=pb*y3;Ux+z|gAmnut^?SL|emJV==uN)bs#kNM z1R?W*PZ^?}JL~H$0umP{oz!uH(_4W~j8^1)=#v{{@Y6Kk(y=Pn!7qNrR%~G6WpM|$ z+-S7|_4*TBtZ^8u9wup27CZDUKICMx{p8GHGj8|M6@J{O&~5(^x;>g81FFT7*euo- z)!NR;LqI@~7w^uUK*Au#N`JwZ`;19<%6rPQ=0kDT{#35*`?B`-N|S2SJ;Vld&2rdX(mB$M6vdY>#t=r#oe z#u@ghq>$!HM}O`6LZHy*b(7a4a3(uNt&}JE37wea!{s&|Ke!=9w%=n>zk4gw{=tK* zkvAkP@>dX4HNa5Ox_Pp3>h)0Pm3e(KrvhV>ol)4!uiKA!9@^$4AyFZFQuK8t=sAI~KdWMwv{d0-~#`bW#dAETvIYFf*gGceDi)t`_SbF|xam%o@Tj8*{%1%$A33 zz2qnS3W9z&z%edpCMh(up0VD#;A}$B=K^AhO^pfjWMLCdc`}#DK;D2LM!UuCCfBUU zhE<>US>+moz#wjidD6sd*N028ND-gXoQ4Rq9QavO`LQF!m!OULF*`kRTs% zAypmKZuQ5cR{#O_I0CE=fTc|P?V-fs2+=)H;|{+zC}>X{T_2?i`==+Fr?5yPyV(hu zJx@W8OSo@9KPLSkwv!&%yqky^FUnF}sK`-?pjl!AF zC+>T#^((|71iyor&T**Lr{o7_0P+JVuxlw$J0r#qaSys_INZ#&Dg=yrKSAT;NCsQa za^26$4a3e%;PW^^z1@s-zXM!$C=wP?YKsnZS;)9 zSv-q=y&^ibBJIUye{%NIb(~l*%pe^WhRE}MZmsPC`^U}C@7gqYS5(!&Hb8yDdTz(b zY>zgq#t-xJ^~R5B(rYIvFRm4q7Agl291-3BGV2?VF>D!ncLUL77btwXbXQS(HevLe z7}MDDrKNkN**&4%_h|?Oe4Np0YYQQ;DzX}DIZCKz@LHN<+(@z$jzmap9qrXu0iG z0vexscpp$<)Mh@M#B^EZHx?`0W}-e@W2NG{$_jt7($Zj>W~l228qPmdZczlWDP~;b zxb5|7-~r#AlZkFn(J_q2@x}zAL!B+PO+&e}d@ki&3-ApvC}lz5Zif4`tK*s57XNYX z-c#Jih3&@Kw~ePWDyy*!>4Ei(EG;yA5X>jmF%ecG#=EH}pTJ*dvia)M6E^unDP8ty z_f&A{D*TpBw@kaEJ&J@!8N`*cLSE2Y*wPCo^)T|jnxVipehRg_PGRrl`$EE!^)NcE z%`&df4+D3=vue#S7*ECJ8!`v0m>CAoahOIms99(}kfP={=?dZe`6%DxgumK-No%3r zKHcYaVee7jrw^_hMfkpxRXL3@b$cYPXTiL29FM~yo`c@UX|=Q;-mJ(VzgqE^>w1x) znwqM9#f=mKj=X^oOQrx|)|mB5-_kx@56bm*Z;5|K( z2_IATyLWbQHixq(W^|gxUsE;O&btvVL&CtiSkcZ3Hi+=tATCOjN7&dx?*mM8xZL(p zU3myG;xzFu0|iz=gy}4winksXoyu>@$9Ji6{y*PgnS+W8()%WpsJOV+)D$Tu-=E|2 z6?PD?B+CIp9gmj^sU=4E*JQM`0}(&ae@3Q%BBqWWP3K95<_9mvl;XvD)NfQJ(=AFc z!=>gIDV`T2X>eGfC-IxtWTo?cd%4>IG3q$@5aJSh+KK3^sa4X}K;G3Se#QzlFpR7BzKCAyRu5yPvNudQauN*-K6NZY#L4 zGVCfs&Qc2tho$X0e&ypTnJw%!3F(%bdIbEjj_;cuO;yLf=g)a|P{{x7Gl8N!o9WM+ zUEA|>lN?>WiucPi<(ef)@ND8u5s%ovJnQWx6gA&F{&K_GtJtrDawKX+pi)S}%)r>I zgS{|C>Ms8D4j}?L;?sD?efM&gOe!ItI27LL{&=RqoEE%yI4nGw4Jv-+BfXzf^t-~n zcYAM5Y2ybE-o`&l`W-+V8EGFy&C>$6k^2+TJW(BKa}zjjUJ+E1{k2W0$ZZ^~{?!N+ zxJ@6=t09;hODsC|UZ=nUh!cv|lBml-TIcG{6oO(}s1DHTkGCP@rAe?#lQ&>kTY!~VA$Yp z&Y%@INEmj)7#J|I!=N&z03}dOFRjbOLq7-M`cXQYO@39Pxr@V-RKrFx3_K6m8P8q= zB7EFeARc|X&;ouVn*Qx#{XKZIAGoD2trB+EdcP3#M}f~l3v%dlTET=Z6Ef6xmbxU; zJLq>q;m*-h7q7To#$Y{s+&7f;jXZu{2o{AB)#&=MFVLIO;%YT)cKJn^q8}QDT4*LW ze2}T}H^pi_KY+Fz|L~&5{UVFc)skYOk{8S+!6_JwmPY)Vro)y841GMkFH>t=<^?l zYAS|)Z3p5T8!((aAXs#n0|GFHd8(@oG(m3^fI1hkR&34$p#Ne&McpiCeBJX`IFsZ@ zdh2OOV0nsu3H**hqR%Z#^Lh4|65l2n)}xtw$6@)wqXx(sthR>LaI!N?F-w=IDa-<#$>?xRHB#1fk5=2#Ni`5K z-d|f4d3_@1xZbMIk|+?v4836qYX2@cmQ92+&#xOkBg5C<1R$o#883`fW%f1%v5_^~ zA0O@B69!GB4u6O_ThzK!5oX&6PFV-2p=sCqqQuu#kPMH zbktba3$vo8k1T$PeJ$fOl0CB5{YIwMD7~&L<_q*$|K5_9#lct`$ofBM)G`ayYr5PD zi_ixVS<*BpRP4a>*s;tt4q|xDaDnygeMx4EVhu7fU3`Q#)gE>eS?bk1zlWxPwUW8vDsdmr3W zC*@T3nGj%OiB$ucCjkZ#(Ci~GDs@`L!I0{X8+)Buzq0;xNZh=cshQ+XB?=(KzM7r- z>rc1tEr;sR>REEL0C+s{)n>o@?}PTD214joRfiZZh7)V_hghA4cLRtFX+(T3(;*4p z35RmaKx9f8t2eLaj!}1@K37a6qgzqgAdk_zT)NRtsVm$3pu9#YIxLBsA%^m z0T_NVYPvlzNam%lT4UBJXopW98c)lOkdn9#)dFZX23>ZdzztKxT^j;!rz;P7gHrZ7%qk~0>;e;IbVW2vR7Po0ns=Bh^Vlzk zj49%-9{ym}<5s{P<>D=cmlO(NupmW8+wai^!}iL+8pPq`z8zydy{DK1XQ1JlkV}|4 zJm^K0>ssMl?Epy&F3YLgXQwOC6*bUYjg@I6PZ1N4DYdswg{V7ZsmBWk+gJ(js4@r0 zM@GCPDv1E)Wb>$tT+erF6pZ237DHdz2B!z4M013w->d1GBYrf5LsT3>MTy}?(^FS? zSa$E zThw)pG@3HEr?knQJr{&C!HvIlZqt~HZI$%$?ZzKD>n6NROUF~8z~*U8x+)0 z=FPb}{)m%pckuA4R^iXsyUw{+x3|1%=ubg(t@rGDZLM@FoJ$r`k*3N`IbjwDQ%WDM zO3&CDAaJfM(GH7#jAN^#_05Yj_6$8yY-F8}8I=((m7%~B$x8ED(h}8u;I7jVszXXU zIKW%JjbfJ76wuJhCP+9iDlUsqq%HJeoNP__P!i~QfvKGfNH%Q#mZe|LT;m?SD z(NE%^vX%j&AQP)S(P}q3nO->}3gWX~V|CyOFjJ;d2%^qm`{kl0-TQveZrnwE+-*Lt zu!->hT>|J-fjS*@6@KRACJuvAoQF9*l)*fU5oka=xq>F?MW8k+Phf!~Q=E6+o3?3` zh&o4C%rZnu2nF)n)L~dhL7prUBF|lB`N*X6{&3Bw(?>Zm%Ylw8B|H@mP9J@#yvg;7 zi4c>#naDmGV)C?(mXq8uXn1l_W~07FA!npUOb}xQ2mw-Pw=$Xq-s(wEGjQM2-z<9C z#$}2u!BAfgyrgis?h?(F9MxGJtrPinxgWIlp?QR`fuuE;(QJ#&CQ*cRiqR|Zkosdc zL^+7dP9smF=jmZOH*{r2s_G zOex*~>Y%}|@|4C({+m(nj|QS5;@A*}|K?7fVn7UlcNWXSVg0*+7a#(!>T{pK9V7Jz zWGV_#1(NeI5(|X?2}OhMu`cslxEC@i@lW{=L=qDHNG*DSmOd`r|95jgO3{lAnR!9X zKLAS*Gt&~(N7ciz>+zrUjsJH2UxWOcZ}wjg`G0)KIQ#I;ej(u51~Kw}OCW#a(is8( z<;emSmcT$Vz1`~r4s=XR5PtMCp~h-_)j0x0OZ?5j+W|@IHg3PSefvgQb25_35u{!J zae-1fBi3P42SoPaegZ+~3?N-!5~z^kWDnxKjePAFo{!6wk#bl=)~5D*hKgs@ovdV= zH#2H-kwPXGv|dyK2~~75&HAGif}r3jL25rsf=53Pa?jzXe^*buRY=TWQ*9nk>HOh6 zGcWIal!!zaqN#nRh`$)KVKZ*|DM;0a)YJPZA;oW@yFfWJ-fpg34kXY;WO4Gq?}O|6 zgGT})g#uCGev5vQML6!h&Apwjv5cniB(s4uX}?93jvxi>s^1Zl&HT5(qL&U7k+0K5 z>IxT|F~f5pXuQGgL-Z%#?htq?)t};XD8jKF4Ikq~UJ1(*9`8+M2-$oZO(xgg=8P@A z))VD@fa%`KL?+r^u$?iVIh>h%c)6phQa)v?3XgcG)#srzXsoo^Dts4%L%@?nDHlJ` z>%677qUU}H*E@;Dgz_C#MM|MaJ%4*f+X$WjGGr>AN@3?JOK5v{G~GqwrxYZSLJQ9t z=gI8MxN{vz2NIEOU!~cevdzqoFN(MVvv63LL9&H8z9ZQz+0T;=6=)wKv00K-MBWT` zN3-k~yRwmq1cn}w2)3tASMs~xtE8SJP^)kwk}zl~`e`Jw)@oOnN;Elb1R)-;8Q0sd zF|WOy2lKVlee-WWno)R%No&$^`KS60w5HiX0H}`XZQ}Dl5>ZvY@>SFV&0-xjOT~0c z>hXDDw{w%LHc(OKhYm>NH3InBh0tv_^tFiHbW`%64C6$X!%{YVwrr=Qq5}=cX>#s1 zlESa~LphDo^J+WJkDsl9+i}&0POG*s^}a$~4JtinXTn1)Gml5pG-!N9$V>eJTf_JW3PX4C#Z_w_6c<0hjHKS)!TCz(T){Gf ziT0_Tmjas#~Dr8;DvFsNLx}zdjU`?rEwZ8 zo%@*&#{UGu9Y=d!?a2+&WU*E(FeiBH_pLlVhaynPL=&pNELeSM1SzqSr;BypKV4?` z=ahS?u73w98`t(eA;PkEg7{9LP4d z9Ea!IE#-5~2LUG@4W1pITb8&i7|PfVEPp*vZ0C#8dU-@l2|oFBvnGRXgF_~xZu9gO zn&VoPgr4m^x)F)rbzD)nV9ZD=d+K;34ojSJra-z=E|>p{MLk)=CIwQRSIx>2yP6Os zDov&D+bcuMOt4zLA|96bj(L+8GH8gJ-%8!U_A6FAP%DF2o@E&`C$p$&niUR)2OzN9 zNzxr4E%=`K9dLEkNR`4v=BQ?Yr|H(m-UH7AL((Z*tZ;r!UxvWdNoEjJL7TnE| z`aHmSL%q(m4&o#WQD&0xI(7PtrSrtJP87x+uRO)bHTFp>?hk)uwnwjti;6Zt#ihQ5 z8$7(&(Plqx*q}!Htr@p8*6<%;Lm`GsPL38fY2k{Z5U+4VSL1Q*N6bzK? zGf)g2bGzlO+v>uZ>OQO&{$2dn!F$p6rw4M=wZ8|Z18S#4CyP-#^<4Q{YzVwh0-CUp zIqN+=GOh}GZ=^R*Ul;dZ7l2HQ3eh#^Fp#)j5>MKG2hmHDJ;?N>I_DfHT8`|I@Q)%5 zblE9+Ak@XC^%M*W1b0ONhUHZmdwI5RmxWM_Ir>$AsT4 zyO{rFIwxb0{XxxP|9>~{h=>7cE(QfM`BUe-&pKFqA8!*udl7g`-hiYML9l6(mJK)X zN11EhEY;*2w{;&^^t4J1@Ep>QlF>k$j5OaI8S;2v6K$QmOsS|PwYltkHfZr+8gc>T zg5d_{*P)0!%2F$*ng8bs{UIa3xVQfk295brz5V1jKi?v~x?(6;ScNtaM%2^yMGd*K z>uP*BFc_ACDg4t-?ZFfU)7J8XS30+Pp(@$l4*}tdwMsE$B7V1i4;5~cR)u7y$ZG4D zETI=_Fy$;kIxgE;#G@$%mUdc;;ji#dV<>-F4|NKv)t~Wuj1XuWic~?}@{A(GI(e+Y zWS$D2%Yy=T(`DWo`&8xG0>#W?6vif|ah{K~Dqm^IIuLP5QwHuHZ}n|vYm2`6Y{ENh zk9qvwTY%kmnszXSE!V^)6IA8n^L?y+7XA>jJ+n0mlJWeGQfA8y84lcxtMlY`Kt;*R zz5QR+YN4v9%S}6pyQ5U5-68dISM4AI03Jw);O4bQRO2`@UsY{;V>|UqKyMxo5*C!V zUJd^ye9OcTC4knwA^aDEA8s}_h23`1x6t;-i*5R(Sw_~=0}+`ZqYX>ls0!wiBZ-eL zW;D5i#kafe_Gn55p`9s;aRk|5MTU-@Si2%^>_Pd>W6GM)$HfFwQ_h{7^KJz;>>~N}hVY z{AF$XD)36FEAvqviy=+U>BcHMF$1Jd(m_61n;5(Y$*b~|PZnLac9q1evBc9@4@mMb z9+3_Q1NNZnoi@bzJP*GKG5@3D>i42#=$Srb+jxIz&ln6qKz8+8s; z`#Fbo!|FRxR{{kEC98DfC8{AdPo)$usa2s%@q|LiYVY$h$^+pX$lf1Kl03ImpO`*` znoR~4Lo7r;Q>>XF^7{OqRNeY7uU$s~@9-2h5D15Nw#}5?a`0*Qc`!dcUf4wz6wjPI zS^cAQyM76u>EAnrppPyyVo4^l-ML}B^z&GWdbKhL8~??)MSMLYeLdk#t*x1JCO zi5&^4x=DExZCPE+Y{|9J9sntFIGJU5M! zXWomoC?-n?MaF3Mc-==3G7jet$pV!A534W*dQ%IpCk6l@gEqgtLk@w=6n2#+{x!&Z zYuMrU5?v*!#jN@hvOB8OLYoDwJD*f|y~@eT`|UwSbu0|6OCU~4Dzpw95?213@-kYE zMcEEW!G>};2;9g|ri}X>JBHt_u~AfT?9gxqcUGOG4xQXWdF5Zr@>?qbs$VbW#Phic zo~w42m@*}VCGw5(waXnQ9;|hAP|mjRsH(Xd3W>)pfcC~w)JdvA0;YDt7$xQ5Gg~of z4t=dYS!M(Q^uPx9P`xFAS2>)?&|s(L_t)whXpMHBz6beftH=M%klBWJ z0>-c#`_rt1dk|8O;mcq`!9Wl+f_W~r{8B8*@o)-R@L&y4Ov0C(Av`w6kuy6di`tN) zfV_Rz43l1mb&|?=!@cXXN~VUnMupKzh%gyTP6%~N&xAD6O0;Iv>P&3;>&qiv1#EYW zkK?mb62l_`Da|pHSJQ>uI_yCCB0PG{~!@cb`DJ z{lE)i^?$XHv~%xD;Lu9AC)@2)N!xGGrfGDEK)^@k1~go2{lL;TNfNlRJ|%dJfCTm3hUdZN~HKy1|i!`@qkb+vWT z!vZ2*B1)%#gp_o5hje#$Nq2W6El5ar3et!)NOwthcYTZVf8X~U&j0Sa`Yyib@xtfl zcE{R#tu^PEV~mL(fRWK)mW0vnsuQ&hFI8u?7^|4_9I4G)F|B-CP8{ikqQC`NwDi}u z#L##?nr{80$gzq{s-IF0_RDs$Z+qZNKEYS-)flVa5LrW?v5GbdXEC>bEr)!q6wz+5 z7^vHZ<5T|r^o`hLfnqUlc&o%SqGv`> zvb+O?J?z;hZ|=}R@)Oeq`I(+JvKt9|V*UFp07%qcnMEbYV@h?H~1G;zJ%AYlJ zI{^asFLXZEGP{SW?mFN96CiKPcQtuRXFix71^??p+~}|hP9pyakynV+{&Z}lR}nvX zj%eOulBFLOArAShI!~|avk9CGf|0o<9_tPN_;Z*9y!N{CRidA~Dp5jqFn(DAQ4as) z*Mq>A6BG!R=_y}75>5Z{Cm0#TyPLoDHJ|)S2oVKp63*eF(EmD1mVoyk682M-#HSYp z!Nw~B{A@kGr)T;9Z~gz(sQ3QxedIrXHlJ`-?iu=Kz0gPjIK+o1vM#Lu7+;?$pa>@k z9K1aT#)D&9qq-#o9Jc&qQmJIwzrtfMij)z4iWxZWOuVmmK8mIAb^IlngsN&=c5XRa zA%9N5N=Po9KITa7s+bt?{vQoe%t*j zOR&=OJzBT{@^2#j%CDY^?5?*m>72*>*&B~hMefv~<`0ARpCNWv$A%Od`O#xV>dL@O zkObj1O*{sbatcGpOVZd8QVDUudFqHfS;w*N2K;Hm^ zN}~b2-bgGCC13_XJf7jfTr4$-;$=NgMk?`&B~^y9Y{I$y_ zmp${LbiBP;yWx|VaM6c+}_&cFcPD=ZYp*Y%>>)uaRL9TE!PR=5w+CONfD~%qdn0-Kep6tQlun73- z@9XW?V$GGy#1jELO)8NXhzHZf`PJztu}np`S7UPJ)5EEJGQE9n&hPt7lp_Vg%$8an zz@SJ3qV8lzTU1!IQy$qY|J;bojzF(lN61voI!s$vw^X^30dwfoJ z(Mp3}gY!Yna^6C2O)+?kcZA6wjN%(8o$tAvc_RxjIUXUb3@-J1Ob+Q6h**^76D1!U za{H5X&!bWq#b^o$)f+96r#*$b5NKh0rIq%XEw(Rs9^%*7BR!#DlJ8&(d`o0AN3DMo zUI}S?SRt?pMWIXvK358)VSFg&s3d$BjPPaz;s0LCcK6pe-qNW30 zNXq=-JDrRgKnsB5e8!c+6nA@d(g*O_o@S4Sl=&vWeGT2laDHgI=)ZuM`JBiNXsUpl zH*oQZ(g2(50Z1lnGRIRSVnDifGJh{tjE|!JVj-?mB0*HwWkCDliN0l6kuhZ8P|^?tj{ZnWfY#H-WBMah;icWpm;=mq+b5hF4OzDp1-$DI?7}^;psLg@h1WlB5=>wdGly3 zaou6_HxZI*Zy{v1@2AZv*#?i}kVlt6@dWqw_#mh3oIrWizLL0g0tM6@$>es61^_$k zj{m0g*VzLE7`yHH>)_oa=}o7dpB$Pq)o2)Sb$5UnLxx*ChEC+sHh6n=ECw=h=sVxG zAHN$6C9bX#J?*3ecoiHappl*jGPySwu;EH0puHn9tSpM=|Bl(-5C5i{_GX;pRSX`t z>liG`F0EE^(rtFuAog=H9i6WRUT;&^!!#KGkgF$9GgvPZC$kzBrnR6F>sYunk}Fvc zt@SCV{ojw@s);f_rK;8sfpY<6osZN{y z_iOcie6GV6#cDM(t9Db;6Tizd1Cg+kl!3;=aQ1xf(eg8v#Ldz4o0dOwiF%(N;Nwh< zW(OePlm%)+nB83?9cP6Ge=r_QT95YTUXS9*NeHytTWnbj#&E;EL6+&-l+8A{9y2|T zgU4OXcGd&*WI})Q=5<3A^^zi4O(koDNOPpfaOs0al9TGWVSSOkb=buZrdB~`ItoP^ zLJ6iLw{im#d<&hhNMWwUCbD7}GhOm|L*2iC4@jb`1G6~|+%a8rV^nm3Ukdu4YLOb5 zQKP|FFQ!|I!ayG`VAf^t^nD0IIDC$o7`FZ`tcZQhN&~!d3S)sL%gNJJZq5O6xc6$4 zXGyuK!*lkn&YQ{dA~h!SUZ3C5nS26){`01^@`cr_{mBAGLtm&KQ_|zrL6Wcp>WR-q z;>kZw@f_qHlzupllzO=JL=*X`&Tj+A_W%|3(5P{&x&Q>b%ExO%Z;)SbVy44K+F+dZ ziKP5o;Jfi|&W?blq?>8F$~AzO!mL}XGJ%!J zpYdfM@5QEz;Vx$#>NWf|*W`y@7Kf8qye~ROzaraGj8>%9)?&^t?>XuwA!B)NXrDjj z%L1=w{iBp&LQeTb_7lvQR}vley4-wne*yn_GQ4OcK<|=s#^GoLy8wEpL)Pf1EvFg! z+VHS9OJYp#TS4z<%4Ad$e}u<+o|gG=yEA>PnJ08JNgWiC$PkN(2`5>tHY!9n6yFr8 zorrJQiy(h{(`h|+h%UP(0Exu#rv&505CyH!zu&3e-45`XB#Ce}N*@tpPe|*`!Ry&T z<(Vj7bmg-N2Y8SesPjl_TVPFItTw=7QkR?~0NVUzFg}%2XJ?ytN=3)z`6vNo8+Sf6-h{DkrE8VA{%L+DSVg1MkXI+3U4mA5)@OR`AD zgFEmwN01&b34xtu+e!?BDnC4m+w04xkbi|YueUHK9}F+br5<+(ioe=&>(fFxq0f}i zGxpXTtxGx!aAkW=cftY6Cuz-LIqKms+H&fpv&vUn+$aCU3+YJ$vJI9oPSmH5ZuQ7J zx&idICxmJpO%6p#KS z`eWDG+L8M&P6pMU%^COPQOz3PZQ9<~?M#;S0Ybq1ewf7yd4?zD!KdxFc#9s&+`#%s zwbtFmptIv#v&mJ_*Uzt`S>#mrXLn4c)!lWlW6&(O;~eYOc@Oz=ZN29-u#moG(DB|e zifSp-tds8LI*V@{%K@6Rec`szJQ<0BnVPk^tCQS%)hc6&0tUkz`HjKK#}fSE?TMDQ zxyQ{}9I(roi`W;M3MAh+c&ytWjeIL-R;#soPo-3fc;iXS^JqEMIy0U-lthGg*5Gu< zrAw`Of5C&rW)@%YhV>z{IXZh&&Y&>p>XIy>nZHe+)ukzb%6}Q^uG~(9v8O7Id`529FE#FPtuNW@E)$wadv> zMm->`te<}~{fo_hL%hDy@SD~b_Sg@`(mt41xyohTg-IR)fykddTW((()<0TzX9@&m zQ3pZFa9`zsYN>3Fq0Bo!MRuaoap6Kt*OLgA)uhD=t0WESW+poZ4`V4 z!RD)L^DAjpp4j)PpSGulcfMuPxAA;K|DD7rGq{*LkowKANJ)3zxk(C#LLvX-)P>s> zM7vd9vxX(`8f7qE;7n$4F#E14kwA?Giyn?s3t)TIgG^`S$&ZZ9yzWbj_)g5$_wGHp zlYQ7+7l1VpyXIQ;jM)Ewlf&i$_VU!<-WsLFc9cxD@PQ?EOQF9d2!3^z*{P_ zBZ$;KSJLi$S9Jwx`euknuFycNpa|WunCKSxNcIftcdY{6OQkSRB88?J_V&EkRHC*A z=~*>WFt#M6+K%S3B-V!%kED1MTuv35LY5VZ(1VE|izW}7!`UMzeY9&{nho7RHfaD*|4PR_wVpWgD8>#UxKJOZrG=U#pM{TF|pEg`6o>7_NePi=RkdH zeY;Aj<_|KHlkON2$S8zC?QfwN-^AB?bCCsALBy8q|HqxlbL(4qE#0)=rLT_nU6E5d z(f!P3eLx-JhFQfqj-{U)NDKQNe3|=pn4n`2qB=9OMN-Y-XO#dg!|=?C84-PD@zjcA zzkPDjJTFJfoX)wyp|7!Yp2qTPlG_1T;bMhF}{RV5NVJ%fokjS!sFW_<_g^ z7`Jx(!jZ+B<$V4N=nz(GUcc`r)93@hY=E7M>~#T*(PFd5dc!S9KKhvwX)M)9s+Wj5 zSV7kPuHJrw*`tlgUZCvDVs%vN!~Lv=+xNgngK-q&g=JO04Z|vYoQ-D1zJy25x(=)Q zWAUP{q&&zhZ!OvZZBNz7V`PT2r9G8$9Up^9bL`3ddHhn_yW@DRAy(}{dk*2UfMb~i zr}x-fPPeZi&zwRRX@8BExH*{?L9&1ng3+ALWU=X}=))ar@g#idn>76~hZ(^;7PwjK zoipU2UEtT-PtQHP!a7j7kToe1LoC!^^M=JruJ4+G66AsV9|=7gZ}t>c_l3h(E#npB%ix$6K3|Kq8TbDNcoo^BHsceU#g;YExn7 zC9nIEhoJ?RRuM%eS$9HIexSXg!TUziRQL|kR~%i)75yV`G;vdy0<`H!3~|$&Zx;)0 zNO=6P{&(vd$LF)uss6=OI;<6 z*&zOmIB22r!beW_ra`t7C9S3GQ@_n08!6T~8yzAAyNzDMv}UJ850;-R#pY6%Yj5nS z({>^$!yQex(Jg@Dkzsoy1KKi2DpjdeBlEVwlV*BDh*d~9JePCS`mqsV|!g5>J}lKw|tilQ!05II2b1r zKdoknNKOz)k2F>v;v)C`aCStCgg#GEBhWE&+=ji0NA!eWTQ?ZdV!l>UE>HSBAkW7D zLQ%3U-zq4fbHN5yGX#G@QLIkqbm(pDa&&hjyxiHDYj(VA;2MCtp~j&|VM`xJ^dyuU)GM?)%w5*q=E<#}# z4z{1VQxB7?<*Lr#y%Ch2cn3A*8-NgD1G}>r)qHm?L47BgI6UN=&4(#7?!`m7qu~uZ zkgdlRHdusBFlNKq-&m`n4C)wj8P+Z(}JqB@} z3qeu1ru#%c?P;aja{d!4x2B3OeG}xiDk4b{$18|Nq^h>TZGn4N#ZcxuIhk4=PfEpw2hp~IiZdEKOfM_tj2}_-`QjVhUujAJ??FVHL0YO!~ znNiiIoBkD{AG=HqCt`d1%e;jJ7uvtaB^4;WDK=JT3iOh|86->=KIKkChgCQs$JIXNwD~4$*2R{BPFSK<*Q6J?0=j}tx5f+>Gtmp}bA7Ri7WNC@HX-wEv@TF#X zu|-fE5MvrXi<7*#zvkBZD4sG-b06q{i)+zGNQTN(*f_ZZi5?>2l-3ufvVk)LHSgM%?c99q}!(^s6 zM+@8PDjO;r{GSLFk^jK%JroSun!IQZPEs+I2}W#p33M0>h9wqMR7@fp_2j2({07-K z{MzIO(1brH(d)x!Sw=B^>#3Zg45XI$TA&gHg`Zkytk|s^shYsP={n)I(ZZx?@`vx4 zsA5`?Y#zO`din2(+b3sD`49(43HjRAmG6E_KjW%fxv2$GkOax) zOm)(!uYWaqj~WkzX_HGvOXIcB$KZ+V zrLON{%fSk76gI<9mkWuyAeTCec~e=6!oR#PR~FX^G2>0n_qJB(VU`>uwLuT(hr8gc z3?D#dNa7}n_&{xM6fp$P{R8V1pU@2Yh*^q659pWa(B6$@F0~fW==xE{+arvT^!YI27=6Ed z7Y_8cXh%7sFBH`}=t7Y2h*fJ`Cv2A!Y2*JPOwN@DMBr(5&Z)(KZOJUl;xS@MA4Q!U z!sVj^6*eIV+O&nM6q*2bXw1?ePN!408et=TcI2+oVe(T#JKynZ+il6H@z2ZU#UZ)+ z4!_5bXycF2O0ZN4J2xbJ(vJIBO_!>|;uO8NUy@zGq!6QYd!mEr*={7}j9RL$`7GPBCYdX#1o3 zXy`|jYiF zPePF&@`=kCN*T9%!m_+t%JziP|LM-}5wBm}zD;!I$7Bn-z@H zdF5=wZxTpeTr)PLIr$YEZbKgpsmhGK9A!&il*zu@Ng^>JeY>1xEC{nze0$?Zm1iW` z78I$DXdmKG3xQ5V_qI;S{59`^hgF1N){A#DaM+U8WO(-N%G<%jSeAj3!tjP zIam?#n}k^2st2+81(6XR`+1$%+(D&Sg>G&Dg*YCu@_zvlXLML+hpm|!5oeg|x4+4T zvjYyi5^N{|X^FH;1~-wsA$EZ`Kokjsn2r_7=CY#K=U%g+;RJM&;;@;?d32IR}`zcP5g(Rxz`_()19LfRC z*-rkI17|rysO|D_`MdZ!rA4ZpZCBB*OuW@U8LYPLImk8Ro?m}YGUWKMGK z?dN6jXPr|N3XY|1i|-=eo!%iw<(xp)-|1L?tIm{(M61}HQ9i}m0LyWpD>~I4VkG`{ zFyXu9?kv%p=-2Tb^uq91h>@H#ycKNM5#;Wf>n|+TUvyO_;lm&UXFp>f*ba9ewkWtQ zkEz!)Y>_K`UWuFAtm`?Xo;KPxh}QwWCgGh8WzI>@)?dqAeDs2}jc`FciWp-rZY4SX zElFUZQ)3(fjr_qZkI>?9n%C^@FT|?#XId*K3GZ}?_XJ+V&G_e;Eq{RY(a3YOv_~QG z{4${DGlVmf|E;)W2zH(5*K>hYR9T!In3ECJDSib$4TX2wZJd(N3JgR&_>Wk!IG3+3 zpeC!=;Z}FMn^ZR`ifR0S|paL&R5CH$h*_SI2U_TIE9s zW}DJH@^UXh>jhpojh6i)na1mBSj&yBwwM2a*BY&!Tg|(@<6amt4)q@&I?O;*3Y!DP zNmMIH%?5|g*v2d5V4IA7^uK||B_4k7n5c*D2tAf3<+ddUqSo%N9Xs+Vlz)_)A2|bw z&yyV2ULvsktEYl<3Sc7Sg;a9=Ux&Zr*3erP{@2ek=zz-1C|fJ?6fRwg1!s|mOu^Lq@=pmO(dkdjenbLehY_B_XMtg2KW6@!ukIX`o9Jpl@Bfr zm_jL)Y3-eFf(DVoUFc6g;sK&(%k)4@_K3U9`sH5Q;NZzT;lB8=_<56Z0yKzBERM{< z?e{AJtL&AKC$A9o2#ys#>hfsiAsa&8{g%X?^Jztumt_$f+x4>{ani$k_ZlE%pHIfg6aAAHeG*Beva^?(*h}c zXwJ`zflL*lX2&T z#DDzg`I0O`pUx3N12Bz=s+RGeUK9caECz>!lFUz^@GU9>AU8!%+o1ewF@SlT^{8a2 z#Q&JvfD{Fr48#=O7T^EUY5#ryt$vRa6E;rjUlY?`67X*fnCJdAWJ`SD9`XHqa{oTV zU+WY9qe7bjXa8Ss@sJR#1}N+^iyr6v|E*yU{v)kkG+7)2%EzKB z!V&#jVXxmO04|HziP1p+4IumU0;k1C-}9H4nD44K`eW{3kVQeq#uT*dWW{q6423yE0ir8sp!x=_4VB%eEH7%$2E8Mhpc@jt- z4fYxwUIKFGBatT_2vLFJ8;ALAa0YLR=h?UEAnieqpS3_|@yJYiY(v7}cI#;01+NUjAZ^4TfYhgH!0GH|q*t;#R~J{+`I zNWOUFK5;l5gbow6GE$=L8r@6UO16n*c z9E&uit_}?{&huuV+V)_9t8E9+rh5XBhGsgEgL47>MSSF~SOno!g_l<{lUpqtjK>dP zZHWetiU8`h%(Erhs0>O3C6=i4sG1i9oOF5=pjPro{7UBVNo_Y(9%|uDyhX>4&>_tnWc$mwY6uo(I39o%Og#qE@QT+H=NCW)Z*vqS{ zo?uxXF&GS5699OEPq3r$7pxTGpNgz0N?nKAm?!b@0ETVq}UhA&zjEOcFVrdhRaz( z$EREJPXw}D)WfLDt_K!ij<9dWID?lyn zX#AZ>s#1y60L;%WLx<}aeg`GIOHeNnD^VLF#{RzFzvz|t2wJN}2ur1O%X9>#N)Qed zHNrm+PCDHh=|P!yOWK4ZW&m!jv2GU!Vq^KT(0XsJ(;L@uH}2WanPl6alVST>ie|bF zwg(%W;?eQqbGyG=a2=rMdAOb1n)~bS|2GG%UqaNGaX-udDoh8|u{1zP8v}WDf@6H| zJHbKt9v%`RK^@Q2f&*ARx7RA`*wAbo?Q(@B#hhk^81S|*365| z_9FY6QJ=K}BeH9l4Wr>vEn12k$p4#o{vV#Ma~#}vyen^S=U1qN#)IihvM8Lolh=3-+Qe_>i8Lcp(8#sWn<|d`a}& zMR0$kOmP-DVIGFcv2L>s0xSS!{7v*6R3yIHV4BP81-cr1&<&bN+UqSBO)dQMF(Z}p z%OidHILM8Km!u&z$Zrcnv2TSMRF-`MP79RkB-OQfMmAWQ2q_i&qHdvf|qleJ~_)$4G33`)E4m_BcEK9 z7#X6jW%+hXKK1_umxbEI%jRcKpOY67Ex~($3`D%74KlCp_-!w4y}%OV-<9p17fYul zIgYol$=bf~3OW4gsoz1Q!bht+5r{J$bX&op){T^+9t9JSvj>Pg|Du5V`biM?o!Gk- z>eI7RZ;o});iC|P1b=^No$Y_C!Q)>J7s;OC>4?+LVFs%I@ngaVtrRGp9Dphd`(4#_ zIsG#D-EUUpC!<2>lPC=I2H!H*1D+1cz~itOEqX=%vl%If;;})bnHZSz=1EBD!;;!6 zfktq#KaakMQwc(!|9SziXkl$#oooQAit_HHlc)6}T6-AS5xcJt-t=oZ{d(Lp*gV$5 z!KO7`b_l*wHs{Ugxq7$B<^k8`g9BO^WZdWaj}5RuV|vS`&p{{zy&!V(yPI;_ zM%ZzU+yMQ>$fu52AAlL@`6zziNR&tvelm9!l5y3b+u@SWN$KP^7pr#j@q^2e40{m0 zHgEt5NNIHkD#d^$w&~1iaC>KA?vMf;{x^S*z!Hzp(zoC!5RLU6E_Z190I z-5+0(&vJU=H1Rj~g;||RJg>$6bVV7b*myn=?`i$;)Z_*|w{fv&R5WTFG>0sK)?T4V zOOx4Z#sGP`tUb%UGql&h|LP{SBMEF&cNUAmXmWt8lg#XKZ9l-D6i=Z{Gt~@&N%5v3 z?l|iopDG?y2KN9dBS&wocf_mp8AaaYm(yA6+yOvSnTqOkkxFHXTYs;f;(^0r6+Z&B zS$=_tF?JY~-KUFQbrRD3M0*j|8$;v%+^{b9=qOtY+A&iRE(|JnV1IR zaN6^OMOxsTj98<7aj=-U>`L2S`DpcBx9IU^Lf44r`Rvru3N$}6W6{l4p4|#*=s6S& zN-qJzYySz-{lD=9A1}ey5^Gkci%^x$rmtxJfO9SicDjg@8rK2r9)Pyxh<#B5#^cnW zOK5!P_9t?Q1j(hGtIJDRVic8WnKV}0atZyjyR6c&Jkj(y+&31+zf(ahA-b(luzT}m zF&im3{U_L{!EwG!wla7!#gRW41YeeF{UD=opw9Hz5If-Z$oU0B5G+$|a&AQU)AiE< z%{Ph942Xn+kFn1+E5NmrFL%mfDfETe-1gJlKV}C`zaj0dQil$lKb<2M3Z0tmKoF!h z^SG_3Hl1gma%|k1DM>xOITCqvG2unz%W*#)7CBCbhq+amsIWKg0iE?+5RT}?h1A<1 zp&u93)gK3tv z{4i#O-Vy_$pD#1+-g=4pbwt|GjullqhVljc|v?r|EBrlWMaa*OE?>yh% zP@FYPF#Ud$=GUy(U*J&sz-VVseii5v{0{N@U~SEi$@l^1>&aeVS=rmkdSnFieUkQo zA>`-pvLct3SY^IkedU792P~hY`p=AFFK=qDeE(k2IKfm2iIM=S%MB!)Q0r)WHW55v zgg)6jVL7`R9g19hXf>&5&+4WU@F1id=vLH$D6;!Vp4mV^9{x_RAO4|UV^qm=cUGCf zsGBg4QPZSQ7)7pNWkO`ACly3?C32l~GmS1)uih*55B441tq*vKZ5%W+4H5#M(Q0d2 z0*}i~w%UhQAK!e$G@wBkogL~z$k7=ul<#8AsvCm~RPh$r>h)AOf*^MR+0OaA<~U!_ z2Ux!kNJM@FtYKBggVh8uZNBz+Uxq=0!sMgQFq}zGTrF?f=Y3=mrQQNSoZRo3v(L-B zHuy!o)?(gFa3R#Nub;b1`!Pt_IKRAit73C3R`ES0#Jm@dLhCqPDaMD{z-@h8?iD3m3y(o*P`msF_f*MpCg~=$_OOXQ&OxK%GzHZhRg*3_ z^szHrS<9{7I^=WdGqdsj=33XX6wj+~jd$m>a(vnBj}qb{N@g<9VgjB!3w7%=#7|S6 zFXW(i9plR8*O*A45y0x=$v&<`v@cE;_8{aZ%I6-wxp5fHJ=SmW6n?HReLm@ERbXSw zU0N?3u7lc_;dx*0g0zon?Xuu1aX;qbU;n%!)YEZM+)rZq&fy22; zg_l?2QFxz zLagi*>Eq|3(f+qE43d54H1CX-miLW3EC<(HzT085#nV-mDe3z1FtcenrlPey^0_IK z4V2cSpAAo3fp-P7rcfQr+1wSguaHSuq^z$V-xVqr?cFd!cPZ7IDcaA~TFzR0E>x%}7`0l6y4@mI z-(oQAHxFOiBNnpQHc7bvO(AQ>t*3rBBJU{!xk|NZ?}U92A{P7D#MZ2}pQUow_(ZV~ zf_gXPP-LbX`SgDFg3EPEfpO}7 z;$#tU;%0-G%x7k5&5cJtQOs@<2A;>AL90Y%(6u#-L4VnsuQaqg!(l9MlCRF+1H7+( zZq2qjjCTs%wK6Vk$OLS9eKAytmcTlu79<_B%^w#cCrSliW&vpgk7XLDL{0a3u3?~3 zfoSFhhj4&@{e6XgSHI(_HAvFV^|>cOLxxFhBP)acwCP%>MeZsYJO_2#wOlmj6D|39 z3k*sn#aqhsVJGuSZehxxy;^PRRWILwwxKPI5H!)?xe>&>k!KcdVjk0^>=>47|}xp#;W6gd$I`mtl(F zu)fA*WU))V+NdtZWwuwT+>pXMoL|ANZ8nQ|Qk~u*o=ox!2?2~3C3h2xK>L!MXu{!CszG)K zuMZy*<$(Y2HW0ji68=~>r>O=-yy zA|B^d+5>TmlIid{tJM2cX2Vdl*Q_vGQZ~r491t+*JfcMHm@%=>W&J-#xMoE zpwLxRc-B@QNcYS*$84=TW%l?@Ilm)NFnYS^gJi#yfAn~-+^&oF-XbB5{8~2HuHN3tKyumI; z3aUT*lG{$ig>=T2B!azME{$@|QoVw^0WIC`X1>62K3u^!ClK+#Y6XAZ00O(#W$JeNAkc1L^8QjmDuBM|!YJt8&NC`sbhNCQ0h!M3 z{=Gm9Q@U9IIbPfPcD5^?WydcmJs~mFCf>K?Z#PDcICq$~HLlMOtj(}+!!~1Pqw+*e z3uD+`L63G%2J!O0%26IlkJT;{c_oLp1UA^cZghjC%wO3B0l{0w{9 zryD8FLhv1-Kk&0PFSGVh;TyhJr?j&{Bt~F;@aKO1tn+}t%me9XjKhJ=`!SKP=XpgF zDy(Xi24X^^4U!y7b}A&erPSsL)VaX~zA)`%ioFWCT(D`rY8O6vY<%82+{-b238vz) z?xiw`l-YmaFD6`HerDpa<@}4FCPUwm=36pC>^Am}jpt|U?x)Lu6pXI=z?AeJO40Xz z&u}t3AHFp2QRkERG&CR7D8`ZHmQTz? z+J7|Jxx_D^CfG(#Tk76`6`yUl6)oX=`#dTyqAUhdkPx@T`ABc1*u|biI;&8hhYumJ zLx0hvjUL{OXT)5E*<$l!T=SSrm}F!;sM(oj2D!x2QToHH0k6D|&TP9#(ub)K{h~Vr^0nR>>&j-~;5=QhAtp>Yf(v~s2MkwrcmILp){SmSK;*opTWabe?@d|En zM#jY%oViZqjqu+&5roXkVE^{0L*`9_Lxn$Gp6A`8hv_@p&c&f54Z3WtqC~#vf#m4R za3cBj-XDT2BLiJu2uekZ8(_`&c7)Sz7O5817OR}^QpgV;l&l=B+1MPHT*H`i+?)B7 z+fK<^FI%X7S~F|?|U25m)SPlpUx#+yX@(HE-z#QVU26O4ivQWrfq`VW)?rV5;N zJ1r-I+lxckCs2j6*z-9Ig0jYS5=QRJb^CvWl8>b$-k*f1_ktzC^j4Ao$W0zI`Xy3O zVRG(ib$N;hIm^R+C+GHUK3S3q_+|Ulg8@gXRf=mV;Sv_n-K;rhFXF{u+rJJFeHOJI z1d5n*FA0V{vbsxtpiuD65e?e^4Iw;UnMWM#C+yE$Tk-67+_-Hr^JLEYx^FW!6Ke`Q zhiSE*3f6$hnGPf$8VYO_*o{se=3f(_VNwPCBM$lt>!AhJm%VN6O_gKc` zU-!7X1)$xk*`$}5y66gu=?`)k&{-h0YW=n`Jfc)66>Up`4A8bV-9I_D%t={a=??*477p z2l%zHdr2r4BaFjco!|ImYHcjegf#1e$2lY56egsh{^4*_db-Oo(s-vo48O(VTzy-3 zQDHvR#&EkKW;DnvdWy$5!``{JC=vy^dNCbFYMbS6t>?(L4C=BT@C0CR%fl76Vm5rdcC>7 z7|eu2+b#dWu2zMFtj$vpLsbKGi< zfGMBgf$IqMwVwr5>#VmkKOV|eWwo33X+!YmMZ^=GMOv!wrt6s7WwpvC8$MkX-Z}3; zD|J3BG^pSDX7R!xV>%2Assg9n`18w)hh@D#MT#t&}`i8D6r+>Wr@K6P;IID1nW}?m3wg5d59PB?`_Se%dKmicbABodPD{bMHU$sE1$DH%stwxStq(){@3W9ZBEK+p z>Cosm8V_pG9US#3X3$O8Z_xHA?FF4QdKG7w_M^EQ9n5>_SZ|zv`C-&(jLW?-wPp6B z=$xK>nB{bmAuVi(ay=Zwr`_0cMVmwN(@Qi)WyiH`hYrk@n*OUrL<^^NwMG+&50fSK zm;Wp(E`Q~UnUff%x;jpfG zSzdW5=-uXE8NKaODo$MHk&4Gj`DHNrz+cH)p)VFt**OjoC~z*w?tu4IdYEZN=M0Zk z4G*1ub~#*!2e;=ui)7gZj)p?SkAc{5)Mj?j%$ z_BNeb`1DsJ+4)F>AIQ9{Z(6)tAy&u-;zx~#a9|wT{wP+ejQTDW>#r@^@k=*f_~H$#(xYT1zit#52ORUWUeB z+w4kfwlvoeK^O%B9xuWfBC)5CahV5M*EVP47a!>II!td3kEwmoBSoL@6Ih&HnhHm^ zPT!Vx5su2RHq5)BFx@SbyQGGvUhXz0qt9IiKYBn*@QNX)ZNpu94+ zr@Y48kSm~rFiwz8_S-xAeCgGhO?z=a2+wusW|Q^!_;rP=ba?m!?JfyflI{KRti=y| z^Dj{?6P&Gcoi2Ifrd??n-1a^zx<-S#$XQ+qap7zMH$LV%3+=7WO`(0DnlEM?kzW6j z@Vj!NgO$J`(%qJ_J$@;V$&@o79#ra;-#us*B<);x=#ZpKf8i#lnzUf((r=bT*j~ZL z5bBaiWBP-A@^Z_%MJj`w!T3xTHeexS8&P{ZD!k2>g+#s6xJK3-A0ubfhWM_}&Q)%OPX zMYkmPJT!RggZy=`b=41fi85x2ECa+f>k7Z&Ekq{^)UGrsN@e59sb$+Qu`^k-1|45v z&0TP`!S8;PP&O>c{q=Kfd~1%a3LEB?EY?&o-y%*IX~KSoxcvYMW$K>c;(N1F;9udC zqd$2sSKuyIbr%=47}uXXk~}$4cD0RKW2U4%@=b~q97yJga<9GN%a{rz5^{ADZtFIz zY6Ws+iE^C?5}kIWpE|j}mr`laMG5O7ixwx*f73|TGcx1|tAy+VLV^61@2bK`cWuET zuX^J00l&W4Ok+~C((ye`vaR;yXN_V76s)VT)t)b!y@?c7r5+s@37}i1KyN$^u_9HI zdDP5O$~aYG3?+tm-(<;;o;-(zH{m}7hxvc$3JE@QKq`=X`+0?YsJk3uUeZlyvB$c! zPVbD2qO|KZl^pK^MVbt|`$ab6ePe>N3p7D$XWzJX@ay7g5+riDRnge@5`k|DXL&8V zW&@6~BQbgtqNh(13ZK2#%@UApY|OE}Q(L#QQE@W+L}itxQc7c8`%Nm2e|y4nXiUD^ zVzI-*FW3Zl1A_Vif2CQ*(#Iep>$P688t!6Zp~XR3o`_`J-H*E+xIaOx>vl$INGeh* zi7ggpYT9oMAxns-;BC0{67UW>X{aHIuYRic^4O=joK@*RbsNn3W`RAJyq zODJsp{SLFm=a-%ESQR1M?GQn2TMIQ8U#qPqehY3KVhwyIsXDJp+9D_Zbm`810k`qz zWNc|P>X0GHc~ z%7&^&$wg!gy*bX`n2K|x_v{}iO>dI0hH&@)hrPE7itAgueuD)K?(PJ4*Welm?vP-? zf(2;Y-66OIcXuZQch}(V?)EMAe)s>~r0Tmkcc^lwN}cm-o}eU8hKjT&qgQ#`@o}V^L%b-?_U*GR#=0ytlJE6vq?M`x;3^eW(VkGLd3|CJZNP85h#RTkr2vC zoV)4c;Lui*THbdUl46Rase_#sq19+#&u@2c} z^tz3zEZM*aOC*u%kex>^bM|~6$ESg6M_8+;d?fkH3u7=|D+}RCoG$U*9lV3?fmbC|n-;l0}~ z>OeIf8reRI9hMih85PW4A!(tDVd(+pb&2nErqL$ronL-+_SuD=Sj=aqeO@h;N2Vwh zh!?*Jzv&uG{%)!`ue3tk3;;ll?sjuBfn5U8Eqlp@^sw!@Z9+SuC}L4sx`9~M5R}c5 z)>1}0c2dxXESqeCpLax(+E&40WQPOzR>e54;KOfS62RAQ;i&z z^vsUMPG5kewtp)75oFLQ#X)2#mNK5#A`WYIY>Nw0GTCarz6t?tYwwhx-I4d4yW#{f z;VpF8F%z%wEz~wvQ4`eJCQAW_O*LV*Ox{-atx*3vgk1^iR(%iCRVOF83A5!p_`V_( zaEXPyOM>zV69&l+$Wwer{%f9?aOfIZreb6=IfytmDbn4Ub36><9=6ScIgVl`wG#FD z;_@$>I7JiTaSWEyRcltH_#j#nq8UgTHUFuLrNxDUQ4Pzp z2O9)ZnoF}b#^3Do5E7I9$pK_=BEbk|vR{hGLNz01xUq-E*pvP3+;pQz_wf9bec162r<Uv}^0D zbYBG@PlxgM2HC0X_j^iUBhk1dB5kQdN$K@iRPyQU_R8TsT+6iC-@RZF(vd_1PwIX? z5ic@%ETtF|DQ2|in{Q*DxnIInx=wXt9mSXmd63}x{m3H%d}{CKp;3Pdqs4vfV%p2q zmvpQ&lNO%;hKO(n1?E5UdHs$Ek0B7(cqFOM6_YrHr}kbtsi+_IhVF5t+8Vw~VlDXVbDHAb?Idtbg;L4Sqh!m1mhf!msF2Z_qa# z_NJF%yc8*xIEsG4uJy!n-(e4^61YcN?5VfIA`Tq=X`wA?+ci>6jN+Nf6%(my4B7d; zv3m~HupKoN?2a&jF52A;MJwwDsc7)lEd1e$;6BZTXWYrYqtUz&8{bWoN|-e}^#YGY z9FtLttgadv)4PX-D>-$NxkD*>1)0>Ntw|sX7Ln3d!T5UjwMVd_JjZAbe| zgeOiSH%pjFmbsIK*+pDnR}(~&m`zj+#cu_DdUUpDi%MV+L|`dkQ@?y`g$*~ytg1(_ zAOCJY!E%$$4PnM?j?Q)H*??o?VVBpvYZ~(G{!aD9waFR%q1#l99=a+#tf{s z%B|Q`AYV?12Te7kV*XF-6xMLSuG`3aDSIMO!`fmT*%rj3G9x#S9ep#C;_Kcv2^7w| z{jbRGIWny!@@o4gTqXn2W1?Q=nqe>!6RL}{%2YME?S97T`_j(oV1nlSzcdf+NOig* zaOYP)AJMAi=1-?1j479PGekhG^AM@U95*7dps)?541-3; z1zbfrz|d+n=3mT=^wljwCt1c>Bbqi%rCrvUt~-y52#z3=f^3)S4wI7_LaQYvKYh3$ zHX4=CC|<1ZnyeL4Xj7|6neu&P%w(v#TuyS)bn(Mw3M}cJS5td7o|T7l24har>Ei#V z<-D>?hTJ!@OjIyM$X>igHU*6smqo$?*7FC=e-fFCc6b-1cdi>Ps+=X9YMpp*&BEAE zDc$Tc^X+G^JbjJZ2a;51Xl&YPu4$d$w?}**F~c#(y<9WJSmV3Nf!8H8 zhhFjH&Hi4i|Am#mJs~C=uDkApsBf|5!$16-6%Fv`;F}W*thpp!$d^VLbAKv_?j?8r z;)hjh@0*Ogo|ZlLvpW=@_K$LUbjZq0sLbM>pZ-TF-M%jYD0eQKs18v6(|-Gx*+Wzk z{JD9BPx#B~&wp0@|Ni0s_ly87vj1-zb&xmH*=|;TK{PlYCS?QS+f4B=+~NXrfF=Z} zr(fXRFQW0PV?fqzd%h(n1>o4r4N5oxPbfNLSuZN1E??E|){qt|b+qKe&FRqnLY#iFHq%;s8LuE~j4Dr(P*1v!%CO0^rl z%wJwzaRg)tB0UmG7ybZrKT(}L-DVIT2AzQ+z%;P`%#D~ujA>Oq8BYU!Dilgot}qA zg>8c={l8iCn)Hd%%ecLBJ=yv z>?ceHO>&WdcQL?TadPd6c`vXZdvIfuC}7|}m?E&)+VUxeQn6GPr{KPi%67E_%Jh1O z({{c4ofnJ~ts2AbOkFyh{|*ZPcj9*42t>eR=}f@`V4<5A⪼5HL8qbkDIO|Q=1%d ze!W>`D%TSvv$YPDXCor3w*Imy9h(hsU9R?@M~mV`l}^VSl&Ef3vLe!gC|hK7KQ(8o z4kexCT>X`D^2`qYEk{RZCcj%5gV1NnNv~NygDqcAFAgAdb_;wE>wAK@H@cgouKcpA zSdfSKP^Z(B03)St4Inn(OH3w8_-^=%OP1=kkj69UL<8P|ptiO)d~RoD;Q#fLG+La) zfc0sQC?t>(fLpvPzdsdgBoo&=`pd^?x6-K6ZkwS>5QxjFyciKY6r8IvL2^ht#|sR) zqT#b1GICz>1~QeTR+M%pt|hib(p}n2&yBf3H<3cv^t$y5wtF=k7PDUkzX?6NU%7L^ zA>D%^GV+)bsg`MzkSX(hn0yql%l)m}`l`e3^$h4%$4i^preIA~&1XtjsTJ(aW@;lG z5`!b<*-4`mCqnhpCkx2Vw?^WDTwo{}jmq?u6H<>S*E8kRd*D7vyeNLz{9r3uY`T`z zmir*wuL$HP4B-H_k~mwV0qIQ9Aj2*|u~)3l91zE5Dm769Xi~nCk|Lv&w^MlmjM+_- zo?Wm$mC*JyK6g5RYU^67;{lz2<8`=LCl58MVtQrI%Bq_!&Tgil$MaPbyg)Mphm;P9 zNPz82#`oRv@fsN{yZR|CQAJ?p8yaLLT`$zh*4b15JFgHIz$`+(>-1_UT5tGg`u>-f zN0;-ZzYnP?<29MToGTl}*m@@&U4XWnp~H(7RA2H5uICPRl3R%QPm2rZU`19psa9=q z_pZdE7?42Gm20ZqbbT=99B>oOuf-9B!wYQYyYxc#_*s*@I9n3!}f1x>Aa>q2}X6YLw+!3jFGCCti}lD z@i=&j0}3OkNf>I(lP%_)w{Fw2IG5)m(TsWmF;7NQRS5WOv)P|A!mQ@&;>UBO{iajg z^Z@X#9C>f67vrnR5%7q%)1P{w=L5!wm&7Z0xP~4;^VD*2nW9k@YUh6R;G}e4Ax-cE zxDt{l3)oD@n~|fvlh%AEX+`mq3d_B2usK(;q<(Nk=@VH1L1?+4dx;Wyr{YiW*`}7W z^<$GC^#$Qp-~qM=pdpK@EzwH${$?SOPGHVk{_btXMm+&Lk#Q5x-E~bqzNwz-*u4`0 zUhp4a-%4wrrC9Q9xP+emYpl_gzI>xsWrLivwzdo(QaLg|{;b7Jj$TCrLZ<%8kxN&p@?aDUuFHC3b*uUDhK*yxW@QC=EGrQ>JZP+iYww?#MZ zu_A<_5WhKFVIVH_QwZNw(aO~Dt(%w|bSAk{?#Ec{MuM62r+b8g<@_i>_B)2&CJ~H2 zS6*2fAQ?7=lx^Z?3@XG_tX3`2q_3*+f60W%AQ*OgwU>CJi3(Vhz)%#J>HbyO*^7NW9~O@fmRNaVf-^m zGTONd(@&}dqL>(O0PodgQULzeuA=qM{a11@c9QbFy%fjYX*r^*eRC@;#yyX#M7jxY zJM`4w$Z|H#SCaHAh(jlx#UCKI=VTRNnvz`ie|H!UK{QaPTxy|MS$sY0ArX#CAs9iJ zwQDJrGp8n3gS457wCeKDI{)Pd&>?L7W4=x(LPT0uVap{TNX_aJ2t*2uu|cE6?pcu5 zvE@5zJHuTUh3vV#mo0uGdqh~CS+$Ua^;zk-_8)!yRLD`DM0EBfBZM3LmonkyTVRM@ zZmJGPSVFniHfAAkQgoses8`oR2%OOm(B#Yf8Vvc%<)`3kjri9~&FFyIpAm|cQTVS9 zKK;f0+6hB`q6kxeN#Ub90uGVhpXDj!RJd&L;lFm@Uk)^|9+Gq)%S7V*3YC%ZdL8Rq zNJPMsJbAD?1n7Z_ncUX!nitu|3h6JzBuYR#KtJ4U)dP&y?xbUGe_~L+x%K^gCet3( za&68M$4|nCeN|3G3MD{3K&17GJWH&h(LaE9mPB?b4FSK&xYi`&ps(QnB%3V)*2bM~gAz8=<>)L$GGb0t0JF|V@%kWpZLpI4i|DaJis=y60d+&gZe77k9>zgB;0r3&X;S^t6GV2oHyx|Z zZ8tx%Q2yCxFjY`5T@YVR;1S3$OQnsUs{^oxxAx=Y_ckDA!%^Y}z?2t?C#c(c_=kJ8 zwR{O*z*f}#b`z^WwIt~WgGxVstI4r0Adqk5bAM15DAi!?JRMBnR$?(8d=Kbde<;tA-xXzyb&4JCcSXv;MF;YMN_-@hh#msllQNFWKmTsB_3=>y}rMi4hXPu$P06BXc z;A80!biCFeoRp!0sG}n6_D+tJ@|I%(IifZXKoSJD@kD6UO6mCBZ$1D(`IS8dZs&sp z{0XAj4QeIBwBV5LFgzJR0-odU^Hy9)|Aq8uo{(o!!cFp`Mh1=UfnAO9>qu_-Q zx7G=((P*LZHNckW)xG*)4yh}>0nyS!^Ehcb5enlZ0re|@hC^R{)v5&1bqql3xxhrU z0RTY40-ccu^*4IJ3B|k+O({pC8~t1*xkzWw9TpQy z!(&|n&@5%N_@6VcSY2u@NUqNP#m&ScaLDxBE@M-8U8ddLn$>f`4O+zAzx0IDzuTLM z$7cSL(6&OT>xEJLx%IVa$V2FbjWgP|NvqlmAt+c-x+|q#LL~Uvd)J{4m0|;M@v@dh z*;Z?0VK#UxW)p+2%&LvD6>%kLLTxXzq(HBF<@d{Cys0~0V$TG>M2ckGo4&y{1I>l3*y<5JlV>C_*2QItHZ-6^n+%H!=#4>!ypuK6Lz^`%O;1d6u{t0 z+3|_V1FS%|rSW03D6c^rsL#oPyn!w3eXLA;WRxMT+8^S2t|YB9WimjWHFQ)#!?N{! z8ql0)`Df}0sHo>HJnFui_N8!Fp~$F8M_t5@vHR76YE?-6(Igph_=>|6z6r?#b zRv`k-?Xl`zZ3gK6(>bQ9-%;UzihL1}UKIN$Mc2qeK_jf?xzv3_<#+!6lB@8;`C5le z5}8{Aj~u=9Yc^#TT%uc2Yb+q~wM$!PguxaiZ?xYfb*J%c-JSikRw(qr1zAc-89RIY z6pK++cDh8%@L9OqT(Sor;y@Uv(Z(Lj6|Q|4Q5(odP9;vjvZJ3seKq$OPLn~zQ^lPqG|hIr4D0}$zPZN)9N+RLnU23szX zlG@%~n3~7udh?gh*snaeTpuO6ffO;qeLOXOcCCy}RY>?6rd%iUsirU=I84&bT-IYfCQ<1P{fNbA(n1#GqaAkEkTRk`F_gtecE;@HTr_0E?`4;3p&IFIKe z#(MB2Q9_LqSV@XdCIs8|&wv>ODdOC6v9`pCjghbkUgVTBjn1#*pwwBrhDOD3EZswT zwZm^H%W}fB)9~)NZGa|BpE%4MNG81M^*3!_otfc5oJ{|>K0 zDFGEkV?A%ycU5Jo9sFMl$;y(1$OSz-v_QP8|B@z#KXv5&vT4l_TX1AA^qg{?wEn>e zs2|&I%i0X{l<1*J;om3tKjz4{3R{Xg%Y_IlgRQMvVnCJGG!oF>zZWmdkEoR^BmGrL zp!u^!ai2}mtU4oDpaY9q1<=9cLH$AIeoq{c6HzXf4LOE2sVxLD95SSZ~m4&*d1U4onX=YKvriCQCW(=4Rd%iRCwZJdCL<@Sj2Nisw z0@nUp1**twFKwT?Acxv-3&v@he$J6*Dn$Zn+TjN6SHW<3l|}<=CCs#9@KLCI6$5wQ zA_Fw{&yuH8ek!ECJ{?D>_4daZH=qE)puL4M}?^;~C&CZBkTx0m*Fielx{(yc>9}R|Kj{FfdWx zqkE`cw8!z|9f41O_Pl^iW;J*OSDFZL@XZ4HKYGzeswPgTuL=raz#u^eCi0-ILkeBp zBWS{>s2dRb?=6+T5HL?6kbmOopS#8?M_wJL5O`TAZ~|#XM&Mt|ER)564);*wGCuvQ z?`vjxDPIxz8D(EB5v(wQ(wKAK-LCr8r=Rq{NE%r#n#;x70VUc##dCB!Ey>Du5BH69 z`+4TS-)n^rR>q*ybOm#qe@(zeI$_N4qpj|+_Ss^wLJg2NsJW-|X`OBM;Ve;Zwr3dF zK6K(p#qjtIrrhThtG7ti9?g>Fjp#;h^hHaCVvp(74{a84^sb?V+kCm z6M{Bor4j|qqb%;s14O5{iSncq2bVVX>^=Gh=R%C`huu&)zu`-zy!V>Bo{7`3y&u+* zN+OSXRPVu>Froj!R-hOdA%g?p9s(JdaPE;&NQ?+JTBjfB}b5p+_7Dq*Y38Ya;ziGJzReb+B>ADR^m%`3AbBt zFaI6#F1c=ipTH%$6Lx4iXJBR^hjxZsC+Wx5VOpfu=8m=7K3gS{eq(m zup6uQkUg{03urlILU#mmC8o^-{RrLsWfB#|$fE`99@25Qhy@@{*ZJ?YA1AIr0{^-2 zp5`y?jqyAgdZJdnPrpS7UVELTxQn>ABjvy2>zkVptZ3ra~ zB$B^Fz@}*B{MKS!6%tn*1=hkN^UJkC?UcGFQ75YR`gTcGP!D| zFcx&+8Maijln7d*0AwaL$C|ayK6E-2!%u`WfjEe#mV(SXP@RXXKX131kK0aK?drg; zzG;?KV4te2HxdE|(=0rPT4^|^d2fI7k4k!FnPg@9ImQ&lj?Z8EI$LlCnh zl4A%j>3Tr*8&kLppz$+0ySS}Vww0LE@*acOEsY+nM^C=|b&%nz1*>704MDpj=m z@vg~cdi5u#xuX1+U49~#Gc41ST?ujYqj@`_;gpuIo!cy793?t!Vwn;Vl=fz-@fI2^ z2~(~x^m@z5K=!MxY2k2YSG%^l$KjHTq?obBT&`OWHlZmS*t)59TiinhCM0pak(Et=f64Z9BZdqDa&9Mi*c6~Das$4@3&fy`QOpAQT|t%nEP znq99{yM+Oba_9vLdzPEoj-sVU(m$|Dc5uS!n zlBj>b)E_&PZOHx2cj9IsTVuSzP3bm62Jco$jh^Jqi2%TX+51sl2al8zfF5ViBahef z_BbjD3UK}qq@04e@yL`!6!!jHMJw0(RZHOu(zVgm^(|~sAz`q|l#mU^%OtZN4S0Xob(tg>minbuBp*@$maU9Pz%`ricvn5W zKU5=Rvxo37N3P0$Pe_mRUSgLUV<48zV%@ZG4t#UX!f|R$6i#Cm+$noHKxIQG4F3b@ zV76vCv`KHoDpVxo-dhr>GbJ`X;(A79wtbY5t3%|@%|vltwQSMi2uzeP;bL!kI*@UD z-+)e4c}N8>yvG31NCjndwW*awON=pP-WS)tF=NJGzuXskI4J9ykQ64|PTfCW9FSAW z30@ruk|!Knx00j~W3!q_nsmEAx2Aud)AA!vF~J4_z34gD(s8qA;ky(9Zg*)-wnuGe z2TQWH2abUhyrl*~n|}P=@ruMJw)o__v@r8vhWCal8Qg$M+y?zqX*fI9lpe`Y{AWPZ zJhJcp9^$ep(8cRJ8;mNG|E#rZSZ%59CA-|0G`+E2gJ)fW9Q~(1Tjv1;fVhzk==m@W z67FO|lLj!+d9!_rdWRWkyt+)6{&h_GLY(>8IML_kpZ?*B9?6R82H9lVP9fddcEwtn z48it7-Eq<+-NT4S;gdYk)y|j!cj2%CpkEQO?4O5)W;RopY@c_yn5FK!S9J&?s2&ex zD|yu91n&_br`0(ln5%b6wmB;I4r_$xI;jyXrHrzt;5FYu==Q2f(TYFZxsgVvzxY#{ z|0yd$MMYF6(s^1+Nvs?k9#P&q#l9y-;kTE$ztPww7uOLo9F_ehX3;Y;IW(K14-5<` zd!TRzp?-5IE?G^lEy9>Xg(F-7#*#rluaMX@q)vv1F^9cHdQJnz=mpyaRnroZAO?DQ zOMj01wZj(s_&%jvs=02{-Db`uy&v2|S!bxQzQ7eXcF6Q%k>g(hW{JtV^_|>#-O=Ky3Zshsn_tlyms4h&x3bI zoZBh9VjBjRX+Id1w9RJn4TDLl2WNVEe9=E-ixM$3zZJOta+@^+p8-YUoj1|D*q3>F z(_0rfG%61w58idNIT>Yk!}SnnBB?twkBmXjOpBeRb0)Yl`ozg6f{czl`h36VvOAkw zurVCV-))ZY3u{I@2T-2kZY@kUO=X($H)O}SFnM~?e`@}jh>g{oF4HZaMty>;?hX4$ zt5@rL8rd#_HF1ov^!p3VSGov_BPy8vo2C1D!gLSzK@i{Gbm^DTpNJ3L*9ZLMj@2JQ zs`|{a?9dnK2}f9TJf8c!cEhAf2-i&R>o!A=1wUsn+iFn7;0qnCyb9K5Pbb7D*Wlfu zn~s7&pa=g#ChDwfw?!V6A$}hgYGpcM1)fH#Pyf4~Jkf_l)po5nm4%@MW0K`KRYrL> z35PXY*v6f6#!JV(Vo#!j|EzD7F!}k+45t!x7JJ4P_yy(E_I%OUawomXnX4pCZH`iv*f7meP+5>8E9pcsCiuG2~uy z>8gRsWQ=}#=(nlE9W=BFD37v9SkPTBY@Gii@dhl~s4VWDA2JqSS9d2i+Tpij*Dpo= zd$ip_Qu&YUC+9N89ZARnCW#ct(YMZct&)Zk?;`^Ig?}kr#RX$yQ<}xuyOm@)+cEUR z$<;o~QswLAV?lP5hr#g{A*~o#olMW_{eIt5-FA|q;UGhmhYf*xD{@rhu~_Q%qpI7> zoSf%WKDPrpjc9<_6S*5bS*+}LE1fMsplUV}KE<6b`s~Xfyw_i_(t-9p5F8{ZUSN`8 znq?AdLR)&xU3v<*B|`OuKVk?Y<~=cwfU1%EeYIo9+CHirf2NATew4m$z0zS_2zNK( z!a{Q&7`&{f3Plb#ntMEYoTkT3DsOw2?9h8pQ|fVZr8Lo&o3sx38KP=FsG!)M=%@C@ z{pN(b6%JCuF|OZ9n9*}FD+%}2 z=K0p}XVjedGHol>$PPFWn5^I-ZLSg91)3L??QfI&>2(l5u1kEg=Py7d^(Nof-Tyvb?lZqa~1qi zI0mo6`!RM3!XKGU_D$YbaDi^3MdVV$UY-pC}!Tj=XcaWqkL~i2a$$z?L5kZQ-pwo;V)mTPUHz>YbYwLe6eyeuu3z+ijO# zJgmSw$+alPeW+KT!M+t6d&f<{dwsxJ)bcqxJc!elmiQ#n4vjjPlw7%Nj!$m9EmxSP zvFq9qGu?#<9DN46L5W(q+JCvp(QGRJ{e;Od=L{%qDeH!xhsOMpGxr{fMBd5PXhxyv z5*7Ws%6V9Bf~Z@H&vIn!wqcv))b>u57hGq?-7@Y4JhxWd<>U8Ai>YVKUlU+a!O-MU zNVufrrfgmoslVm_v)Sb3OR_Sl*mNaFrpg19;8#tu2%rr_PS($&gB)pyM595BaT8*; z^|3Hd$3fqcI#b3$lI6$I9}UZvn+pa8jYkdFa{mG+8HP8Uh^zf=H;# z_ur5xBm&4B$m){4^s3}-)c%h!A;Nl9dw{jcG1QvrQDw|pE+&L|wIe+l4%R$KrRW`9 zNl4!K6iqxU8gnSYpMl+*igAqSb7pF>g+M3ybcPZfL6(@+&tBKy+r(^e8KzY15xE`SgMB>83Lv4v{;cyxs*AF9U{jeMbRhuiEi=AMxl9y(zN>kws^jel6q z7<8RmV?j<7u^maSNK0C5IJn-htDv#6KFid6qVbb5?^`=OHJnbEyJ$s0W|AKJ)A1k> zm7G9#Co&;eC^U(&+K~&_> zo8r^yCSjidaffuqg?#oF#qR7v1H;g0NcasGV%!R_(BUzXUeEc!8+9F;tRX(z*o{o3 z-rK%JO#G`UR9El<#eYBCR^1Fo{#a?3rQBTkBBKmOqmv&|gm)UX0vLDtT-~xj3+g$XQ*8!Ivcin%rxZDjo zofE&gmL3z1Y9pf4ePabL0MNh;7P|QfZnYk+1$rJ4!dJr2a4sC7KYvmYp+Ff|Rf_-K z&E9E+Lh_})?1Z;d7-}Wl74M(!Zu@Vt6-<28%#o)wL=nV}n?Ba;{UU-a*-mYKXJ53% z$!m0C=4VsRa_mA{)l28?8Y(y_QEXcgV$ZJ;{%_7C%58D^eBq~Df&%a?zXxq395k&O z4DD&g1%?zLT>pc@<>T_olXe{(&2cz4tylfv1}6`6<3N?L#GEh#f@DzyY0dMvq?n86 zSB7XSJO9%=Tsb8>Q4WgeK@xNkebuRwM*@o{PZ8wj;#U066ZAiXUI}2o7C&m${q@UU zkU%D5)K4xAod2vm{s-$#1~kILd#wduzbxbpV1gwTQi@-5=Oo)v00gguVSV~5C$J>( z2LKaH{{Ext>z*k2N+3W!CS!SltN-`Ld*n~x7*WxwX#Z+QT8jeYV-%eK#7+DMIV`CF z93yOSOzc0W^54x+E>eJe9EfoJs^j+tmi#@?#DnbW>;J3&ijM+d&_(_4|7t0s{s2(M z-fMWPkGcv1JKVBKd>Ybm?@2B%wAH_U%}2oIQsAjJrvkKu?Dt>pw)l)0@>JXgmGjbx?>G=Lkb8rBGwe?nDiTV zBLf+=>8H@p&;u|8CKZ`o*`h&fwfkl&nmT0?0t7^*j_d?7Kpx)^iFOPCE0d0&(X9zS zi+Odof1z0UvAy0sl+5Ds3!GKsV=PM!AV2ufItI&cv3q8O>U>?ASZ%PDMk3GwAqme!bRZyETZjaP4%yHIOTpY;?fbCMhcFJ4aL+V}J2j`El5Q z6$a+QZg93DH~oDGPb=<84WM+8fl||Lu)Qp79s`K2q+9|f!|7*T@p?4z-=pa?SazQ; zXT;T4637_zT<7%S=yXWMLeQhosO0YUGgozcfrau6IREe7u*c;nWZBoyLbXvKgb9!0M_NEINE%@BFqP4r7+(mHF9|?E@0|Ej7Qnj#R;ZJU-y&s{;OdtH; z5tvbKaS1Xpl_1t_jUW zF%OL+d|%7Nupx(QCqhI0po}Mz_pGMg0lo0fU z6LBU3;9!=epGz&y8UZ&_uZC6|$`heAh!P;LvllZ}C{N|H{#?4pa4fLjpHK#~P|=ak zpj}UVe{~q+7lJ8;nu<<#P!RrcFW$6QC15+9lY}28qCbki$r&OpIHJxG{g*AC3RlM083~W+;vB5LOn70yR<}rMEO217`Izx z1_n$*ySUNd{*Q-#+YcI*aTuf@c8-oS$2o@2UJ$htTVJ{GN`I?8-pc@a-In(i%m)EP z7GE}Q!wD>VkPD}aM1MbX(0I|E=yRa|8z3>|=<3)S(;Nm_antX2T#2QGTynrmG`xSDuc}psfywB`KiTLt$dpVjC^z6fgaWJK=*S z;&Mi{Bfn`f3Wr6L2cf@#;r6bB$Pfk8>@nw9!+1zTJQ(aY%z;RNoan>yRYBcvnV7|j zGRak8O8mhyV&bsu;{c-mk)-5kG6@H%QYXTbS#^I`^bK8g%+!G}JWjc2SD^ZKDpjG~ zeeS{nfC{EBa92}aN(NP(3OCG8{^m2Ku`4TDx!8Oxy(M5;1IUEa@-5g{_NShDJz-T2 z$s=zs_ZLcuxMsDQYAsbZ8emJIUaQ#FL{_{yN+XlOj>W$FV0|g`SNm1@H9;|CYsgXz zuocL;LsK>_;f z?`P&#FhNOe`WepeNzZ9doaACkd-C7I)N?u=-9Ft{Du|Tze_et_=l}$8`-yWJ;kI2HT) zHHXRVF;|R41Pg?_Mz9aBVj0M?1$=G%m zyfylR4R#k9<)l*G-xmZ^cdd;7K}covssf2aGv>f1RUe~2cBbpic(Ub#Pi)uHlwD)n zWn4pTEyN!{1^K`KyzY@t07=|3)iw2b`tO80mwm-b0PD^fbF>3Bo-Jh%o`q0rw|`c~ zRNU-)?8KG={rLkjV=S!-DxFFQGL`G`!?+A3Gr{Kh=0H)CZ><6|@ZKt3T_wT9@xYM&eKke$%;NdP|DKCECT zWHW6IThJmZH_Wm(CzRA8p!{NYqEx>uP#?=2*Rc~Q-moj)P^tZnqvJ#)DbhM_E;(D& z$YxDl1aEwxn(Xgm`++yDQIuJAxC491{ao(!{9GyGlRGe2W6WE6Qs2E3iRQMo1j5l( z%Y_O1@pKwz&$yVLP@NBn@yAR&S}4_>5Q?-iJXXG5vf9NB=IXlkaOb0iAm}F=R%`qe z0&CK>eqBD`qglfv!j7$w{ImM_cP0J?mQNcT>Bsr0byN5JUo~nPIZy%1k56r=zn(9d zUl7aKdiV~nZ|nd2+gC0Wn@}3RDEijJ>K1I@)Hp|+_Rg{Y*Tn@cv=}FKen;`DT{^w7-8H7Oa^TF^)lur7xDHVdK&kYb5Xn zHWCyRVU0o9b0pfkG%&MaW*w;fFJOO3k5|Q+wkR<Ca~Po~gQtM! z$H1a44cDK;3rXtkRBW=~Eiv6S?s0!Dc|aX7LP$bbLPVV+E|Pz`dieEECphG>jS&A% zR@r&C<9(yq+$G_Pr|MIE$wjY0>)WqhvxbI1LUsKiqS zrgNXdXZY$XFwe4l*^snrGy$S4*Z~O0QgwmhV8Usuif)^`4!{PWJUR-uSM+WD{P?Kb zvXKl1aim2A*Zi6q>? z3KgIdRPuj5@d3HGB)jWxSMN?30d9xd^=a{`{@5H~X)vw!dKMGPq*wuorvn^a>s9ZA zxhe@D1%knTZ!#(}64`V*(+`N;J!~zh{yHW7F@+DuoI5b0!Q&Cb9OvFgN7qH}g_PU2 zFSziM83IUsA5A>89rT-B?3?NBL*D@j@h@>Kd04uUqoWFTcR)t8VRx|x%eM#6OQ}Am zmI<=?omUY2gWGOPk`=>bMWtB1qMogf<<+S^nMJb>+J-<^%$6hp#yJ+Dy~$Gg+q11$ z`R8lF#0>d|&qb;w(E#X#dXMf+|u9gr4VG z4FY7-_%v7ydx@3s368uSD;^~9WpBIc9bUhe4>XjnCjb-f3n22KV>g?OOuD;v zo+-6GT@x$#)Y5oUAe0ZR7dHl@et+hkL@Mh5)>g>1*rlFBqp@}hr?yfq(oQyRGR?A;l6^gVe6-1Uy8<(`#!za+z#GJy^x_0 zdWlArIDo9Da+<8NJ(y+YF8QpUGgSo~e6*Vkjpzijy$S4-jiMbb6KoqkI{93sF}p4}?L)77N=2;Q3^K(% zNvYf_?#M+>4Dt0Wrv0Hk z7^V^u#y6nm_;c-ZZ)eX=g+We=Gg^7{RAhz-6zt6L*N;%esg15*Dgg~2Hyu`~t}mHH zMA8XeN(e^Ye4Q1M5__#%1N#U#IOI|gc_SPa>Z;?>AJb;k_ZLr1$GEF!;&tE70=9CA zCCFtLc2BPs#`7GlG-_QNT(54o73Equ#@>D zCb5O%BM-1-%Uhk%Y3>)QRm92^-l8vm{o>3jx1?JlGwp0DAP%IgVshh!Bk0Bh4H!vz z3>-jb%GrP~$sr+$j$qF=`lueeuk&vA&ZZM){jz;e%Tlv04v2G25a2EpymK%9>1SQl z9fmuH_~E;ophW@-zodBHs}7oH5lp@GclGtte^qnS@#=#1qn+>_wF$sK(?KSLF-(LgSZ zTfe78fTvX;v4DT%ceyIQDN^^sZpb|*oCC1!8>8f)jYQ(={v{^eVo#`311kUs#neE? zHNp}YMF%891zZVEv|OhVqr;y%aQ!zs6R2f+!rJ?iNoe_UTdnN1#dbBJs#rz&(wR-R3f^i-wOcXJQ zl5~-=TnuFnyL0U5UJr-lCmTSh2*|dSLgKakD1semOZMEImD|0ZJpQk5_X33=ZB+Kq zr*2dba`OHi0Z9(F<5gc~b7@6pgGDs&9p98pF1JR4C4BUt1yT1`ZIwm?J_<1kH41%t zD%+{y+P)kmJ#!*=xKAHYwj7PtSj+hO!INCsCG~W4{hzvoih%|wek9#gW;aIT;op*9 z$IkUI_HN0{kdxCr>}C#)y;^d%D@ndNcOQH!Bg%laJd)AHc2h0eiK*zf&NY>{rj9(brS^U)sNpU9M2#EuX|OIF-LG!bJh$aJ+O?)~9gP34#%Tc5dl24*t&dF7fW;(LUmF z8S{E>zf7uTm!`yp51^Tf_X|-=T6}W0r1`-}?PRwds5`j1Y+z7nJ0uPyv^4Y0G$%&3@S(2`_}>E|D*mvzza*LuE)wmcCs~84ziO%lW6_c? zzr&*i#-wmH0;DW!3t8jBK%F+5WbG!0_0Mbs+dTXit73K-{WrX>8}-UFE?5g1tR{gK zh}s6B|I4V41i^4^-nMU?++8Lsw#vdvMR$rUfogp8D-n2Ij=V$1`&Ly_d(mkkCDN>x z`QYC1Z4#cIi>@>G6~_cKq%KH}XQz2fZPo{Q^d9m$=DY|dGqhoEA0yf}YT>Z-^z=-Z zZg8~tu^6HHkObwBK>#rBGQO^@Jc&@4$A$WT7!$tTn2MiIsuIcrulucqNH>>y^J;; z4$b+V0^>HA7oUh z_Ft#-l&H4#ESU4~X#L7HBpE21UJJN4@*G|M(Qx`kD!JY%?SqYtRPgHo+M#<@io{9t zi7Yo``8pDEC16*g5_0R7aubjOCr3+zvdx0o>8-!S<(x&9BSnR#Gc{PVP8zE~sX>F3 z*RV;#pRdw@=VVR-d{&1^~_Ux}6Js;Jb*P%4cs>??V- z)4NScZWSs2%I3&Di((mFb`Rh6toqqSaouYDpzCtwKb0Fk=C!@zD%AIFdB)}ZMQiai z%38`lCB_vsXlWN7AWip!G{-poo*@R1IMF89 zuta{}vpA?DgDR7259K=K!FT-CB;2!%|Ef;4 zwK+0c?f`20_8NaxCrfd`W3(#ReeTi{7+6`L>mV}HVz*fcUI1D}6TiN{cG;W2xw<~p zdO#0#^omTjiQAHongSPb*`PiTma1BC4#(B(j7(2d)W1rvg>?oM0(5aUea98 zwIpRZVkG(|p}LP%b9ggtbxVPX!`%8_i@duxaTd!J$^ur)^qn(;{sT}gt)Xuxrr==K zrI<0#+fd5#vD=xOOE!s4jDDz5p6@Hg(>jCxB;%9eI^INm&~-Ea&0}{i77~zn7{&B&PN!Ri82YI~Em;a{ zH&VB_5CCIlNd^t2QZ*sq0CQBSyD+z*uj~^kuF&MrgvUPSavTi7?sT(jr-_CO^AC?9 z$jM*{;gQ#*rKLs5J=&p#(Pl_D+2bFBA0y*JR%%25v2r#}xFi2%E9rYx0bXfQ5(X>=+|wY>Bv#WdkV1&t|J|2TP#AS7^4J-&LF?c z`FB{9$%+RZoU)~owv1t8ZTB?slQ*Y#LAJSUp1@GF7s-}4JhAT;g?R4uf?TnJi|X>C z*gZuBBj`*6xaEr~&&GIE1MF9a-xm|4fB#-YuHB1{xsSJxd3nrB#fmNS#t->-(sHIN zDR|!EyWX>aQRibZx_!A8q-l^i|{qvCqXPm=Q0d6Y($H2vniK})Sy4?v*m zj4S?(CFy>&)M8G4sf5FY5^5>OVDOtZcUT&nT#!Gb+i6p5f4mFc%#qRMrNgA`t|A;y zaPwQ|tDdY}(=7?fD8} zPGGaqhC9 zD8MPT&1MWV#4~>T1_X~bhh0d(;4Zwx8c7^rh3jkl@kHnFZ3#OIxhzMvcCFQNmabcY zB#1C`-RtAW{A1&ov7ILAbqn=sh+;l35E3`Q5XDsNIBW-9pMf$a9(0Hf%bLPUccPDnsH{F6+YsJGFiG{4@;7G(ZO1@M3-7_z`w& zGVv-u47UR5HA=O-QqhDX2qEUZ&5Y(@wVi0&ORA&S9YlWib^|{oor`1++xhJalle$8 zWnI6|MR#!F3&~8MMDxS+mohhv^bU8Le;@S8-vVt|$z0f6p~4^q$pA4@@)d|fM?|tM z@Xen46|)kMNgkl_ri&@Z&(&;yKNek`d#6E71E|0IIiNh)`na5g<=q@|%=SdPm{d&S zD*4{NQJHIJ>ect%|MHdf5GDv|BVgvOz-&ZF$SvGP!pf3^0pQ1CdNv4L5Xwx$dg7CA zy+lqU(N4~i!%(2#KtIn=w511a#}(8a`D}eY_(jJH5};nyNex$AU2;8QJh#x4MHRMF zUsR-ujYa2Z=yf3xk&2p|Bq{TCOuI9-kUSXDeVgG2k1v#ldEaPu_`2S|$fkPEum9S0 zG`zP9=dMxkGhaQ4%wD^&WO{OsOM4a*Qr_5|J;XH#xVa|+B*inAlHPan9Y@u24X;(Pe_}r?AV|r zl|}>fDhmqor39N*Y@;Bt$u4g(qBM-<2^-8}Pk)N^M?b0>v#EB;d?1>_e0TOt z_d`A*CKnfbZ7=BHx2b8)4Vr}YNber69XAB_O@_PtnnCRRX@$5bFc;E5FpY2=Sso3OLnX1RSH5)}ZYN9f5|H<4AXzs;i=l94?yQoeV8nbeqQ z4uzUdLjL>XOgMgqKAKj2E?xCz&LuLz3%-O*sRgf`Np*ey0M+R`KUd6E7a@X>tGiup z-^t~Ox?lCWAMJTFY0)HAz(vun@}I4B?}i2I4>@gAl9)@)qYg_dgdTpBP}>l$)alol zd$nb_Go1J8YC!UdV3D+{P7H$|ww+(1n?IbRfek&%&6+gNEde4XxEz79Zi z44aqBo4=3OqnIU>OvkU;0s0`i3=TP>90H--2DJ9oAM1rc!*3*^a2OM~&hwDH!FD|W z8J~q(T-E)(W?>A_{UhNye(mN3@dp1cTkjQ<2D@Q_o3bt}{Tuk7q$p+RpXG580_`JA zJ|v{1LeeR0y0vf~oGS0$y%Pf(8GC|4ZBikE2^udEquSe{7(4pdi{@)K*sc z)Suno%jN6vS6RBKzNS@uCxy%W8pxVGN_YPL{d?wmt7QIBP-uD8|Ld@xIdAPL=qVVT z_8J=D9S<7D`5pj^K_W>WD}<=sRsbbuC(DgIS*WClDlDsdcDZa@I5I!4uEt_bbJun) z&a*QvqExCzwmBG!>FnGm$mM*P!nY7JZ3l3c;r8nEj{S)j`h|gijg@|!2_**9!;J{S z(F6Vc#Y&QDB&ECi3B6u9vu+n@HiIe*`Xl%O_>2m`crpDx@h^1uEFCOq_J-h+Jx6*K z0}QAY3r{=hb;W&T(iR_?v~2N2IbgmtDL?MJt>T_K599gOr{`bLuvE5j zH~}t0jl$0~&bMHbh1P(8fPu=*A*r2lfSlX7^*^rCf}gwN1hcGbR72 zTL7iyLsr8ZI{4@CuT(70Yk~51zeS!{wD6SmjL8Ylw>Pv_uo6qnF3)fDEA<;Qr=Cf@ zB4l^3e>K5{Hq*}UE4iaM^!lS7$EWf^rG`qwob9F~@t$v3hQN&SJ@(^RMBK{F%}uPb z3w?_(oKJY26$J8?u{!NGnKe!xN4uap>00^$kxn*0fmMOXcTfn6X=!3PDixWHXI8IK zI_#n`)Lu#)sTq-ZsxKcWvdR#wD^da@o?||!{&J$sa(#<7rI;;>F0Y(4Q6M#M!Ygud z&};AADHcT<3DlDl(LPegtG8OP19K*dE_%k5-msjQa6)ua#$a9CrwUc&7glOz1?%55 z(_+IYt@`L{+&e+%8inFUsomIs=a|PwN;Q}1h}CT^mlX#8#p1pveQb%av-V!dvpK_K zccd z-Q}qmgg=gLe3)dO)FQnp{J%tp!Ebl>MMHbSwYia5$fvdRvM2GJYx8OEbC=tBq}0e6tnp>Ps{}{Wj%vd8^Mjz zvFd5#iRcel4RW4Gl%WPda}KRr-ygMJrYRK33Qm=(Z!5AYsYIHwb4o?GtqBY8+1TH;TVbu@hjxf zYE=p~Iv&xS-d{^V!$AM=;|3IAA0?+dk}(0$2R|nfkd_`Qkk2C(3_yNlV#1!o!ASsJ z2p|`ifveMPpi)k4#9M1i4fyUY57I{;%e(y(iIpA|@t&ggwV=9g)+=<|}x6EuYvpk#|0<#yg(Z)Ebn}9V!9ED~Aj~_E@gL&JZ}R z!kW+4f`x-N22sAUCSxZl;Fqq<#!qk*|(^lQ-28y@E=6J^RWTZJ}P5)VHM zX7V!~bsv(g+dcxCSFtf@=#BS~dO&J=IZrwk2JU754!!;c0E`F=-Ex`5gy3_}1;y97 zo<(#8qDp{3^{=Q^KEHU0{he0&n9k#aLVfwcY>T?nu69w}#~kZ)9`fQ3xlU0OG6b+_K;|*5c(9a3f!Zk6R9Ct>E-)m&|d%chq zqPPHBK*B1$8WH{56pK^X?R!B~HW0A$Qsin^z<{6axA@vr$96#aTQd7UXa6o+#PB)3&yY|zo{A{+uh zP-9M9mO9@hQ|S1&iu!R_J)4j7+06Q!Fj$}Lv=w@?2tcpFd&XqBBI~Mpxwj(Fl;+sI zJ=jK>`{fvl7W|EJRaf$}E~@$c=`vd2`;QdIqQWI+aJ#VRNH-KY+O&S9D7(J9YwDCY z_PGQwg+ai<#_0Ej4X_L|dOMS`Jjzl!>`e?P!7e4@Fd7e@US7lk=QW;0I#0`ro`zCI zGysf&>h#UOynVVE;Sq>RbTWAq0)Mxs8_pP~`{;mW`eguMYNc_u+U3;ix<&PJw#o58 z`Ktg8oDh;RP*vKnwkSS(D;Z36;ih-dLS_2XRGBe27|PpdzWH%E~(yWsmXQRvT}Y_9F^ zn{$rLv4J4pV?L@YC7GKjS`8D<7N=njt>E)BxH(X1m!?Q2vkX@wt1fL@o+O_U`ehhgPYOJq^W zGFwcDmhSGUI6A6o4cQ;xjb{AH>feJE^1$1O~EG9GMERalM7` zsSNGTy=inkFMI?Ya~#2!BFn8n8^v(~k;TvwL{AVtBzy1ES1T3iH@b@S_`zCJ*N6G| z`)s^V&cYQjQZ$FVI1ojs7uuxPA{=U>v}9&ys~AWOPjxWnJwE=oO5XOL>$+a;;*xdC z#+HH;-P3qAn9HszPZgZgUO>}ay0iH-I_@hCBrNgRa$tTuzR;< z0`;dSmj_ZvJ^~vR&l+L=dA`Wt#gjMr1@`~!ms2na8}(lOlVJMq-FD?Y*-AD6;9mXw z{gcVe)8!`cSf0ceTs5$eJ;a@7#y{R4uL3^Vr*ttB$~J&)=qS4SGsj z>~_xB5yIiy9uTNk?Vvq*c;p&vJO==p(qaBTTk~fMxBWWHv5j+lV-KR3xHh3N;6~Y% zeXR$4ESrF)K#in0nyr(IS)#v8t=$VDrO`ok371|eEVb?TvhTvF3OYb}M$@3|^-DOK zvrW?Gb@#2Mx+xxKN9xU1vQ6$}@tDq6MBANpesakb^%hygs{Jdll3{)Z;+peh779yi zf+*OFTKGO>3sRY?)EYE5ffauC9ZT?kRRVqaTw#&8Ik8D~9MJQGgU5)25-6eM!iX!N zGE1&^$dMmrBjbr8cloY>p2v|iO2LhwFKR+w{1;24AqB-wP~9!EGMZQ=?KlT)mn{YP z@M$rbPHY0&%mb7^pS3$3Dtc&rBV9nNfdg z=GBj84$jfEjSY9NB2KY8LB^yY+B^rsN zB2$HiNzub}SkHB5HVkNnNIJfcV6KvPgpmIEpQ0hKQwOuOUM0)atN`Qep2#S+Ux-Dj zcw#_;^_BP!|rnU(<0Tp`kl)Ub5~iD7bmC*c8R0D4sa8jlaw2>SHnE+>SNe z*MtIi<#MOf1(am6PYl|}(n$)rWopJ+IvnZQ31zX$&jW_czWu0=nriIc@xt*m#96LR zn5dV5tR?5C$1Gr2;JUXT!T9|5Q0KFB(cR_-y^rw`a1@u|_q3B`hK0=zca679&fa)z zjvU0vqN9x(Yggs2w^~EJk4RGSyc-{f7pH*JZgMZxtA47$k+kUNZ|epltG08#w=%bA zh7Rhr1nTc+kW|{7I%OH9zgLtj#CmU{Xnb>Pd1c1#zLnCvSPbY`lGT8>U;MEiuJ^E| zCL4X_?58;{Id;FA9OW5{8RLC78t#_|LlpNnCtuWrQYMz!7sBkJ^rz8$o>M3y9dKN` z9SP&EJe{#EC_K%dHD}4sBW>W)Zb~9Oydcdk`&^n8GAxMY7MM62|WJAWEFC`ERaG z?lU-pUocWQGPM?)!sO_unlZQxAeySQhUl^#A8p$0t&zF3$a34OB_}DKjZ3u%-b`@D z$|flm=*($aaS7i@C6W>l{1Uj_mMoL4eMEcQu@9!lbDL?I6G zDwW2XeL@mbO=Wf4y}8)3o_Y87k}yWv(JUyvtWJSifsaPJDdUD!Ld(*6zaz`%hO9>0 z&QztedP6i_X?u|ZxrlR*?0phrvTK<5&?|hwAu}v8YHAHYh;Z{)&3;%ws?H5znovka zFr0LHBv>SD;OL>41q~4}09vYzTJ4u(cYS2W0S+hY+Q9}p#ce-k_a`;a)>hEB1aw5E zSF;Qv5z*a}TkTTaujY~c)51Hu2$1Xk+2m=I&~IPj{emRXnX0#BT590@%8q-keHI&5 zQ|i@OFS+tYIxUV@;X86Nx3<+{1J(MQhpf{Qm#rCXj!2K~ zJniQN(D0T=3}?o(E@yr#+%H>%WnwnfwBz`^5^MEJ-06%mOTZ#EwnBt#f=uUD)4$+R zgl6~@_&^Gj2{Nrm_uoL|#}VeZ0h14#VREYe@Z?(wJ8xPj3JVKnOg`6ErzprOmPv|T zZCtU~ZOKKr%0mNEVb-FrrO<5*(AYyi#KdY@CcQn9N5K+=X=)|{?fWykwAtO|259*w z?9<(r(DYKlWSpHBjYyPWe3F{9t}`LEHldtW42AW9GSMzddNmT;g;$iLx7#u`oUKxN z;M#HsbcHCVw@qkSEg_-@#St%R#c_R*BvP_TwF>aVuJ8_o?5MkH=ddZB*z*Wo7HMXv_jHzI^{ix-=;TU{D_H-=+m8Ln=I zC@?))QNt`_d3-|I_Y%K+HY?T3%s@o3xjG(s&LG$VWA1bm{lbGMdj3N>q`J*?(@su- z0z#tTklN~?YPOf{ne56z1T}TARHWZPV>u~NA<2zeHC?Q%?Vo(RP*voLgE-{Z7T?3s zxXc9mQY%(4Zv@fLFMUhvw$(khTFx4i3vE93PJQ?-jx3$g{cH1NGw*7 zXQpzqdwe@@nu$ty@O3)Jo%ZV6+;gH!koWND-O>)&J>{%m1N*D6#OHr{B)kPOCSG@C z;RsEgpN{BO+>S3#qjRx_c0#!nl@1n2R2BV+T|W40abb5>piLXA>bIzrj~7bn+R(3w zL=EtUUj6(l@do5}(Z0(p=q3n}#Pn5m;nt>gcP;)1Y)w9nr=F>n!mN_P)j{nrW;eG__4d+|*<$P@klQ z4dMiwD^7e><-{V`=(!)4EqUm+yo%53)e*yI`WUdJqjAUYp7hiY!gS~aNP=-oxK5`nd z1|(ct$4c~%JjjXn&*4wRQt7)Mk9D8QBf1oP817Mb>Te#o5f#Ql*KBT-UnQUx9@Uw4q~X zNPcAc_Q$FG2&c7z=n;Kj%sCQFV6uDoyGH0&&98ae&XWR;4C2d}UhP_^>MxGi<;ob_ z34MMUeJRVqE@B0L(bf9d8ln3o`DQ$m`}^bo(vr#BMG-@7Gs;+L6vt0_$9DXJC0nJ7 zq?Tq1^it#6(IZmlR!V}bR^!J+Dc@Ot_s;r^%;+l}X@>FV_*cd9;JuSd^4vC-Gm7Jrvx$T* zO$H79X=nR41MJ+zZhhb(fXksM@Vta(i-R`O7um&b--+s&onxhbG{ivQ2 z`}J#tGU1>AcYbQVFF({;q;XB4AKGbXal>UvP%N*dx)y}@I-g}Rja)5mCl&6%Gx;Fw z!i6EfD@xg_BC^f`9i|AAsu@P^+)EZVktU z$JqMcsghvnXbe^%{}sfUL4&?&773wa8u_E8OeN*t2K3(Q|4QkcR;EMe_1a8wrGVaK z_jrKYk|X!i+?K{+W?w`!?u)@YQtxs{(q-E`*`)tEBAVN~mn~}4yMeQ+0{@nyNM`Za zDpYHPnZC$am&QnY+1F;)0aA__*zdkvKj9lVQ{)7uM@>1l3ifYooYpy4TUo?~2e;wa zssGwB(?Y|(VIK25`Wh{q{oRT*L0@%kwup6R2?=`DCpHW6`Nj&AfSi1lXYp&}ekXtn z2ObYZ6Tw?`)vkMrhEKiPGn2VI2IubT<}%m-uyHiSmC|YXzkc_PF0t1(21(ia4Kl)w`noN?&Cj9_0c+-u*Uw8l zAzPq-su1N@gVAPvIs`iouf-szx=3M*{s5=xFYzWBRPXeyJ4=Cqv@~>)u^=0WeEqklKSQna zM&dqw6$PdEC7QWX-=$OvXdyo`uc_-`Ol>RTo{$ zB|M*ZN{lb7rc_^(b@I3TTNY}8#70g#_i`(!!cIUNTGXu>VP!MAY@&#)Y@%#aK_vAx zp$RyW;j)lVPAdfucM6*IvmxzDMPo??ox~0;X1`nM5xvA z=6Dz14f;PBiGt5O1Gv~LOc8Jxgwl0`nE%Al|Gj0WaX?FNx^p?ku<879NRMByH{4?< ze>=SDvp>7_F+<9y0jN-Q`(q3}NtXgr0d&AE9Zt9(@n5(1HGn`Np@~rm_;V$F{EZcF z02kq+6HxkFg$sC%_6ERMY%{u__A~QAqe`wkOxfWNcd!{mK>}} +- [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] A webhook secret is configured for your Jira Personal Access Token.[^3] +- [x] You have admin access to Jira. + +::: + +## Configure the workflow step + +::: {.column-margin} +![Create a Jira issue](integrations-examples-http-request-open-jira-ticket.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a Jira ticket, showing the required fields described in step 4." .screenshot} +::: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +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**[^4] to create a new workflow. + +5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^5] 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 + - **[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: + + ```json + { + "fields": { + "project": { + "key": "MODEL" + }, + "summary": "Model validation failed: {{Model Name}}", + "description": "The model [{{Model Name}}|{{Model URL}}] failed validation. Review artifacts in ValidMind.", + "issuetype": { + "name": "Bug" + } + } + } + ``` + +8. Click **Update Step** to save your configuration. + +The HTTP request to create the Jira ticket is sent when the workflow executes the step. + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) + +[^3]: [Manage secrets](../manage-secrets.qmd) + +[^4]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) + +[^5]: [Workflow step types](../../workflows/workflow-step-types.qmd#http-request) diff --git a/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd b/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd new file mode 100644 index 0000000000..7ecde2eadf --- /dev/null +++ b/site/guide/integrations/integrations-examples/create-servicenow-incident.qmd @@ -0,0 +1,77 @@ +--- +# 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: "Create a ServiceNow incident" +date: last-modified +--- + +Create a ServiceNow incident when a data drift issue is detected during ongoing monitoring using an HTTP request workflow step. + +::: {.attn} + +## Prerequisites + +- [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] A webhook secret is configured for your ServiceNow credentials.[^3] +- [x] You have admin access to ServiceNow. + +::: + +## Configure the workflow step + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +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**[^4] to create a new workflow. + +5. From the **Workflow Steps** modal, drag and drop an **HTTP Request** step[^5] 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://yourinstance.service-now.com/api/now/table/incident` + - **[method]{.smallcaps}** — POST + - **[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: + + ```json + { + "short_description": "Data drift issue detected: {{Model Name}}", + "description": "A potential issue has been identified for model {{Model Name}} (link: [{{Model URL}}]({{Model URL}})). Please review the ongoing monitoring documentation in ValidMind.", + "urgency": "2", + "category": "Model Risk" + } + ``` + +::: {.column-margin} +![Create a ServiceNow incident](integrations-examples-http-request-open-servicenow-incident.png){width=80% fig-alt="Screenshot of the HTTP request step configured to create a ServiceNow incident, showing the required fields described in step 4." .screenshot} +::: + +The HTTP request to create the ServiceNow incident is sent when the workflow executes the step. + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) + +[^3]: [Manage secrets](../manage-secrets.qmd) + +[^4]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) + +[^5]: [Workflow step types](../../workflows/workflow-step-types.qmd#http-request) diff --git a/site/guide/integrations/integrations-examples-aws-sagemaker-linked-model.png b/site/guide/integrations/integrations-examples/integrations-examples-aws-sagemaker-linked-model.png similarity index 100% rename from site/guide/integrations/integrations-examples-aws-sagemaker-linked-model.png rename to site/guide/integrations/integrations-examples/integrations-examples-aws-sagemaker-linked-model.png diff --git a/site/guide/integrations/integrations-examples-aws-sagemaker.png b/site/guide/integrations/integrations-examples/integrations-examples-aws-sagemaker.png similarity index 100% rename from site/guide/integrations/integrations-examples-aws-sagemaker.png rename to site/guide/integrations/integrations-examples/integrations-examples-aws-sagemaker.png diff --git a/site/guide/integrations/integrations-examples-gitlab.png b/site/guide/integrations/integrations-examples/integrations-examples-gitlab.png similarity index 100% rename from site/guide/integrations/integrations-examples-gitlab.png rename to site/guide/integrations/integrations-examples/integrations-examples-gitlab.png diff --git a/site/guide/integrations/integrations-examples-http-request-open-jira-ticket.png b/site/guide/integrations/integrations-examples/integrations-examples-http-request-open-jira-ticket.png similarity index 100% rename from site/guide/integrations/integrations-examples-http-request-open-jira-ticket.png rename to site/guide/integrations/integrations-examples/integrations-examples-http-request-open-jira-ticket.png diff --git a/site/guide/integrations/integrations-examples-http-request-open-servicenow-incident.png b/site/guide/integrations/integrations-examples/integrations-examples-http-request-open-servicenow-incident.png similarity index 100% rename from site/guide/integrations/integrations-examples-http-request-open-servicenow-incident.png rename to site/guide/integrations/integrations-examples/integrations-examples-http-request-open-servicenow-incident.png diff --git a/site/guide/integrations/integrations-examples-webhook-run_step.png b/site/guide/integrations/integrations-examples/integrations-examples-webhook-run_step.png similarity index 100% rename from site/guide/integrations/integrations-examples-webhook-run_step.png rename to site/guide/integrations/integrations-examples/integrations-examples-webhook-run_step.png diff --git a/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd b/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd new file mode 100644 index 0000000000..ef136a1d60 --- /dev/null +++ b/site/guide/integrations/integrations-examples/synchronize-aws-bedrock.qmd @@ -0,0 +1,99 @@ +--- +# 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: "Synchronize models with AWS Bedrock" +date: last-modified +--- + +Link {{< var vm.product >}} models to foundation models and generative AI agents in Amazon Bedrock, supporting governance across your AI/ML ecosystem. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] +- [x] You have AWS IAM credentials with permissions to access Bedrock. + +::: + +AWS Bedrock exposes two primary integration surfaces: + +- **Foundation model layer** — Access to AWS-hosted and custom foundation models through the Bedrock model catalog (Discover and Tune views). + +- **Application layer** — Bedrock primitives such as agents, flows, and knowledge bases that represent built generative AI applications and workflows. + +## Configure the connection + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click **{{< fa plus >}} Add Connection**. + +4. In the modal that opens, select **AWS Bedrock**. + +5. Complete: + + - **[integration name]{.smallcaps}** — How other admins can identify the connection. + - **[description]{.smallcaps}** (optional) — The intended usage or additional details. + - **[aws region]{.smallcaps}** — The primary region where your Bedrock resources are deployed, for example `us-east-1`. + - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. + - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to access Bedrock. + - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + +6. Click **Save Integration**. + +7. Test the connection: + + a. Hover over the AWS Bedrock connection you just created. + b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + + If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + +## Link models from Bedrock + +Once the connection is configured, you can link {{< var vm.product >}} models to your Bedrock resources: + +::: {.callout title="Model dependencies"} +Bedrock agents, flows, and runtimes typically call foundation models (LLMs) under the hood. When you link these application-layer resources to {{< var vm.product >}}, consider also registering their underlying foundation models and creating dependency relationships between them. + +This builds a complete dependency graph showing how your AI applications relate to underlying models. Benefits include: + +- **Impact analysis** — See which applications are affected if a foundation model is deprecated or has compliance issues. +- **Full audit trails** — Documentation and risk assessments capture the entire model stack, not just the top-level application. +- **Governance visibility** — Track model versions and changes across your AI ecosystem. +::: + +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.[^2] + +3. Scroll down until you locate the **Amazon Bedrock** connection box in the right sidebar. + +4. Hover over the Amazon Bedrock box. + +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. + +6. In the modal that opens, use the tabs to filter by resource type: + + - **All** — View all available Bedrock resources. + - **Foundation Models** — AWS-hosted and custom foundation models from the Bedrock catalog. + - **Agents** — Generative AI agents you've built in Bedrock. + - **Flows** — Prompt flows and orchestration workflows. + - **AgentCore Runtimes** — Agent runtime environments. + +7. Click **[select model]{.smallcaps}** to choose the specific Bedrock resource to link. + +8. Optional: Click **Test Connection** to ensure the connection is working as expected. + + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. + +9. Click **Link Model**. + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd b/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd new file mode 100644 index 0000000000..cc87f119f5 --- /dev/null +++ b/site/guide/integrations/integrations-examples/synchronize-aws-sagemaker.qmd @@ -0,0 +1,82 @@ +--- +# 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: "Synchronize models with AWS SageMaker" +date: last-modified +--- + +Synchronize models registered in the {{< var vm.product >}} model inventory with AWS SageMaker models. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] +- [x] You have AWS IAM credentials with permissions to read the SageMaker model registry. + +::: + +## Configure the connection + +::: {.column-margin} +![Connect with AWS SageMaker](integrations-examples-aws-sagemaker.png){width=80% fig-alt="Screenshot of the AWS Sagemaker connection configured to synchronize models, showing the required fields described in step 5." .screenshot} +::: + +::: {.column-margin} +![A linked AWS SageMaker model](integrations-examples-aws-sagemaker-linked-model.png){width=60% fig-alt="Screenshot of the model linked to AWS SageMaker, showing the required fields described in step 4." .screenshot} +::: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click **{{< fa plus >}} Add Connection**. + +4. In the modal that opens, select **AWS Sagemaker**. + +5. Complete: + + - **[integration name]{.smallcaps}** — How other admins can identify the connection. + - **[description]{.smallcaps}** (optional) — The intended usage or additional details. + - **[aws region]{.smallcaps}** - The primary region where your SageMaker model registry lives, for example `us-west-2`. + - **[aws access key id]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. + - **[aws secret access key]{.smallcaps}** — The secret generated by AWS IAM with permissions to read the model registry. + - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + +6. Click **Save Integration**. + +7. Test the connection: + + a. Hover over the AWS SageMaker connection you just created. + b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + + If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + + +## Link the models + +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.[^2] + +3. Scroll down until you locate the **Amazon Sagemaker** connection box in the right sidebar. + +4. Hover over the Amazon SageMaker box. + +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. + +6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the AWS SageMaker model to link. + +7. Optional: Click **Test Connection** to ensure the connection is working as expected. + + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. + +8. Click **Link Model**. + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd b/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd new file mode 100644 index 0000000000..c8a9095ee4 --- /dev/null +++ b/site/guide/integrations/integrations-examples/synchronize-gitlab.qmd @@ -0,0 +1,80 @@ +--- +# 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: "Synchronize models with GitLab" +date: last-modified +--- + +Synchronize GitLab model registry with ValidMind model inventory for comprehensive model tracking. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] +- [x] A secret is configured for your GitLab Personal Access Token with `api` or `read_api` scope.[^2] +- [x] You have access to the GitLab project containing ML models. + +::: + +## Configure the connection + +::: {.column-margin} +![Configure GitLab connection](integrations-examples-gitlab.png){width=80% fig-alt="Screenshot of the Configure GitLab dialog showing fields for integration name, description, project ID, GitLab instance URL, personal access token, and initial status." .screenshot} +::: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click **{{< fa plus >}} Add Connection**. + +4. In the modal that opens, select **GitLab**. + +5. Complete: + + - **[integration name]{.smallcaps}** — How other admins can identify the connection. + - **[description]{.smallcaps}** (optional) — The intended usage or additional details. + - **[project id]{.smallcaps}** — The GitLab project ID or path containing ML models (required). + - **[gitlab instance url]{.smallcaps}** (optional) — Leave empty to use GitLab.com, or enter your self-hosted GitLab URL. + - **[personal access token]{.smallcaps}** — Select a secret containing your GitLab Personal Access Token with `api` or `read_api` scope. + - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + +6. Click **Save Integration**. + +7. Test the connection: + + a. Hover over the GitLab connection you just created. + b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + + If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + +## Link the models + +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.[^3] + +3. Scroll down until you locate the **GitLab** connection box in the right sidebar. + +4. Hover over the GitLab box. + +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. + +6. In the modal that opens, click the [select model]{.smallcaps} dropdown to pick the GitLab model to link. + +7. Optional: Click **Test Connection** to ensure the connection is working as expected. + + If the test is successful, the message **{{< fa check-circle >}} Connection Test Successful** displays. + +8. Click **Link Model**. + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Manage secrets](../manage-secrets.qmd) + +[^3]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd b/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd new file mode 100644 index 0000000000..ac765fc9c3 --- /dev/null +++ b/site/guide/integrations/integrations-examples/synchronize-with-databricks.qmd @@ -0,0 +1,137 @@ +--- +# 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: "Synchronize with Databricks" +date: last-modified +listing: + - id: whats-next + type: grid + grid-columns: 2 + max-description-length: 250 + sort: false + fields: [title, description] + contents: + - path: https://docs.validmind.ai/notebooks/databricks/validmind_databricks_quickstart.html + title: "Databricks quickstart" + description: "Install the {{< var validmind.developer >}}, load data from a Unity Catalog table via Spark, train a simple classification model, and run ValidMind tests to send results to the {{< var validmind.platform >}}." +--- + +Link {{< var vm.product >}} inventory records to models, datasets, and agents in Databricks Unity Catalog for governance across your ML ecosystem and bidirectional metadata synchronization. You can also run validation notebooks directly against Databricks-hosted data. + +::: {.attn} + +## Prerequisites + +- [x] {{< var link.login >}} +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to configure connections.[^1] +- [x] A secret is configured for your Databricks Personal Access Token.[^2] +- [x] You have admin access to your Databricks workspace. + +::: + + +## How does the integration with Databricks work? + +Databricks Unity Catalog provides a unified governance solution for all data and AI assets across your Databricks workspaces. The integration exposes three Unity Catalog resource types: + +- **Models** — Registered ML models in Unity Catalog's model registry. +- **Datasets** — Tables and datasets managed by Unity Catalog. +- **Agents** — AI agents and applications built on Databricks. + +After linking your inventory record to Databricks, you can run validation tests directly against data hosted in Unity Catalog. + +```{mermaid} +%%| fig-cap: "Data flow between Databricks and ValidMind" +flowchart LR + subgraph databricks [Databricks] + UC[Unity Catalog] + Data[Tables/Datasets] + end + + subgraph notebook [Validation Notebook] + SDK[ValidMind SDK] + end + + subgraph validmind [ValidMind Platform] + Report[Validation Report] + Inventory[Inventory Record] + end + + UC --> Data + Data --> SDK + SDK --> Report + Report --> Inventory + Inventory -.->|linked| UC +``` + + +## Configure the connection + +::: {.column-margin .pt6} +![Configure the Databricks connection](configure-databricks.png){width=80% fig-alt="Screenshot of the Configure Databricks connection dialog showing the required fields described in step 5." .screenshot} +::: + +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +2. Under {{< fa puzzle-piece >}} Integrations, select **Connections**. + +3. Click **{{< fa plus >}} Add Connection**. + +4. In the modal that opens, select **Databricks**. + +5. Complete: + + - **[integration name]{.smallcaps}** — How other admins can identify the connection. + - **[description]{.smallcaps}** (optional) — The intended usage or additional details. + - **[workspace url]{.smallcaps}** — Your Databricks workspace URL, found in the browser address bar, such as `https://adb-1234567890.azuredatabricks.net`. + - **[sql warehouse id]{.smallcaps}** — The ID of your SQL Warehouse, found in SQL Warehouses settings. + - **[personal access token]{.smallcaps}** — Select a secret containing your Databricks Personal Access Token. + - **[initial status]{.smallcaps}** — Set to `Operational` to enable immediately or `Disabled` if you plan to finish setup later. + +6. Click **Save Integration**. + +7. Test the connection: + + a. Hover over the Databricks connection you just created. + b. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa circle-check >}} Test Connection**. + + If the test is successful, the message **{{< fa check-circle >}} Connection successful** displays. + +## Link records to Databricks + +Once the connection is configured, you can link {{< var vm.product >}} inventory records to your Databricks Unity Catalog resources: + +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Select a record by clicking on it or find your record by applying a filter or searching for it.[^3] + +3. Scroll down until you locate the **Databricks** connection box in the right sidebar. + +4. Hover over the Databricks box. + +5. When the **{{< fa ellipsis-vertical >}}** menu appears, click on it and select **{{< fa link >}} Link Model**. + +6. In the modal that opens: + + - **[select model]{.smallcaps}** — Choose the Databricks model to link from the dropdown. + - **[sync frequency]{.smallcaps}** — Set how often ValidMind automatically syncs data from the external system. + +7. Click **Link Model** to complete the link. + +8. Click **Link Model**. + +After linking, metadata from the Unity Catalog resource syncs to {{< var vm.product >}}. You can use linked fields in custom calculated fields to surface Databricks metadata directly in your inventory views. + +## What's next + +:::{#whats-next} +::: + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Manage secrets](../manage-secrets.qmd) + +[^3]: [Working with the inventory](../../inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) diff --git a/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd b/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd new file mode 100644 index 0000000000..22b7dd9a0d --- /dev/null +++ b/site/guide/integrations/integrations-examples/use-webhooks-with-workflows.qmd @@ -0,0 +1,128 @@ +--- +# 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 webhooks with workflows" +date: last-modified +--- + +Use webhooks to let external systems start {{< var vm.product >}} workflows or trigger paused workflows to continue. + +::: {.attn} + +## Prerequisites + +- [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] You have admin access to the external system that will send webhook requests. + +::: + +## Start a workflow via webhook + +Start a {{< var vm.product >}} workflow from an external system by sending a POST request to trigger a new workflow. + +::: {.panel-tabset} + +### a. Configure workflow in {{< var vm.product >}} + +1. Add a new workflow, selecting the **Via Webhook** workflow start option.[^3] + +2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect it to your workflow. + +3. Double-click the step to open the **Webhook Step Trigger** modal. + +4. Copy or select the webhook details: + + - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. + - **[select target model for payload]{.smallcaps}** — Select the model that is associated with the webhook payload from the dropdown. + - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: + + ```json + { + "action": "run_workflow", + "target": "", + "entity_name": "InventoryModel" + } + ``` + + - For the required authentication headers, click **{{< fa regular copy >}} Copy** for each of the following key-value pairs and paste them into your external system: + - `x-api-key`: `{{API Key}}` + - `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**. + +### b. Start workflow from external system + +Send a POST request to the webhook URL with a JSON payload that includes the `run_workflow` action for the target model CUID: + +```bash +curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ + "action": "run_workflow", + "target": "", + "entity_name": "InventoryModel" +}' +``` +::: + +## Trigger a paused workflow to continue + +Trigger a waiting {{< var vm.product >}} workflow step to continue from an external system. Use this pattern when a workflow pauses at a webhook step and waits for external input before proceeding. + +::: {.panel-tabset} + +### a. Configure workflow in {{< var vm.product >}} + +1. Open the workflow you want to configure, or add a new workflow.[^3] + +2. From the **Workflow Steps** modal, drag and drop a **Webhook** step[^4] onto the canvas, then connect the step to your workflow. + +3. Double-click the step to open the **Webhook Step Trigger** modal. + +4. Copy or select the webhook details: + + - **URL** — Click **{{< fa regular copy >}} Copy** for the unique POST webhook URL to use when configuring your external system. + - **[select target model for payload]{.smallcaps}** — Select the model that is associated with the webhook payload from the dropdown. + - **Payload** — Click **{{< fa regular copy >}} Copy** for the JSON payload that external systems must send in their POST request, where the value for `target_cuid` is shown after you select a target: + + ```json + { + "action": "run_step", + "target": "", + "entity_name": "InventoryModel" + } + ``` + + - For the required authentication headers, click **{{< fa regular copy >}} Copy** for each of the following key-value pairs and paste them into your external system: + - `x-api-key`: `{{API Key}}` + - `x-api-secret`: `{{API Secret}}` + +5. Click **Update Step** to save your configuration. + +When the workflow reaches this step, it pauses and waits for the external system. + +### b. Trigger workflow to continue from external system + +Send a POST request to the webhook URL with a JSON payload containing the `run_step` action for the model CUID: + +```bash +curl -X POST https://api.prod.vm.validmind.ai/vm/api/v1/webhooks/xxxxxxxxxxxxxxxxxxxxxxxxx/xxxx -H 'Content-Type`: `application/json' -H 'x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' -H 'x-api-secret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' --data '{ + "action": "run_step", + "target": "", + "entity_name": "InventoryModel" +}' +``` + +::: + + + +[^1]: [Manage permissions](../../configuration/manage-permissions.qmd) + +[^2]: [Introduction to workflows](../../workflows/introduction-to-workflows.qmd) + +[^3]: [Add new workflows](../../workflows/configure-workflows.qmd#add-new-workflows) + +[^4]: [Workflow step types](../../workflows/workflow-step-types.qmd#webhook) diff --git a/site/guide/integrations/managing-integrations.qmd b/site/guide/integrations/managing-integrations.qmd index da285be92d..2f15044cb0 100644 --- a/site/guide/integrations/managing-integrations.qmd +++ b/site/guide/integrations/managing-integrations.qmd @@ -86,16 +86,40 @@ Link to models in external registries and development platforms and keep invento - AWS Bedrock ::: +::: {.w-20-ns} +- Databricks +::: + ::: {.w-20-ns} - MLflow ::: +::: {.w-20-ns} +  +::: + +:::: + +:::: {.flex .flex-wrap .justify-around} + ::: {.w-20-ns} - GitLab ::: ::: {.w-20-ns} -- Custom integrations +- Custom +::: + +::: {.w-20-ns} +  +::: + +::: {.w-20-ns} +  +::: + +::: {.w-20-ns} +  ::: :::: From b91c76c7d02c2f88a5b92c20a2a8f7305b2096e3 Mon Sep 17 00:00:00 2001 From: Beck <164545837+validbeck@users.noreply.github.com> Date: Thu, 7 May 2026 14:22:40 -0700 Subject: [PATCH 2/2] docs: Models > records phase II (#1312) * WIP * model-documentation > documentation * model-validation > validation * Removing wrong aliases from inventory/ * Aliases for renamed directories * Renaming some files in documentation/ * Reverting notebooks to main, forgor to tell Cursor to ignore * Renaming some files in validation/ * Edit: Working with documentation * Edit: View development guidelines * Save point * Edit: Work with content blocks * WIP * Edit: Work with content blocks * Edit: Work with document versions * Edit: Assign development section statuses * Edit: Check documents for compliance * Edit: Collaborate with others * Submit for approval > Submit documents * Edit: Submit documents * Save point * Updating content of relevant glossary entries * Editing site/documentation/ related training slides * Manage model stages > Manage record stages * save point * Edit: Manage record stages * Edit: Introduction to workflows * Edit: Workflow step types * Edit: Conditional requirements * Renaming: Conditional requirements > Conditional step requirements * Edit: Workflot states & correcting .gitignore * Edit: Setting up workflows * Edit: Configure workflows * WIP: Workflow configuration examples * Edit: Manage workflows * Save point * Save point * Edit: Transition workflows * Edit: Manage workflow tasks * Proofreading workflows/ * Edit: Workflows in training * Renaming some files in validation/ * Edit: Managing validation * Edit: Manage validation guidelines * Edit: Manage artifact types * Edit: Manage artifact severities * Edit: Manage artifact fields * Save point * Edit: Preparing validation reports * Save point * Save point * Edit: Assess compliance * Save point * Save point * Edit: View & filter artifacts * Edit: Customize artifact layouts * Edit: Add & manage artifacts * Edit: Customize artifact overview page * Save point * Save point * Renaming some files in templates/ * Edit: Working with documents * Save point * Edit: Manage document types * Edit: Manage documents * Save point * Edit: Manage text block library * Proofreading templates/ * Edit: access/ * Edit: Managing your organization * Edit: Managing users * Edit: Personalizing ValidMind * Edit: Manage platform notifications * proofread * Map & assess accuracy edits Co-authored-by: Cursor --------- Co-authored-by: Cursor --- .gitignore | 12 ++- site/_quarto.yml | 4 +- .../contributing/style-guide/conventions.qmd | 4 +- .../contributing/using-the-documentation.qmd | 2 +- site/about/glossary/_model-documentation.qmd | 2 +- site/about/glossary/_validmind-features.qmd | 2 +- .../_conceptual-soundness.qmd | 2 +- .../model_documentation/_data-preparation.qmd | 2 +- .../model_documentation/_doc-intro.qmd | 4 +- .../_model-development.qmd | 4 +- .../_monitoring-governance.qmd | 2 +- .../monitoring/_ongoing-monitoring.qmd | 2 +- .../glossary/validation_reports/_actions.qmd | 2 +- .../validation_reports/_artifacts.qmd | 2 +- .../glossary/validation_reports/_evidence.qmd | 2 +- .../validation_reports/_report-intro.qmd | 2 +- .../glossary/validation_reports/_review.qmd | 12 +-- .../validation_reports/_risk-areas.qmd | 4 +- .../validation_reports/_risk-assessment.qmd | 4 +- .../_validation-guidelines.qmd | 2 +- site/about/overview-model-risk-management.qmd | 2 +- site/about/use-cases/e-23.qmd | 8 +- site/about/use-cases/eu-ai-act.qmd | 8 +- site/about/use-cases/sr-11-7.qmd | 6 +- site/about/use-cases/ss1-23.qmd | 10 +- ...stall-and-initialize-validmind-library.qmd | 2 +- .../store-credentials-in-env-file.qmd | 4 +- site/developer/validmind-library.qmd | 6 +- site/faq/faq-collaboration.qmd | 2 +- site/faq/faq-documentation.qmd | 6 +- site/faq/faq-testing.qmd | 4 +- site/faq/faq-validation.qmd | 14 +-- site/faq/faq-workflows.qmd | 2 +- .../developer/quickstart-developer.qmd | 8 +- .../validator/quickstart-validator.qmd | 6 +- site/guide/_sidebar.yaml | 77 ++++++++-------- site/guide/access/accessing-validmind.qmd | 2 +- site/guide/access/log-in-to-validmind.qmd | 6 +- site/guide/access/register-with-validmind.qmd | 6 +- .../attestation/working-with-attestations.qmd | 2 +- site/guide/configuration/_add-roles.qmd | 4 +- .../configuration/_add-stakeholder-types.qmd | 4 +- site/guide/configuration/_add-use-cases.qmd | 4 +- .../_manage-role-permissions.qmd | 4 +- .../_manage-stakeholder-type-permissions.qmd | 4 +- site/guide/configuration/_risk-areas.qmd | 2 +- site/guide/configuration/_user-groups.qmd | 2 +- .../configure-aws-privatelink.qmd | 2 +- .../configure-azure-private-link.qmd | 2 +- .../customize-your-dashboard.qmd | 50 +++++++--- site/guide/configuration/manage-groups.qmd | 2 +- .../manage-platform-notifications.qmd | 10 +- site/guide/configuration/manage-users.qmd | 2 +- site/guide/configuration/managing-users.qmd | 8 +- .../managing-your-organization.qmd | 6 +- .../set-up-your-organization.qmd | 18 ++-- .../documentation/_add-content-blocks.qmd | 32 +++++++ .../_add-test-results.qmd | 18 ++-- .../_check-documents.qmd} | 28 +++--- .../guide/documentation/_comment-activity.qmd | 17 ++++ .../_commenting.qmd | 0 .../_document-checker.qmd | 0 .../documentation/_document-overview.qmd | 34 +++++++ .../_locate-document-overview.qmd | 26 ++++++ .../_submit-for-approval.qmd | 6 +- .../_test-result-metadata.qmd | 0 .../_view-test-result-metadata.qmd | 4 +- .../add-content-block.gif | Bin .../assign-development-section-statuses.qmd} | 19 ++-- .../check-documents-for-compliance.qmd | 9 +- .../checker-gap-identified.png | Bin .../checker-no-significant-gaps.png | Bin .../checker-partial-gap.png | Bin .../checker-selection.png | Bin .../collaborate-with-others.qmd | 39 ++++---- .../content-editing-toolbar.png | Bin .../content_blocks/_generate-with-ai.qmd | 4 +- .../_insert-mathematical-formulas.qmd | 6 +- .../_metric-over-time-block.qmd | 0 .../_reference-field-values.qmd | 10 +- .../content_blocks/_simple-text-block.qmd | 2 +- .../content_blocks/_test-driven-block.qmd | 0 .../content_blocks/equation-preview.png | Bin .../content_blocks/formula-display-modes.png | Bin .../submit-documents.qmd} | 7 +- .../test-driven-block-menu.png | Bin .../view-development-guidelines.qmd} | 21 +++-- .../work-with-content-blocks.qmd | 49 +++++----- .../work-with-document-versions.qmd | 22 +++-- .../work-with-test-results.qmd | 27 +++--- .../working-with-documentation.qmd} | 47 +++++----- site/guide/guides.qmd | 22 ++--- .../configure-analytics-exports.qmd | 2 +- .../integrations/link-external-models.qmd | 2 +- .../inventory/_add-edit-record-types.qmd | 4 +- site/guide/inventory/_field-types.qmd | 10 +- .../inventory/_inventory-record-types.qmd | 4 +- .../inventory/_reference-field-values.qmd | 4 +- .../_view-record-activity-overview.qmd | 8 +- .../inventory/archive-delete-records.qmd | 3 +- .../configure-record-interdependencies.qmd | 1 - .../inventory/customize-inventory-layout.qmd | 1 - .../customize-record-overview-page.qmd | 1 - .../guide/inventory/edit-inventory-fields.qmd | 5 +- .../inventory/manage-inventory-fields.qmd | 1 - .../inventory/managing-the-inventory.qmd | 1 - .../register-records-in-inventory.qmd | 1 - site/guide/inventory/view-record-activity.qmd | 13 ++- .../inventory/working-with-the-inventory.qmd | 5 +- .../_add-content-blocks.qmd | 32 ------- .../model-documentation/_comment-activity.qmd | 17 ---- .../_document-overview.qmd | 34 ------- .../_locate-document-overview.qmd | 26 ------ .../_add-artifacts-on-documentation.qmd | 58 ------------ .../_validation-guidelines.qmd | 5 - site/guide/monitoring/enable-monitoring.qmd | 4 +- site/guide/monitoring/ongoing-monitoring.qmd | 2 +- .../monitoring/review-monitoring-results.qmd | 6 +- .../work-with-metrics-over-time.qmd | 12 +-- .../reporting/_create-a-visualization.qmd | 6 +- site/guide/reporting/_view-report-data.qmd | 8 +- site/guide/reporting/export-analytics.qmd | 2 +- site/guide/reporting/export-artifacts.qmd | 14 +-- site/guide/reporting/export-documents.qmd | 18 ++-- site/guide/reporting/export-inventory.qmd | 2 +- site/guide/reporting/view-report-data.qmd | 4 +- .../reporting/working-with-analytics.qmd | 10 +- site/guide/shared/work-with-filters.qmd | 2 +- site/guide/templates/_add-text-blocks.qmd | 6 +- .../_customize-document-templates.qmd | 26 +++--- site/guide/templates/_document-templates.qmd | 2 +- site/guide/templates/_duplicate-template.qmd | 12 +-- .../guide/templates/_outline-editing-mode.qmd | 2 +- site/guide/templates/_text-blocks.qmd | 4 +- .../templates/_view-document-templates.qmd | 14 +-- .../templates/_what-is-document-checker.qmd | 6 +- .../templates/customize-document-checker.qmd | 2 +- .../customize-document-templates.qmd | 10 +- .../templates/manage-document-templates.qmd | 16 ++-- .../guide/templates/manage-document-types.qmd | 35 +++---- ...del-documents.qmd => manage-documents.qmd} | 55 +++++------ .../templates/manage-text-block-library.qmd | 10 +- .../working-with-document-templates.qmd | 8 +- ...cuments.qmd => working-with-documents.qmd} | 13 ++- .../_add-artifact-severities.qmd | 2 +- .../_add-artifacts-on-documentation.qmd | 58 ++++++++++++ .../_add-edit-artifact-fields.qmd | 14 +-- .../_add-edit-artifact-statuses.qmd | 0 .../_add-edit-artifact-types.qmd | 28 +++--- .../_add-risk-areas.qmd | 2 +- .../_add-validation-guidelines.qmd | 2 +- .../_artifact-fields.qmd | 2 +- .../_artifact-severities.qmd | 2 +- .../_artifact-types.qmd | 4 +- .../_assessment-options.qmd | 0 .../_autogenerate-validation-issues.qmd | 6 +- .../_link-artifacts-to-reports.qmd | 18 ++-- .../_link-validator-evidence.qmd | 12 +-- .../_provide-compliance-assessments.qmd | 12 +-- .../_reorder-artifact-severities.qmd | 0 .../_risk-areas.qmd | 2 +- .../_track-artifact-resolution.qmd | 28 +++--- .../validation/_validation-guidelines.qmd | 5 + .../_view-all-artifacts.qmd | 28 +++--- .../add-manage-artifacts.qmd | 27 +++--- .../assess-compliance-summary.png | Bin .../assess-compliance.qmd | 40 ++++---- .../assess-evidence-panel.png | Bin .../configure-assessment-options.qmd | 2 + .../customize-artifact-layouts.qmd | 21 +++-- .../customize-artifact-overview-page.qmd | 15 +-- .../link-evidence.png | Bin .../manage-artifact-fields.qmd | 7 +- .../manage-artifact-severities.qmd | 7 +- .../manage-artifact-types.qmd | 19 ++-- .../manage-validation-guidelines.qmd | 9 +- .../managing-validation.qmd} | 4 +- .../map-and-assess-evidence.qmd | 86 ++++++++++-------- .../map-evidence-panel.png | Bin .../preparing-validation-reports.qmd | 51 ++++++----- .../review-documentation.qmd} | 21 +++-- .../view-filter-artifacts.qmd | 39 ++++---- .../working-with-artifacts.qmd | 19 ++-- site/guide/workflows/_abort-workflows.qmd | 16 ++-- site/guide/workflows/_add-model-stages.qmd | 15 --- site/guide/workflows/_add-new-workflows.qmd | 50 +++++----- site/guide/workflows/_add-record-stages.qmd | 38 ++++++++ .../workflows/_conditional-requirements.qmd | 22 ++--- .../workflows/_configure-model-stages.qmd | 22 ----- .../workflows/_configure-record-stages.qmd | 22 +++++ .../workflows/_configure-workflow-steps.qmd | 2 +- site/guide/workflows/_initiate-workflows.qmd | 16 ++-- .../workflows/_link-workflow-together.qmd | 8 +- site/guide/workflows/_reset-workflows.qmd | 16 ++-- .../workflows/_review-active-workflows.qmd | 34 +++---- .../workflows/_review-workflow-history.qmd | 26 +++--- site/guide/workflows/_set-up-workflows.qmd | 8 +- .../_transition-workflow-examples.qmd | 22 ++--- .../guide/workflows/_transition-workflows.qmd | 26 +++--- site/guide/workflows/_workflow-states.qmd | 8 +- site/guide/workflows/_workflow-step-types.qmd | 60 ++++++------ ....qmd => conditional-step-requirements.qmd} | 6 +- site/guide/workflows/configure-workflows.qmd | 22 ++--- .../workflows/introduction-to-workflows.qmd | 8 +- ...el-stages.qmd => manage-record-stages.qmd} | 29 +++--- .../guide/workflows/manage-workflow-tasks.qmd | 18 ++-- site/guide/workflows/manage-workflows.qmd | 55 +++++------ site/guide/workflows/setting-up-workflows.qmd | 4 +- site/guide/workflows/transition-workflows.qmd | 12 +-- .../workflow-configuration-examples.qmd | 48 +++++----- site/guide/workflows/workflow-states.qmd | 2 +- .../workflows/working-with-workflows.qmd | 2 +- site/releases/2023/2023-oct-25/highlights.qmd | 4 +- .../2023/release-notes-2023-jul-24.qmd | 6 +- .../2024/2024-dec-06/release-notes.qmd | 14 +-- .../2024/2024-dec-24/release-notes.qmd | 6 +- site/releases/2024/2024-feb-14/highlights.qmd | 4 +- site/releases/2024/2024-jan-18/highlights.qmd | 4 +- site/releases/2024/2024-mar-27/highlights.qmd | 14 +-- .../2024/2024-may-22/release-notes.qmd | 14 +-- .../2024/2024-oct-22/release-notes.qmd | 6 +- .../2024/2024-sep-09/release-notes.qmd | 4 +- .../2024/2024-sep-25/release-notes.qmd | 2 +- .../2025/2025-apr-24/release-notes.qmd | 6 +- .../2025/2025-jan-31/release-notes.qmd | 4 +- .../customizing-your-inventory.qmd | 26 +++--- .../onboarding-your-organization.qmd | 6 +- .../organizational-oversight-reporting.qmd | 8 +- .../using-validmind-for-risk-management.qmd | 33 ++++--- .../common-slides/_document-checker.qmd | 4 +- .../common-slides/_document-overview.qmd | 6 +- .../common-slides/_submit-for-approval.qmd | 4 +- .../common-slides/_work-with-workflows.qmd | 8 +- .../finalizing-model-documentation.qmd | 46 +++++----- .../learning-to-run-tests.qmd | 8 +- .../using-validmind-for-model-development.qmd | 4 +- site/training/program/training-faq.qmd | 6 +- .../training-templates/course-slides.qmd | 6 +- .../developing-challenger-models.qmd | 2 +- .../finalizing-validation-reports.qmd | 40 ++++---- .../running-data-quality-tests.qmd | 2 +- .../using-validmind-for-model-validation.qmd | 12 +-- .../what-is-validmind/what-is-validmind.qmd | 6 +- 243 files changed, 1498 insertions(+), 1401 deletions(-) create mode 100644 site/guide/documentation/_add-content-blocks.qmd rename site/guide/{model-documentation => documentation}/_add-test-results.qmd (66%) rename site/guide/{model-documentation/_check-model-documents.qmd => documentation/_check-documents.qmd} (76%) create mode 100644 site/guide/documentation/_comment-activity.qmd rename site/guide/{model-documentation => documentation}/_commenting.qmd (100%) rename site/guide/{model-documentation => documentation}/_document-checker.qmd (100%) create mode 100644 site/guide/documentation/_document-overview.qmd create mode 100644 site/guide/documentation/_locate-document-overview.qmd rename site/guide/{model-documentation => documentation}/_submit-for-approval.qmd (81%) rename site/guide/{model-documentation => documentation}/_test-result-metadata.qmd (100%) rename site/guide/{model-documentation => documentation}/_view-test-result-metadata.qmd (92%) rename site/guide/{model-documentation => documentation}/add-content-block.gif (100%) rename site/guide/{model-documentation/assign-documentation-section-statuses.qmd => documentation/assign-development-section-statuses.qmd} (61%) rename site/guide/{model-documentation => documentation}/check-documents-for-compliance.qmd (79%) rename site/guide/{model-documentation => documentation}/checker-gap-identified.png (100%) rename site/guide/{model-documentation => documentation}/checker-no-significant-gaps.png (100%) rename site/guide/{model-documentation => documentation}/checker-partial-gap.png (100%) rename site/guide/{model-documentation => documentation}/checker-selection.png (100%) rename site/guide/{model-documentation => documentation}/collaborate-with-others.qmd (81%) rename site/guide/{model-documentation => documentation}/content-editing-toolbar.png (100%) rename site/guide/{model-documentation => documentation}/content_blocks/_generate-with-ai.qmd (89%) rename site/guide/{model-documentation => documentation}/content_blocks/_insert-mathematical-formulas.qmd (72%) rename site/guide/{model-documentation => documentation}/content_blocks/_metric-over-time-block.qmd (100%) rename site/guide/{model-documentation => documentation}/content_blocks/_reference-field-values.qmd (69%) rename site/guide/{model-documentation => documentation}/content_blocks/_simple-text-block.qmd (70%) rename site/guide/{model-documentation => documentation}/content_blocks/_test-driven-block.qmd (100%) rename site/guide/{model-documentation => documentation}/content_blocks/equation-preview.png (100%) rename site/guide/{model-documentation => documentation}/content_blocks/formula-display-modes.png (100%) rename site/guide/{model-documentation/submit-for-approval.qmd => documentation/submit-documents.qmd} (82%) rename site/guide/{model-documentation => documentation}/test-driven-block-menu.png (100%) rename site/guide/{model-documentation/view-documentation-guidelines.qmd => documentation/view-development-guidelines.qmd} (59%) rename site/guide/{model-documentation => documentation}/work-with-content-blocks.qmd (78%) rename site/guide/{model-documentation => documentation}/work-with-document-versions.qmd (68%) rename site/guide/{model-documentation => documentation}/work-with-test-results.qmd (77%) rename site/guide/{model-documentation/working-with-model-documentation.qmd => documentation/working-with-documentation.qmd} (58%) delete mode 100644 site/guide/model-documentation/_add-content-blocks.qmd delete mode 100644 site/guide/model-documentation/_comment-activity.qmd delete mode 100644 site/guide/model-documentation/_document-overview.qmd delete mode 100644 site/guide/model-documentation/_locate-document-overview.qmd delete mode 100644 site/guide/model-validation/_add-artifacts-on-documentation.qmd delete mode 100644 site/guide/model-validation/_validation-guidelines.qmd rename site/guide/templates/{manage-model-documents.qmd => manage-documents.qmd} (79%) rename site/guide/templates/{working-with-model-documents.qmd => working-with-documents.qmd} (55%) rename site/guide/{model-validation => validation}/_add-artifact-severities.qmd (91%) create mode 100644 site/guide/validation/_add-artifacts-on-documentation.qmd rename site/guide/{model-validation => validation}/_add-edit-artifact-fields.qmd (75%) rename site/guide/{model-validation => validation}/_add-edit-artifact-statuses.qmd (100%) rename site/guide/{model-validation => validation}/_add-edit-artifact-types.qmd (65%) rename site/guide/{model-validation => validation}/_add-risk-areas.qmd (93%) rename site/guide/{model-validation => validation}/_add-validation-guidelines.qmd (94%) rename site/guide/{model-validation => validation}/_artifact-fields.qmd (74%) rename site/guide/{model-validation => validation}/_artifact-severities.qmd (58%) rename site/guide/{model-validation => validation}/_artifact-types.qmd (85%) rename site/guide/{model-validation => validation}/_assessment-options.qmd (100%) rename site/guide/{model-validation => validation}/_autogenerate-validation-issues.qmd (86%) rename site/guide/{model-validation => validation}/_link-artifacts-to-reports.qmd (72%) rename site/guide/{model-validation => validation}/_link-validator-evidence.qmd (79%) rename site/guide/{model-validation => validation}/_provide-compliance-assessments.qmd (68%) rename site/guide/{model-validation => validation}/_reorder-artifact-severities.qmd (100%) rename site/guide/{model-validation => validation}/_risk-areas.qmd (81%) rename site/guide/{model-validation => validation}/_track-artifact-resolution.qmd (67%) create mode 100644 site/guide/validation/_validation-guidelines.qmd rename site/guide/{model-validation => validation}/_view-all-artifacts.qmd (53%) rename site/guide/{model-validation => validation}/add-manage-artifacts.qmd (75%) rename site/guide/{model-validation => validation}/assess-compliance-summary.png (100%) rename site/guide/{model-validation => validation}/assess-compliance.qmd (70%) rename site/guide/{model-validation => validation}/assess-evidence-panel.png (100%) rename site/guide/{model-validation => validation}/configure-assessment-options.qmd (97%) rename site/guide/{model-validation => validation}/customize-artifact-layouts.qmd (84%) rename site/guide/{model-validation => validation}/customize-artifact-overview-page.qmd (79%) rename site/guide/{model-validation => validation}/link-evidence.png (100%) rename site/guide/{model-validation => validation}/manage-artifact-fields.qmd (93%) rename site/guide/{model-validation => validation}/manage-artifact-severities.qmd (87%) rename site/guide/{model-validation => validation}/manage-artifact-types.qmd (76%) rename site/guide/{model-validation => validation}/manage-validation-guidelines.qmd (94%) rename site/guide/{model-validation/managing-model-validation.qmd => validation/managing-validation.qmd} (92%) rename site/guide/{model-validation => validation}/map-and-assess-evidence.qmd (76%) rename site/guide/{model-validation => validation}/map-evidence-panel.png (100%) rename site/guide/{model-validation => validation}/preparing-validation-reports.qmd (71%) rename site/guide/{model-validation/review-model-documentation.qmd => validation/review-documentation.qmd} (57%) rename site/guide/{model-validation => validation}/view-filter-artifacts.qmd (73%) rename site/guide/{model-validation => validation}/working-with-artifacts.qmd (65%) delete mode 100644 site/guide/workflows/_add-model-stages.qmd create mode 100644 site/guide/workflows/_add-record-stages.qmd delete mode 100644 site/guide/workflows/_configure-model-stages.qmd create mode 100644 site/guide/workflows/_configure-record-stages.qmd rename site/guide/workflows/{conditional-requirements.qmd => conditional-step-requirements.qmd} (90%) rename site/guide/workflows/{manage-model-stages.qmd => manage-record-stages.qmd} (62%) diff --git a/.gitignore b/.gitignore index f4de6a8af5..73cd78380b 100644 --- a/.gitignore +++ b/.gitignore @@ -22,13 +22,17 @@ release-scripts/__pycache__ site/installation # Release notes source tracked in private repository -site/releases +# Release notes source tracked in private repository +site/releases/** !site/releases/all-releases.qmd !site/releases/_how-to-upgrade.qmd !site/releases/_sidebar.yaml -!site/releases/2023 -!site/releases/2024 -!site/releases/2025 +!site/releases/2023/ +!site/releases/2023/** +!site/releases/2024/ +!site/releases/2024/** +!site/releases/2025/ +!site/releases/2025/** # Generated ConfigMap for Docker profile site/validmind-docs.yaml diff --git a/site/_quarto.yml b/site/_quarto.yml index ae3177d684..28da8c4f4e 100644 --- a/site/_quarto.yml +++ b/site/_quarto.yml @@ -205,8 +205,8 @@ website:
  • Documents & templates
    • -
  • Documentation
    • -
  • Validation
    • +
  • Documentation
    • +
  • Validation
  • Reporting
  • Monitoring
  • Attestation
    • diff --git a/site/about/contributing/style-guide/conventions.qmd b/site/about/contributing/style-guide/conventions.qmd index 5b24fac015..351ed06336 100644 --- a/site/about/contributing/style-guide/conventions.qmd +++ b/site/about/contributing/style-guide/conventions.qmd @@ -166,7 +166,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o ```markdown - - The model is registered in the model inventory.[^1] + - The record is registered in the inventory.[^1] - You've already customized your model lifecycle statuses for use in workflows.[^2] - Workflows have already been set up for use with your models.[^3] - You are assigned a role that has access to complete actions set up by workflows.[^5] @@ -175,7 +175,7 @@ Using a markdown button also enables you to link to to the `.qmd` path instead o [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) - [^2]: [Manage model stages](manage-model-stages.qmd) + [^2]: [Manage record stages](manage-record-stages.qmd) [^3]: [Configure workflows](configure-workflows.qmd) diff --git a/site/about/contributing/using-the-documentation.qmd b/site/about/contributing/using-the-documentation.qmd index ea285bf4a5..4757f97f7b 100644 --- a/site/about/contributing/using-the-documentation.qmd +++ b/site/about/contributing/using-the-documentation.qmd @@ -52,7 +52,7 @@ Step-by-step instructions for platform tasks, organized by feature area. | [Integrations](/guide/integrations/managing-integrations.qmd) | Connecting {{< var vm.product >}} to external systems | Manage secrets, configure connections, link external models | | [Workflows](/guide/guides.qmd#workflows) | Automating model lifecycle processes | Configure workflow steps, manage transitions, set up approvals | | [Inventory](/guide/guides.qmd#inventory) | Managing your model and record inventory | Register records, edit fields, configure interdependencies | -| [Documents & templates](/guide/templates/working-with-model-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library | +| [Documents & templates](/guide/templates/working-with-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library | | [Model documentation](/guide/guides.qmd#model-documentation) | Authoring and collaborating on model docs | Edit content blocks, add test results, manage versions, submit for approval | | [Model validation](/guide/guides.qmd#model-validation) | Reviewing and validating models | Review documentation, assess compliance, manage findings and artifacts | | [Reporting](/guide/guides.qmd#reporting) | Analyzing and exporting data | View reports, create custom analytics, export inventory and documents | diff --git a/site/about/glossary/_model-documentation.qmd b/site/about/glossary/_model-documentation.qmd index c5de5edd58..b0c983236b 100644 --- a/site/about/glossary/_model-documentation.qmd +++ b/site/about/glossary/_model-documentation.qmd @@ -7,7 +7,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Create a new file under the `about/glossary/model_documentation` folder with the following structure `_doc-feature.qmd` (the `_` is mandatory for Quarto to retrieve the file as a single-source embed: https://quarto.org/docs/authoring/includes.html) 2. Embed it below in ABC order with the structure `{{< include model_documentation/_doc-feature.qmd >}}` -These instructions update the documentation concept on `working-with-model-documentation.qmd` as well as the glossary. +These instructions update the documentation concept on `working-with-documentation.qmd` as well as the glossary. --> diff --git a/site/about/glossary/_validmind-features.qmd b/site/about/glossary/_validmind-features.qmd index b53f80ca4c..2be12d5923 100644 --- a/site/about/glossary/_validmind-features.qmd +++ b/site/about/glossary/_validmind-features.qmd @@ -8,7 +8,7 @@ client library, Python client library : Enables the interaction of your development environment with the {{< var validmind.platform >}} as part of the {{< var validmind.developer >}}. content block -: Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, ongoing monitoring reports, and custom document types.^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)] +: Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, ongoing monitoring reports, and custom document types.^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)] documentation automation : A core benefit of {{< var vm.product >}} that allows for the automatic creation of model documentation using predefined templates and test suites. diff --git a/site/about/glossary/model_documentation/_conceptual-soundness.qmd b/site/about/glossary/model_documentation/_conceptual-soundness.qmd index 9138732ae8..b173ee9f63 100644 --- a/site/about/glossary/model_documentation/_conceptual-soundness.qmd +++ b/site/about/glossary/model_documentation/_conceptual-soundness.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> conceptual soundness -: Establishes the foundation of the model, covering the model overview, intended use and business use case, regulatory requirements, model limitations, and the rationale behind the model selection. It emphasizes the model’s purpose, scope, and constraints, which are crucial for stakeholders to understand the model’s applicability and limitations. +: Establishes the foundation of a selected record such as a model, covering the overview, intended use and business use case, regulatory requirements, limitations, and the rationale behind selection. It emphasizes purpose, scope, and constraints, which are crucial for stakeholders to understand applicability and limitations. diff --git a/site/about/glossary/model_documentation/_data-preparation.qmd b/site/about/glossary/model_documentation/_data-preparation.qmd index 6a87f5962e..9a5b539e85 100644 --- a/site/about/glossary/model_documentation/_data-preparation.qmd +++ b/site/about/glossary/model_documentation/_data-preparation.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> data preparation -: Details the data description, including dataset summary, data quality tests, descriptive statistics, correlations and interactions, and feature selection and engineering. It provides transparency into the data used for model training, ensuring that the model is built on a solid and relevant dataset. \ No newline at end of file +: Details the data description, including dataset summary, data quality tests, descriptive statistics, correlations and interactions, and feature selection and engineering. It provides transparency into the data used for training, ensuring that the record such as a model is built on a solid and relevant dataset. \ No newline at end of file diff --git a/site/about/glossary/model_documentation/_doc-intro.qmd b/site/about/glossary/model_documentation/_doc-intro.qmd index b64a31bf31..1379697211 100644 --- a/site/about/glossary/model_documentation/_doc-intro.qmd +++ b/site/about/glossary/model_documentation/_doc-intro.qmd @@ -2,4 +2,6 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Each section of your model documentation should address critical aspects of the model’s lifecycle, from conceptualization and data preparation through development and ongoing management. This comprehensive documentation approach is essential for ensuring the model’s reliability, relevance, and compliance with business and regulatory standards. \ No newline at end of file +Each section of your development documentation should address critical aspects of the record’s lifecycle, from conceptualization and data preparation through development and ongoing management. This comprehensive documentation approach is essential for ensuring the record’s reliability, relevance, and compliance with business and regulatory standards. + +For example, documentation for models typically include sections on: \ No newline at end of file diff --git a/site/about/glossary/model_documentation/_model-development.qmd b/site/about/glossary/model_documentation/_model-development.qmd index 4e0996693f..5acf1242eb 100644 --- a/site/about/glossary/model_documentation/_model-development.qmd +++ b/site/about/glossary/model_documentation/_model-development.qmd @@ -2,5 +2,5 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -model development -: Discusses the model training, evaluation, explainability, interpretability, and diagnosis, including model weak spots, overfit regions, and robustness. This section is vital for understanding how the model was developed, how it performs, and its areas of strength and weakness. +model development, development +: Discusses the training, evaluation, explainability, interpretability, and diagnosis, including weak spots, overfit regions, and robustness. This section is vital for understanding how the record such as a model was developed, how it performs, and its areas of strength and weakness. diff --git a/site/about/glossary/model_documentation/_monitoring-governance.qmd b/site/about/glossary/model_documentation/_monitoring-governance.qmd index d1f1072f93..9d6426d097 100644 --- a/site/about/glossary/model_documentation/_monitoring-governance.qmd +++ b/site/about/glossary/model_documentation/_monitoring-governance.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> monitoring and governance -: Focuses on the model’s ongoing monitoring plan, implementation, and governance plan. It outlines strategies for maintaining the model’s performance over time and ensuring that it remains compliant with regulatory requirements and ethical standards. \ No newline at end of file +: Focuses on the record such as a model’s ongoing monitoring plan, implementation, and governance plan. It outlines strategies for maintaining the performance over time and ensuring that it remains compliant with regulatory requirements and ethical standards. \ No newline at end of file diff --git a/site/about/glossary/monitoring/_ongoing-monitoring.qmd b/site/about/glossary/monitoring/_ongoing-monitoring.qmd index 96673a6b97..818f5ac5f9 100644 --- a/site/about/glossary/monitoring/_ongoing-monitoring.qmd +++ b/site/about/glossary/monitoring/_ongoing-monitoring.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ongoing monitoring -: A periodic report assessing the model's performance and compliance over time, ensuring it remains valid under changing conditions. \ No newline at end of file +: A periodic report assessing the tool such as a model's performance and compliance over time, ensuring it remains valid under changing conditions. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_actions.qmd b/site/about/glossary/validation_reports/_actions.qmd index b32d0dd3d6..8b03716120 100644 --- a/site/about/glossary/validation_reports/_actions.qmd +++ b/site/about/glossary/validation_reports/_actions.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> actions -: Recommended steps or measures to address artifacts from model validation or risk assessments. \ No newline at end of file +: Recommended steps or measures to address artifacts from validation or risk assessments. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_artifacts.qmd b/site/about/glossary/validation_reports/_artifacts.qmd index 4bfdaa2030..fc3c7cfe8b 100644 --- a/site/about/glossary/validation_reports/_artifacts.qmd +++ b/site/about/glossary/validation_reports/_artifacts.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> artifacts (previously findings) -: Observations or issues identified during model validation, including any deviations from expected performance or standards. Artifacts are organized by type — default types include Validation Issue, Policy Exception, and Model Limitation. Custom artifact types such as Change Management Record can be created to track other categories relevant to your organization. \ No newline at end of file +: Observations or issues identified during validation, including any deviations from expected performance or standards. Artifacts are organized by type — default types include Validation Issue, Policy Exception, and Limitation. Custom artifact types such as Change Management Record can be created to track other categories relevant to your organization. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_evidence.qmd b/site/about/glossary/validation_reports/_evidence.qmd index ab329b5867..8edb8954ae 100644 --- a/site/about/glossary/validation_reports/_evidence.qmd +++ b/site/about/glossary/validation_reports/_evidence.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> evidence -: Material provided by the developer and reviewed by the validator, such as model documentation, source code, datasets, monitoring reports or previous validation reports. \ No newline at end of file +: Material provided by the developer and reviewed by the validator, such as documentation, source code, datasets, monitoring reports or previous validation reports. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_report-intro.qmd b/site/about/glossary/validation_reports/_report-intro.qmd index 7033338d1b..ed19217e3a 100644 --- a/site/about/glossary/validation_reports/_report-intro.qmd +++ b/site/about/glossary/validation_reports/_report-intro.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -A validation report is a comprehensive review that evaluates a model's accuracy, performance, and suitability for its intended purpose. It encompasses the process of model risk assessment, identifying areas of potential error or risk within the model's components, such as data inputs and algorithms. The report follows established validation guidelines to ensure consistency and adherence to internal and regulatory standards. \ No newline at end of file +A validation report is a comprehensive review that evaluates a record's accuracy, performance, and suitability for its intended purpose. It encompasses the process of risk assessment, identifying areas of potential error or risk within the record's components, such as data inputs and algorithms. The report follows established validation guidelines to ensure consistency and adherence to internal and regulatory standards. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_review.qmd b/site/about/glossary/validation_reports/_review.qmd index e021109294..898761f7f5 100644 --- a/site/about/glossary/validation_reports/_review.qmd +++ b/site/about/glossary/validation_reports/_review.qmd @@ -3,14 +3,14 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> review -: Entails a comprehensive evaluation process covering four key aspects of model documentation to ensure thoroughness, compliance, and reliability: +: Entails a comprehensive evaluation process covering four key aspects of documentation to ensure thoroughness, compliance, and reliability: -- **Conceptual soundness** — Examines the foundational elements of the model, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the model's purpose, scope, and constraints are well-defined and understood by stakeholders. +- **Conceptual soundness** — Examines the foundational elements of the record, including its overview, intended business use, regulatory requirements, and limitations. Ensures that the record's purpose, scope, and constraints are well-defined and understood by stakeholders. -- **Data preparation** — Assesses the quality and preparation of the data used for model training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the model is built on a robust and relevant dataset. +- **Data preparation** — Assesses the quality and preparation of the data used for record training. Includes a detailed look at dataset summaries, data quality tests, descriptive statistics, correlations, interactions, and feature engineering. The aim is to verify that the record is built on a robust and relevant dataset. -- **Model development** — Focuses on the model's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the model’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically. +- **Development** — Focuses on the record's development process, including training, evaluation, explainability, interpretability, and diagnosis. Highlights the record’s performance, identifies strengths and weaknesses, and ensures that any potential issues such as overfitting are addressed. Evaluates the assumptions made and examines the qualitative information and judgments to ensure they are conducted appropriately and systematically. -- **Monitoring and governance** — Evaluates the ongoing strategies for monitoring the model's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the model's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the model's documented results. +- **Monitoring and governance** — Evaluates the ongoing strategies for monitoring the record's performance and ensuring compliance with regulatory and ethical standards. Involves checking the implementation of the monitoring plan and governance strategies to maintain the record's efficacy over time. Covers reporting outputs to ensure transparency and accuracy in the record's documented results. -These elements collectively ensure that the model documentation is thorough, transparent, and meets all necessary standards and regulatory requirements. \ No newline at end of file +These elements collectively ensure that the documentation is thorough, transparent, and meets all necessary standards and regulatory requirements. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_risk-areas.qmd b/site/about/glossary/validation_reports/_risk-areas.qmd index 597312db48..34169742e5 100644 --- a/site/about/glossary/validation_reports/_risk-areas.qmd +++ b/site/about/glossary/validation_reports/_risk-areas.qmd @@ -2,5 +2,5 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -model risk areas -: Specific components or aspects of a model where risk might be present, such as data inputs, algorithms, or implementation. \ No newline at end of file +model risk areas, risk areas +: Specific components or aspects of a record such as a model where risk might be present, such as data inputs, algorithms, or implementation. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_risk-assessment.qmd b/site/about/glossary/validation_reports/_risk-assessment.qmd index 11ab0598db..b862511921 100644 --- a/site/about/glossary/validation_reports/_risk-assessment.qmd +++ b/site/about/glossary/validation_reports/_risk-assessment.qmd @@ -2,5 +2,5 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -model risk assessment -: The process of identifying and evaluating risks associated with the use and potential errors in a financial model. \ No newline at end of file +model risk assessment, risk assessment +: The process of identifying and evaluating risks associated with the use and potential errors in a record such as a model. \ No newline at end of file diff --git a/site/about/glossary/validation_reports/_validation-guidelines.qmd b/site/about/glossary/validation_reports/_validation-guidelines.qmd index 3eb055e663..77930799af 100644 --- a/site/about/glossary/validation_reports/_validation-guidelines.qmd +++ b/site/about/glossary/validation_reports/_validation-guidelines.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> validation guidelines -: Established standards or procedures for conducting thorough and consistent model validations, usually aligned with principles within specific models or AI risk frameworks. \ No newline at end of file +: Established standards or procedures for conducting thorough and consistent validations, usually aligned with principles within specific tools such as models or AI risk frameworks. \ No newline at end of file diff --git a/site/about/overview-model-risk-management.qmd b/site/about/overview-model-risk-management.qmd index a37d5d7a71..81a6d137ed 100644 --- a/site/about/overview-model-risk-management.qmd +++ b/site/about/overview-model-risk-management.qmd @@ -217,7 +217,7 @@ By integrating these features, {{< var vm.product >}} provides a comprehensive s [^1]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) -[^2]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^2]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) [^3]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) diff --git a/site/about/use-cases/e-23.qmd b/site/about/use-cases/e-23.qmd index 1351be8a51..9ccc061a89 100644 --- a/site/about/use-cases/e-23.qmd +++ b/site/about/use-cases/e-23.qmd @@ -141,17 +141,17 @@ Use this checklist to track your E-23 implementation progress: [^4]: [Run tests and test suites](/developer/how-to/testing-overview.qmd) -[^5]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^5]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^6]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) -[^7]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^7]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^8]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) [^9]: [Run tests and test suites](/developer/how-to/testing-overview.qmd) -[^10]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^10]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^11]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) @@ -159,4 +159,4 @@ Use this checklist to track your E-23 implementation progress: [^13]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) -[^14]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) +[^14]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) diff --git a/site/about/use-cases/eu-ai-act.qmd b/site/about/use-cases/eu-ai-act.qmd index 9616a96761..a33f793e66 100644 --- a/site/about/use-cases/eu-ai-act.qmd +++ b/site/about/use-cases/eu-ai-act.qmd @@ -239,11 +239,11 @@ Integrate all components into a complete compliance workflow addressing Articles [^7]: [Test descriptions](/developer/test-descriptions.qmd) -[^8]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) +[^8]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) -[^9]: [Prepare validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^9]: [Prepare validation reports](/guide/validation/preparing-validation-reports.qmd) -[^10]: [Work with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^10]: [Work with artifacts](/guide/validation/working-with-artifacts.qmd) [^11]: [Work with analytics](/guide/reporting/working-with-analytics.qmd) @@ -253,7 +253,7 @@ Integrate all components into a complete compliance workflow addressing Articles [^14]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) -[^15]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^15]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^16]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd) diff --git a/site/about/use-cases/sr-11-7.qmd b/site/about/use-cases/sr-11-7.qmd index f97d5ed696..ad4b573fda 100644 --- a/site/about/use-cases/sr-11-7.qmd +++ b/site/about/use-cases/sr-11-7.qmd @@ -209,13 +209,13 @@ Establish governance framework aligned to SR 11-7. [^4]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) -[^5]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^5]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^6]: [Run tests and test suites](/developer/how-to/testing-overview.qmd) -[^7]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^7]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) -[^8]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^8]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^9]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) diff --git a/site/about/use-cases/ss1-23.qmd b/site/about/use-cases/ss1-23.qmd index 839ac85387..e05f99750c 100644 --- a/site/about/use-cases/ss1-23.qmd +++ b/site/about/use-cases/ss1-23.qmd @@ -222,19 +222,19 @@ Document your proportionality assessment and how it influences your MRM framewor [^7]: [Configure workflows](/guide/workflows/configure-workflows.qmd) -[^8]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^8]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) -[^9]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^9]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) -[^10]: [Work with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^10]: [Work with artifacts](/guide/validation/working-with-artifacts.qmd) [^11]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) [^12]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) -[^13]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) +[^13]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) [^14]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) -[^15]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^15]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) diff --git a/site/developer/model-documentation/install-and-initialize-validmind-library.qmd b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd index 408fa86643..da77325b88 100644 --- a/site/developer/model-documentation/install-and-initialize-validmind-library.qmd +++ b/site/developer/model-documentation/install-and-initialize-validmind-library.qmd @@ -154,7 +154,7 @@ Version: 2.11.0 [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) [^6]: [Upgrade the {{< var validmind.developer >}}](#upgrade-validmind) diff --git a/site/developer/model-documentation/store-credentials-in-env-file.qmd b/site/developer/model-documentation/store-credentials-in-env-file.qmd index 9b496dd145..484ec10487 100644 --- a/site/developer/model-documentation/store-credentials-in-env-file.qmd +++ b/site/developer/model-documentation/store-credentials-in-env-file.qmd @@ -38,7 +38,7 @@ Keeping model credentials in a separate file also allows for precise access cont ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] +- [x] The record you want to store credentials for is registered in the inventory.[^1] - [x] You are the record owner, model validator, or another model stakeholder with sufficient permissions to perform the tasks in this guide.[^2] ::: {.callout} @@ -159,7 +159,7 @@ c. Run the cell. [^3]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^4]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^4]: [Working with documents](/guide/templates/working-with-documents.qmd) [^5]: diff --git a/site/developer/validmind-library.qmd b/site/developer/validmind-library.qmd index 8970eb565f..698a4b4d93 100644 --- a/site/developer/validmind-library.qmd +++ b/site/developer/validmind-library.qmd @@ -81,8 +81,8 @@ listing: sort: false fields: [title, description] contents: - - ../guide/model-documentation/work-with-test-results.qmd - - ../guide/model-documentation/work-with-content-blocks.qmd + - ../guide/documentation/work-with-test-results.qmd + - ../guide/documentation/work-with-content-blocks.qmd --- The {{< var validmind.developer >}} streamlines model development and validation by automating testing. Run tests, log those test results to the {{< var validmind.platform >}}, and have fully supported drafts of documentation or reporting ready for you to fine-tune. @@ -186,4 +186,4 @@ After you have tried out the {{< var validmind.developer >}}, continue working w [^2]: [{{< var vm.product >}} for model validation](#validation) -[^3]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) \ No newline at end of file +[^3]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) \ No newline at end of file diff --git a/site/faq/faq-collaboration.qmd b/site/faq/faq-collaboration.qmd index 048a8634d3..c1901b8180 100644 --- a/site/faq/faq-collaboration.qmd +++ b/site/faq/faq-collaboration.qmd @@ -15,7 +15,7 @@ listing: fields: [title, description] contents: - ../guide/inventory/view-record-activity.qmd - - ../guide/model-documentation/collaborate-with-others.qmd + - ../guide/documentation/collaborate-with-others.qmd - ../guide/workflows/working-with-workflows.qmd categories: ["real-time collaboration", "documents","documentation", "record activity", "auditing", "workflows", "model lifecycle", "validmind platform"] --- diff --git a/site/faq/faq-documentation.qmd b/site/faq/faq-documentation.qmd index 52aa81d02b..244940cf56 100644 --- a/site/faq/faq-documentation.qmd +++ b/site/faq/faq-documentation.qmd @@ -15,7 +15,7 @@ listing: fields: [title, description] contents: - ../guide/templates/working-with-document-templates.qmd - - ../guide/model-documentation/working-with-model-documentation.qmd + - ../guide/documentation/working-with-documentation.qmd categories: ["templates", "documents", "documentation","customization", "images", "validmind platform", "validmind library"] --- @@ -106,9 +106,9 @@ These features are currently on the roadmap and under research, no release sched [^6]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) -[^7]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) +[^7]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) -[^8]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd) +[^8]: [Work with test results](/guide/documentation/work-with-test-results.qmd) [^9]: [`assign_predictions()`](/validmind/validmind/vm_models.qmd#assign_predictions) diff --git a/site/faq/faq-testing.qmd b/site/faq/faq-testing.qmd index dcf8a4cbc0..eeea2514f0 100644 --- a/site/faq/faq-testing.qmd +++ b/site/faq/faq-testing.qmd @@ -107,7 +107,7 @@ Check out our introductory series — [**{{< var vm.product >}} for model valida [^8]: [Customize test result descriptions](/notebooks/how_to/tests/run_tests/configure_tests/customize_test_result_descriptions.ipynb) -[^9]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd) +[^9]: [Work with test results](/guide/documentation/work-with-test-results.qmd) [^10]: [Can we configure, customize, or add our own tests?](#can-we-configure-customize-or-add-our-own-tests) @@ -115,7 +115,7 @@ Check out our introductory series — [**{{< var vm.product >}} for model valida [^12]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) -[^13]: [Assess compliance](/guide/model-validation/assess-compliance.qmd#link-validator-evidence) +[^13]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-validator-evidence) [^14]: [Can we configure, customize, or add our own tests?](#can-we-configure-customize-or-add-our-own-tests) diff --git a/site/faq/faq-validation.qmd b/site/faq/faq-validation.qmd index 6af56647af..ee56299e2a 100644 --- a/site/faq/faq-validation.qmd +++ b/site/faq/faq-validation.qmd @@ -14,9 +14,9 @@ listing: sort: false fields: [title, description] contents: - - ../guide/model-validation/manage-validation-guidelines.qmd - - ../guide/model-validation/preparing-validation-reports.qmd - - ../guide/model-validation/working-with-artifacts.qmd + - ../guide/validation/manage-validation-guidelines.qmd + - ../guide/validation/preparing-validation-reports.qmd + - ../guide/validation/working-with-artifacts.qmd categories: ["model validation", "validation guidelines", "model artifacts", "findings", "model documentation", "templates", "compliance", "validmind platform"] --- @@ -75,10 +75,10 @@ Custom artifact types support the same features as default types, including cust [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^3]: [Assess compliance](/guide/model-validation/assess-compliance.qmd) +[^3]: [Assess compliance](/guide/validation/assess-compliance.qmd) -[^4]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) +[^4]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) -[^5]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd) +[^5]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd) -[^6]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) \ No newline at end of file +[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) \ No newline at end of file diff --git a/site/faq/faq-workflows.qmd b/site/faq/faq-workflows.qmd index 466236394d..a11bf82fb3 100644 --- a/site/faq/faq-workflows.qmd +++ b/site/faq/faq-workflows.qmd @@ -15,7 +15,7 @@ listing: fields: [title, description] contents: - ../guide/workflows/working-with-workflows.qmd - - ../guide/workflows/manage-model-stages.qmd + - ../guide/workflows/manage-record-stages.qmd - ../guide/inventory/manage-inventory-fields.qmd - ../guide/attestation/working-with-attestations.qmd categories: ["workflows", "model lifecycle", "lifecycle statuses", "attestations", "validmind platform", "validmind library"] diff --git a/site/get-started/developer/quickstart-developer.qmd b/site/get-started/developer/quickstart-developer.qmd index d3c14bbc1a..a3f75af042 100644 --- a/site/get-started/developer/quickstart-developer.qmd +++ b/site/get-started/developer/quickstart-developer.qmd @@ -142,10 +142,10 @@ Now that you've grasped the basics of using {{< var vm.product >}} for model dev [^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) -[^4]: [Assign documentation section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd) +[^4]: [Assign development section statuses](/guide/documentation/assign-development-section-statuses.qmd) -[^5]: [View documentation guidelines](/guide/model-documentation/view-documentation-guidelines.qmd) +[^5]: [View development guidelines](/guide/documentation/view-development-guidelines.qmd) -[^6]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) +[^6]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) -[^7]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd) +[^7]: [Work with test results](/guide/documentation/work-with-test-results.qmd) diff --git a/site/get-started/validator/quickstart-validator.qmd b/site/get-started/validator/quickstart-validator.qmd index 912420fca1..8ca60db6f1 100644 --- a/site/get-started/validator/quickstart-validator.qmd +++ b/site/get-started/validator/quickstart-validator.qmd @@ -173,9 +173,9 @@ Now that you've grasped the basics of using {{< var vm.product >}} for model val [^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd) -[^4]: [Assess compliance](/guide/model-validation/assess-compliance.qmd#provide-compliance-assessments) +[^4]: [Assess compliance](/guide/validation/assess-compliance.qmd#provide-compliance-assessments) -[^5]: [Assess compliance](/guide/model-validation/assess-compliance.qmd#link-validator-evidence) +[^5]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-validator-evidence) -[^6]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports) +[^6]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports) diff --git a/site/guide/_sidebar.yaml b/site/guide/_sidebar.yaml index 6017e69619..bf5173df14 100644 --- a/site/guide/_sidebar.yaml +++ b/site/guide/_sidebar.yaml @@ -64,11 +64,12 @@ website: - file: guide/workflows/introduction-to-workflows.qmd contents: - guide/workflows/workflow-step-types.qmd - - guide/workflows/conditional-requirements.qmd + - text: "Conditional requirements" + file: guide/workflows/conditional-step-requirements.qmd - guide/workflows/workflow-states.qmd - file: guide/workflows/setting-up-workflows.qmd contents: - - guide/workflows/manage-model-stages.qmd + - guide/workflows/manage-record-stages.qmd - guide/workflows/configure-workflows.qmd - guide/workflows/workflow-configuration-examples.qmd - file: guide/workflows/working-with-workflows.qmd @@ -99,10 +100,10 @@ website: - text: "---" - section: "Documents & templates" contents: - - file: guide/templates/working-with-model-documents.qmd + - file: guide/templates/working-with-documents.qmd contents: - guide/templates/manage-document-types.qmd - - guide/templates/manage-model-documents.qmd + - guide/templates/manage-documents.qmd - text: "Working with templates" file: guide/templates/working-with-document-templates.qmd contents: @@ -112,48 +113,48 @@ website: - text: "Customize document checker" file: guide/templates/customize-document-checker.qmd - text: "---" - - section: "Model documentation" + - section: "Documentation" contents: - text: "Working with documentation" - file: guide/model-documentation/working-with-model-documentation.qmd + file: guide/documentation/working-with-documentation.qmd contents: - - guide/model-documentation/view-documentation-guidelines.qmd - - guide/model-documentation/work-with-content-blocks.qmd - - guide/model-documentation/work-with-test-results.qmd - - guide/model-documentation/work-with-document-versions.qmd + - guide/documentation/view-development-guidelines.qmd + - guide/documentation/work-with-content-blocks.qmd + - guide/documentation/work-with-test-results.qmd + - guide/documentation/work-with-document-versions.qmd - text: "Assign section statuses" - file: guide/model-documentation/assign-documentation-section-statuses.qmd + file: guide/documentation/assign-development-section-statuses.qmd - text: "Check for compliance" - file: guide/model-documentation/check-documents-for-compliance.qmd - - guide/model-documentation/collaborate-with-others.qmd - - guide/model-documentation/submit-for-approval.qmd + file: guide/documentation/check-documents-for-compliance.qmd + - guide/documentation/collaborate-with-others.qmd + - guide/documentation/submit-documents.qmd - text: "---" - - section: "Model validation" + - section: "Validation" contents: - - file: guide/model-validation/managing-model-validation.qmd - contents: - - guide/model-validation/manage-validation-guidelines.qmd - - guide/model-validation/configure-assessment-options.qmd - - guide/model-validation/manage-artifact-types.qmd - - guide/model-validation/manage-artifact-severities.qmd - - guide/model-validation/manage-artifact-fields.qmd - - file: guide/model-validation/preparing-validation-reports.qmd - contents: - - guide/model-validation/review-model-documentation.qmd - - guide/model-validation/assess-compliance.qmd - - guide/model-validation/map-and-assess-evidence.qmd - - guide/model-documentation/work-with-content-blocks.qmd - - guide/model-documentation/work-with-document-versions.qmd + - file: guide/validation/managing-validation.qmd + contents: + - guide/validation/manage-validation-guidelines.qmd + - guide/validation/configure-assessment-options.qmd + - guide/validation/manage-artifact-types.qmd + - guide/validation/manage-artifact-severities.qmd + - guide/validation/manage-artifact-fields.qmd + - file: guide/validation/preparing-validation-reports.qmd + contents: + - guide/validation/review-documentation.qmd + - guide/validation/map-and-assess-evidence.qmd + - guide/validation/assess-compliance.qmd + - guide/documentation/work-with-content-blocks.qmd + - guide/documentation/work-with-document-versions.qmd - text: "Check for compliance" - file: guide/model-documentation/check-documents-for-compliance.qmd - - guide/model-documentation/collaborate-with-others.qmd - - guide/model-documentation/submit-for-approval.qmd - - file: guide/model-validation/working-with-artifacts.qmd - contents: - - guide/model-validation/view-filter-artifacts.qmd - - guide/model-validation/customize-artifact-layouts.qmd - - guide/model-validation/add-manage-artifacts.qmd - - guide/model-validation/customize-artifact-overview-page.qmd + file: guide/documentation/check-documents-for-compliance.qmd + - guide/documentation/collaborate-with-others.qmd + - guide/documentation/submit-documents.qmd + - file: guide/validation/working-with-artifacts.qmd + contents: + - guide/validation/view-filter-artifacts.qmd + - guide/validation/customize-artifact-layouts.qmd + - guide/validation/add-manage-artifacts.qmd + - guide/validation/customize-artifact-overview-page.qmd - text: "---" - section: "Reporting" contents: diff --git a/site/guide/access/accessing-validmind.qmd b/site/guide/access/accessing-validmind.qmd index 777ad4fff4..8aa90d6e49 100644 --- a/site/guide/access/accessing-validmind.qmd +++ b/site/guide/access/accessing-validmind.qmd @@ -20,7 +20,7 @@ aliases: - /guide/configuration/accessing-validmind.html --- -To use {{< var vm.product >}} to track your models and oversee your model management process, you'll need to first sign up and then log in to the {{< var vm.platform >}}. +To use {{< var vm.product >}} to track your records and oversee your risk management processes, you'll need to first sign up and then log in to the {{< var vm.platform >}}. :::{#guides-access} ::: diff --git a/site/guide/access/log-in-to-validmind.qmd b/site/guide/access/log-in-to-validmind.qmd index a413caff09..b31344c055 100644 --- a/site/guide/access/log-in-to-validmind.qmd +++ b/site/guide/access/log-in-to-validmind.qmd @@ -20,7 +20,7 @@ aliases: - /guide/configuration/log-in-to-validmind.html --- -Log in to {{< var validmind.platform >}} to work with your model documentation, prepare validation reports, perform model governance tasks, or to configure {{< var vm.product >}} for your organization. +Log in to {{< var validmind.platform >}} to work with your documentation, prepare validation reports, perform governance tasks, or to configure {{< var vm.product >}} for your organization. {{< var vm.product >}} supports the following methods for logging in: @@ -95,10 +95,10 @@ One of the following two options will apply: ### If user self-onboarding is disabled - You might have only the [{{< fa wrench >}} Basic User]{.bubble} role with very limited access. -- You will see a message prompting you to contact an administrator. +- You will see a message prompting you to contact an administrator. - An administrator must provide you with the necessary access for your role. -Once you have the necessary access, you can work with models and workflows and perform actions such as editing documentation, running tests, or completing validations. +Once you have the necessary access, you can work with records and workflows and perform actions such as editing documentation, running tests, or completing validations. ## {{< var validmind.vpv >}} diff --git a/site/guide/access/register-with-validmind.qmd b/site/guide/access/register-with-validmind.qmd index 9f321920c6..728d7f3e0d 100644 --- a/site/guide/access/register-with-validmind.qmd +++ b/site/guide/access/register-with-validmind.qmd @@ -9,7 +9,7 @@ aliases: - /guide/configuration/register-with-validmind.html --- -Register with our cloud-hosted {{< var validmind.platform >}}, so you can begin working with model documentation or configure {{< var vm.product >}} for your organization. +Register with our cloud-hosted {{< var validmind.platform >}}, so you can begin working with documentation or configure {{< var vm.product >}} for your organization. To access {{< var vm.product >}}, an administrator of your organization must invite you to join. Once you receive an invitation, register using your email address or an existing Google,[^1] GitHub,[^2] or Microsoft[^3] account. @@ -90,7 +90,7 @@ b. `validmind.com` 7. Return to the main {{< var vm.product >}} dashboard[^7] by clicking on **Back to {{< var vm.product >}}**. - Sample models[^8] are populated for you in this new organization to demonstrate the usage of {{< var vm.product >}}. + Sample records[^8] are populated for you in this new organization to demonstrate the usage of {{< var vm.product >}}. :::: {.flex .flex-wrap .justify-around} ::: {.w-40-ns} @@ -98,7 +98,7 @@ b. `validmind.com` ::: ::: {.w-40-ns} -![Sample models populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind" .screenshot group="dashboard"} +![Sample records populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample records populated by ValidMind" .screenshot group="dashboard"} ::: :::: diff --git a/site/guide/attestation/working-with-attestations.qmd b/site/guide/attestation/working-with-attestations.qmd index 783129caa5..b089c5f0e7 100644 --- a/site/guide/attestation/working-with-attestations.qmd +++ b/site/guide/attestation/working-with-attestations.qmd @@ -140,6 +140,6 @@ Work with your model risk management team to create a template that accurately r [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^2]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file diff --git a/site/guide/configuration/_add-roles.qmd b/site/guide/configuration/_add-roles.qmd index 73a824fcfb..b0fefe8934 100644 --- a/site/guide/configuration/_add-roles.qmd +++ b/site/guide/configuration/_add-roles.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 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. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and inventory record stakeholder type names cannot be duplicated to reduce confusion.] 1. Once you click **Add Role**, you can proceed with managing the user permissions and users associated with that role. :::: @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 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. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for the role.^[Role names and inventory record 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. diff --git a/site/guide/configuration/_add-stakeholder-types.qmd b/site/guide/configuration/_add-stakeholder-types.qmd index 839680c200..38eb988b03 100644 --- a/site/guide/configuration/_add-stakeholder-types.qmd +++ b/site/guide/configuration/_add-stakeholder-types.qmd @@ -13,7 +13,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Select the **[inventory record types]{.smallcaps}**^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] this stakeholder type is available on. -1. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + (Optional) Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. 1. Once you click **Add Stakeholder Type**, you can: @@ -33,7 +33,7 @@ a. Enter the unique **[name]{.smallcaps}** and **[description]{.smallcaps}** for a. Select the [**[inventory record types]{.smallcaps}**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this stakeholder type is available on. -a. Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. + (Optional)Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this stakeholder type by default. a. Once you click **Add Stakeholder Type**, you can: diff --git a/site/guide/configuration/_add-use-cases.qmd b/site/guide/configuration/_add-use-cases.qmd index f21bd3117c..f24f9799bd 100644 --- a/site/guide/configuration/_add-use-cases.qmd +++ b/site/guide/configuration/_add-use-cases.qmd @@ -7,14 +7,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. In the left sidebar, click **{{< fa gear >}} Settings**. -1. Under {{< fa cube >}} Inventory, select **Model Inventory Fields**. +1. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. 1. In the Default Fields group, click on the **Use Case** field to add or remove use cases and use case groups: :::: :::: {.content-visible when-format="html" when-meta="includes.quickstart"} -1. Under {{< fa cube >}} Inventory, select **Model Inventory Fields**. +1. Under {{< fa cube >}} Inventory, select **Inventory Record Fields**. 1. In the Default Fields group, click on the **Use Case** field to add use cases and use case groups: diff --git a/site/guide/configuration/_manage-role-permissions.qmd b/site/guide/configuration/_manage-role-permissions.qmd index d55b08b090..7b1a1e2084 100644 --- a/site/guide/configuration/_manage-role-permissions.qmd +++ b/site/guide/configuration/_manage-role-permissions.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Select a permission type to manage: - **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 inventory fields](/guide/inventory/manage-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd)] + - **Field Permissions** — Read and update (write) permissions for record fields^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] and artifact fields.^[[Manage artifact fields](/guide/validation/manage-artifact-fields.qmd)] 1. Select **Edit Permissions** to to add or remove user permissions to or from that role. @@ -22,7 +22,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. Select a permission type to manage: - [**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 [inventory fields](/guide/inventory/manage-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/model-validation/manage-artifact-fields.qmd){target="_blank"}. + - **Field Permissions** — Read and update (write) permissions for [inventory fields](/guide/inventory/manage-inventory-fields.qmd){target="_blank"} and [artifact fields](/guide/validation/manage-artifact-fields.qmd){target="_blank"}. a. Select **Edit Permissions** to to add or remove user permissions to or from that role. diff --git a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd index e7b4acff85..3994091845 100644 --- a/site/guide/configuration/_manage-stakeholder-type-permissions.qmd +++ b/site/guide/configuration/_manage-stakeholder-type-permissions.qmd @@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Select a permission type to manage: - **Records** — Read and update (write) permissions for inventory record fields^[[Manage inventory fields](/guide/inventory/manage-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)] + - **Artifacts** — Read and update (write) permissions for artifact fields,^[[Manage artifact fields](/guide/validation/manage-artifact-fields.qmd)] and add, delete, read, and update (write) permissions for artifact types.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] 1. Select **Edit Permissions** to modify read and update permissions to or from that type. @@ -23,7 +23,7 @@ a. Click on the stakeholder type whose permissions you want to change. a. Select a permission type to manage: - **Records** — Read and update (write) permissions for [inventory fields](/guide/inventory/manage-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"}. + - **Artifacts** — Read and update (write) permissions for [artifact fields](/guide/validation/manage-artifact-fields.qmd){target="_blank"}, and add, delete, read, and update (write) permissions for [artifact types](/guide/validation/manage-artifact-types.qmd){target="_blank"}. a. Select **Edit Permissions** to modify read and update permissions to or from that type. diff --git a/site/guide/configuration/_risk-areas.qmd b/site/guide/configuration/_risk-areas.qmd index 740e24da0d..62ae3cde4b 100644 --- a/site/guide/configuration/_risk-areas.qmd +++ b/site/guide/configuration/_risk-areas.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, model performance, and regulatory compliance are addressed effectively. \ No newline at end of file +A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, performance, and regulatory compliance are addressed effectively. \ No newline at end of file diff --git a/site/guide/configuration/_user-groups.qmd b/site/guide/configuration/_user-groups.qmd index 0bf478eb25..d53b23844d 100644 --- a/site/guide/configuration/_user-groups.qmd +++ b/site/guide/configuration/_user-groups.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Groups are segments of users with the ability to view models associated with that group. Access to granular features in the {{< var validmind.platform >}} within a group's set of models is further defined by roles and permissions. \ No newline at end of file +Groups are segments of users with the ability to view records associated with that group. Access to granular features in the {{< var validmind.platform >}} within a group's set of records is further defined by roles and permissions. \ No newline at end of file diff --git a/site/guide/configuration/configure-aws-privatelink.qmd b/site/guide/configuration/configure-aws-privatelink.qmd index 5b3408b1cf..59f3cd308f 100644 --- a/site/guide/configuration/configure-aws-privatelink.qmd +++ b/site/guide/configuration/configure-aws-privatelink.qmd @@ -14,7 +14,7 @@ To keep your network traffic private and minimize its attack surface, configure AWS PrivateLink is a networking service that allows secure and private communication between Amazon Virtual Private Cloud (VPC) resources and services hosted in other VPCs or in AWS partner services, such as {{< var vm.product >}}. With AWS PrivateLink, you can connect to services over the Amazon network, without needing to expose your network traffic to the public internet. -PrivateLink works by creating a private _VPC endpoint_ for a supported AWS service within your virtual private cloud. This endpoint acts as a proxy between your VPC and {{< var vm.product >}}, allowing traffic to be routed privately over the AWS network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that model developers and validators can connect to in a browser. +PrivateLink works by creating a private _VPC endpoint_ for a supported AWS service within your virtual private cloud. This endpoint acts as a proxy between your VPC and {{< var vm.product >}}, allowing traffic to be routed privately over the AWS network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that developers and validators can connect to in a browser. ::: {.callout-important title="The responsibility of setting up a VPC endpoint for AWS PrivateLink falls to your IT department, such as the cloud engineering, infrastructure, or security teams."}
    diff --git a/site/guide/configuration/configure-azure-private-link.qmd b/site/guide/configuration/configure-azure-private-link.qmd index 9598c82147..dee4e9c03a 100644 --- a/site/guide/configuration/configure-azure-private-link.qmd +++ b/site/guide/configuration/configure-azure-private-link.qmd @@ -14,7 +14,7 @@ To keep your network traffic private and minimize its attack surface, configure Azure Private Link is a networking service that allows secure and private communication between Azure Virtual Network (VNet) resources and services hosted in other VNets or in Azure partner services, such as {{< var vm.product >}}. With Azure Private Link, you can connect to services over the Azure network without exposing your network traffic to the public internet. -Private Link works by creating a _private endpoint_ for a supported Azure service within your virtual private cloud. This endpoint acts as a proxy between your VNet and {{< var vm.product >}}, allowing traffic to be routed privately over the Azure network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that model developers and validators can connect to in a browser. +Private Link works by creating a _private endpoint_ for a supported Azure service within your virtual private cloud. This endpoint acts as a proxy between your VNet and {{< var vm.product >}}, allowing traffic to be routed privately over the Azure network. To make the endpoint easier to use, {{< var vm.product >}} provides a _private DNS name_ that developers and validators can connect to in a browser. ::: {.callout-important title="The responsibility of setting up a private endpoint for Azure Private Link falls to your IT department, such as the cloud engineering, infrastructure, or security teams."}
    diff --git a/site/guide/configuration/customize-your-dashboard.qmd b/site/guide/configuration/customize-your-dashboard.qmd index 913f71c88c..d86acb88af 100644 --- a/site/guide/configuration/customize-your-dashboard.qmd +++ b/site/guide/configuration/customize-your-dashboard.qmd @@ -77,17 +77,17 @@ Widgets display information at a glance on your dashboards.[^1] ::: {.panel-tabset} -##### {{< fa cubes >}} Model Inventory View -Retrieves a saved model inventory view.[^2] +##### {{< fa cubes >}} Inventory Records View +Retrieves a saved inventory record view.[^2] -##### {{< fa border-all >}} Model Artifacts View +##### {{< fa border-all >}} Artifacts View Retrieves a saved artifacts view.[^3] ##### {{< fa square-poll-vertical >}} Visualization Retrieves an analytics visualization.[^4] ##### {{< fa flask >}} Other -Retrieve a list of the latest model artifacts[^5] or recent activity.[^6] +Retrieve a list of the latest artifacts[^5] or recent activity.[^6] ::: @@ -119,17 +119,39 @@ Retrieve a list of the latest model artifacts[^5] or recent activity.[^6] 5. Select the type of widget you'd like to add:[^7] - - **{{< fa cubes >}} Model Inventory View** - - **{{< fa warning >}} Model Artifacts View** + - **{{< fa cubes >}} Inventory Records View** + - **{{< fa warning >}} Artifacts View** - **{{< fa square-poll-vertical >}} Visualization** - - **{{< fa table-cells-large >}} Other** + - **{{< fa flask >}} Other** -6. On the modal that appears, configure the information retrieved by the widget: +6. On the modal that appears, configure the information retrieved by the widget: - - **Model Inventory View** — Select a **[view name]{.smallcaps}** then cick **Add Model Inventory View**. - - **Model Artifacts View** — Select a **[view name]{.smallcaps}** then cick **Add Model Artifacts View**. - - **Analytics Visualization** — Select an **[analytics page]{.smallcaps}** and a **[visualization]{.smallcaps}** then click **Add Visualization**. - - **Other** — Select one of the **[widgets]{.smallcaps}** then click **Add Widget**. +::: {.panel-tabset} + +#### {{< fa cubes >}} Inventory Records View + +a. Select a **[record type]{.smallcaps}**. +b. Select a **[view name]{.smallcaps}**. +c. Click **Add Inventory Records View** to insert the view as a widget onto your dashboard. + +#### {{< fa warning >}} Artifacts View + +a. Select an **[artifact type]{.smallcaps}**. +b. Select a **[view name]{.smallcaps}**. +c. Click **Add Artifacts View** to insert the view as a widget onto your dashboard. + +#### {{< fa square-poll-vertical >}} Analytics Visualization + +a. Select an **[analytics page]{.smallcaps}** +b. Select a **[visualization]{.smallcaps}**. +c. Click **Add Visualization** to insert the visualization as a widget onto your dashboard. + +#### {{< fa flask >}} Other + +a. Select one of the **[widgets]{.smallcaps}**. +b. Click **Add Widget** to insert the widget onto your dashboard. + +::: 7. Confirm that your widget appears as expected. @@ -165,11 +187,11 @@ Removing a widget from a dashboard will not delete the linked view or analytics [^2]: [Manage custom inventory views](/guide/inventory/customize-inventory-layout.qmd#manage-custom-inventory-views) -[^3]: [Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd) +[^3]: [Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd) [^4]: [Working with analytics](/guide/reporting/working-with-analytics.qmd) -[^5]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^5]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^6]: [View record activity](/guide/inventory/view-record-activity.qmd) diff --git a/site/guide/configuration/manage-groups.qmd b/site/guide/configuration/manage-groups.qmd index 677e0ecacd..b639983138 100644 --- a/site/guide/configuration/manage-groups.qmd +++ b/site/guide/configuration/manage-groups.qmd @@ -34,7 +34,7 @@ Users must belong to a default group of `All`, and can belong to mulitple groups Click on a group to: - View the complete list of members in that group. - Add or remove members from that group.[^2] - - View models visible to that group. + - View records visible to that group. ## Add new groups diff --git a/site/guide/configuration/manage-platform-notifications.qmd b/site/guide/configuration/manage-platform-notifications.qmd index b8cedcc1bf..d4c0bc62d9 100644 --- a/site/guide/configuration/manage-platform-notifications.qmd +++ b/site/guide/configuration/manage-platform-notifications.qmd @@ -96,11 +96,11 @@ c. Confirm the number of updates you've flagged to be dismissed, then select **{ Mentions : Comments you're mentioned in.[^2] -Model Invites -: Stakeholders added to your models.[^3] +Record Invites +: Stakeholders added to your records.[^3] -Model Stage Updates -: Model stage transitions on your models.[^4] +Record Stage Updates +: Record stage transitions on your records.[^4] ## Customize email notifications @@ -123,7 +123,7 @@ Enable or disable email notifications for specific events across your organizati [^1]: [Available update filters](#available-update-filters) -[^2]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting) +[^2]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#commenting) [^3]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records) diff --git a/site/guide/configuration/manage-users.qmd b/site/guide/configuration/manage-users.qmd index 738730076d..c8418cc7e8 100644 --- a/site/guide/configuration/manage-users.qmd +++ b/site/guide/configuration/manage-users.qmd @@ -8,7 +8,7 @@ aliases: - /guide/manage-users.html --- -Invite new users and review your current users from within the user directory. Users belong to groups which determine which models they can see, and have roles with attached permissions which define the level of access they have to features. +Invite new users and review your current users from within the user directory. Users belong to groups which determine which records they can see, and have roles with attached permissions which define the level of access they have to features. ::: {.attn} diff --git a/site/guide/configuration/managing-users.qmd b/site/guide/configuration/managing-users.qmd index 6418ae9bca..52bed3a7f8 100644 --- a/site/guide/configuration/managing-users.qmd +++ b/site/guide/configuration/managing-users.qmd @@ -44,7 +44,7 @@ roles : Sets of permissions defining which actions different sets of users can perform on the {{< var vm.platform >}}. groups -: Collections of users managed at the organization or team level with similar roles or permissions, such as a specific model validation team or model developers in a specific business unit. +: Collections of users managed at the organization or team level with similar roles or permissions, such as developers or validation teams in a specific business unit. permissions : Specific actions or operations on resources allowed or denied to roles. @@ -57,12 +57,12 @@ resource actions User management utilizes role-based access control (RBAC), where roles determine permissions. {{< var vm.product >}} provides the following default roles with stock permissions: developer -: Model developers are responsible for documenting and testing models. They may have access to development tools and resources that interact with the {{< var vm.platform >}} and they can upload model documentation and test results through the {{< var vm.developer >}}. +: Developers are responsible for documenting and testing records. They may have access to development tools and resources that interact with the {{< var vm.platform >}} and they can upload documentation and test results through the {{< var vm.developer >}}. validator -: Model validators review, test and validate models and model documentation. They may have limited access to modify content or configurations. +: Validators review, test and validate records and documentation. They may have limited access to modify content or configurations. -customer admin +customer admin : The Customer Admin role has extensive control over the entire {{< var vm.platform >}}. This role can manage users, groups, and permissions at a broader level. ## User management diff --git a/site/guide/configuration/managing-your-organization.qmd b/site/guide/configuration/managing-your-organization.qmd index a89d6ceaa4..32813a5e18 100644 --- a/site/guide/configuration/managing-your-organization.qmd +++ b/site/guide/configuration/managing-your-organization.qmd @@ -114,8 +114,8 @@ Enabling tracked changes by default for your organization will disable the follo [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#add-content-blocks) +[^5]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#add-content-blocks) -[^6]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#tracking-changes) +[^6]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#tracking-changes) -[^7]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd) +[^7]: [Work with test results](/guide/documentation/work-with-test-results.qmd) diff --git a/site/guide/configuration/set-up-your-organization.qmd b/site/guide/configuration/set-up-your-organization.qmd index 706b114782..d69ae6b862 100644 --- a/site/guide/configuration/set-up-your-organization.qmd +++ b/site/guide/configuration/set-up-your-organization.qmd @@ -44,7 +44,7 @@ b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **{ c. Click **Save** to apply your changes. ::: {.callout-important} -In order to delete a business unit, there must be no models attached to that unit. +In order to delete a business unit, there must be no records attached to that unit. ::: #### Delete business units @@ -54,7 +54,7 @@ a. Hover over the business unit you want to delete. b. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete Business Unit**]{.red} to remove the business unit. ::: {.callout-important} -In order to delete a business unit, there must be no models attached to that unit. +In order to delete a business unit, there must be no records attached to that unit. ::: ::: @@ -65,7 +65,7 @@ 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 {{< fa cube >}} Inventory, select **Model Inventory Fields**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record 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] @@ -78,7 +78,7 @@ In order to delete a business unit, there must be no models attached to that uni ### Remove use cases and use case groups ::: {.callout-important title="Use case and use case group deletion is permanent and cannot be undone."} -- In order to delete a use case, there must be no models associated with it. +- In order to delete a use case, there must be no records associated with it. - Deleting a use case group will not delete use cases under that group — use cases will be categorized as ungrouped. ::: @@ -90,23 +90,23 @@ b. If you are sure you want to remove the use case, click **{{< fa trash-can >}} ## Manage risk areas -{{< include /guide/model-validation/_risk-areas.qmd >}} +{{< include /guide/validation/_risk-areas.qmd >}} ::: {.callout title="Risk areas are set up together with your validation guidelines attached to validation reports."} -{{< include /guide/model-validation/_validation-guidelines.qmd >}} +{{< include /guide/validation/_validation-guidelines.qmd >}} -[Set up validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd#set-up-validation-guidelines){.button} +[Set up validation guidelines](/guide/validation/manage-validation-guidelines.qmd#set-up-validation-guidelines){.button} ::: ## What's next - [Managing users](managing-users.qmd) - [Personalizing {{< var vm.product >}}](personalizing-validmind.qmd) -- [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) +- [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: To edit the display behavior of this field on models and model registration, refer to: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#add-or-edit-inventory-fields) +[^2]: To edit the display behavior of this field on records and record registration, refer to: [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#add-or-edit-inventory-fields) diff --git a/site/guide/documentation/_add-content-blocks.qmd b/site/guide/documentation/_add-content-blocks.qmd new file mode 100644 index 0000000000..6a694403e6 --- /dev/null +++ b/site/guide/documentation/_add-content-blocks.qmd @@ -0,0 +1,32 @@ + + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] + +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] + +1. Click on the document file you want to add a content block to.^[[Working with documents](/guide/templates/working-with-documents.qmd)] + +1. Click on a section header to expand that section and add content. + +1. Hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: + + ![Adding a content block in the {{< var validmind.platform >}}](/guide/documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the ValidMind Platform" .screenshot} + +:::: + + + + +:::: {.content-hidden unless-format="revealjs"} +In any section of your documentation, hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: + + ![Adding a content block in the UI](/guide/documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} + +After adding the block to your documentation, generate a content draft with AI using the [content editing toolbar](/guide/documentation/work-with-content-blocks.qmd#content-editing-toolbar){target="_blank"}: + +:::: \ No newline at end of file diff --git a/site/guide/model-documentation/_add-test-results.qmd b/site/guide/documentation/_add-test-results.qmd similarity index 66% rename from site/guide/model-documentation/_add-test-results.qmd rename to site/guide/documentation/_add-test-results.qmd index b039603c16..c5d512bd15 100644 --- a/site/guide/model-documentation/_add-test-results.qmd +++ b/site/guide/documentation/_add-test-results.qmd @@ -5,11 +5,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document file you want to add test results to.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] +1. Click on the document file you want to add test results to.^[[Working with documents](/guide/templates/working-with-documents.qmd)] 1. Click on a section header to expand that section and add content. @@ -17,30 +17,30 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ![Adding a content block in the {{< var validmind.platform >}}](add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the ValidMind Platform" .screenshot} -1. Click {{< fa square-plus >}} and then select **Test-Driven**^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)] under [from library]{.smallcaps}. +1. Click {{< fa square-plus >}} and then select **Test-Driven**^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)] under [from library]{.smallcaps}. 1. Select test results: - Choose from available **VM Library** (out-of-the-box) or **Custom** tests under [test-driven]{.smallcaps} in the left sidebar of the test selection modal. - Use **{{}} Search by name** on the top-left to locate specific test results. - ![Test-driven blocks that have been selected for insertion](/guide/model-documentation/test-driven-block-menu.png){fig-alt="A screenshot showing several test-driven blocks that have been selected for insertion" .screenshot} + ![Test-driven blocks that have been selected for insertion](/guide/documentation/test-driven-block-menu.png){fig-alt="A screenshot showing several test-driven blocks that have been selected for insertion" .screenshot} To preview what is included in a test, click on it. By default, the actively selected test is reviewed. 1. Click **Insert # Test Results to Document** when you are ready. -1. After inserting the results into your document, click on the text to make changes or add comments,^[[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)] or configure what is displayed on the test result.^[[Configure test result displays](/guide/model-documentation/#configure-test-result-displays)] +1. After inserting the results into your document, click on the text to make changes or add comments,^[[Collaborate with others](/guide/documentation/collaborate-with-others.qmd)] or configure what is displayed on the test result.^[[Configure test result displays](/guide/documentation/work-with-test-results.qmd#configure-test-result-displays)] :::: :::: {.content-hidden unless-format="revealjs"} -With the test results logged, let's head to the model we connected to at the beginning of this notebook and insert our test results into the documentation: +With the test results logged, let's head to the record we connected to at the beginning of this notebook and insert our test results into the documentation: -1. From the **{{< fa cubes >}} Inventory** in the {{< var validmind.platform >}}, go to the model you connected to earlier. +1. From the **{{< fa cubes >}} Inventory** in the {{< var validmind.platform >}}, go to the record you connected to earlier. -1. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 1. Locate the Data Preparation section and click on **2.3 Correlations and Interactions** to expand that section. diff --git a/site/guide/model-documentation/_check-model-documents.qmd b/site/guide/documentation/_check-documents.qmd similarity index 76% rename from site/guide/model-documentation/_check-model-documents.qmd rename to site/guide/documentation/_check-documents.qmd index 098dd66d20..7594bd37bf 100644 --- a/site/guide/model-documentation/_check-model-documents.qmd +++ b/site/guide/documentation/_check-documents.qmd @@ -7,11 +7,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> a. In the left sidebar, click **{{< fa cubes >}} Inventory**. -a. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +a. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -a. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +a. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -a. Click on the file you want to check:^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] +a. Click on the file you want to check:^[[Working with documents](/guide/templates/working-with-documents.qmd)] ::: {.panel-tabset} @@ -33,7 +33,7 @@ a. Proceed with selecting a regulation to check your document against. a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/model-documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. @@ -62,11 +62,11 @@ a. Review questions that require attention. Each question includes a(n): ::: {.callout collapse="true" appearance="minimal"} ### Examples — Observations & recommendations - ![Sample question that is not addressed](/guide/model-documentation/checker-gap-identified.png){fig-alt="A screenshot showing a question and the observation 'GAP IDENTIFIED' with a recommendation" .screenshot} + ![Sample question that is not addressed](/guide/documentation/checker-gap-identified.png){fig-alt="A screenshot showing a question and the observation 'GAP IDENTIFIED' with a recommendation" .screenshot} - ![Sample question that is partially addressed](/guide/model-documentation/checker-partial-gap.png){fig-alt="A screenshot showing a question and the observation 'PARTIAL GAP' with a recommendation" .screenshot} + ![Sample question that is partially addressed](/guide/documentation/checker-partial-gap.png){fig-alt="A screenshot showing a question and the observation 'PARTIAL GAP' with a recommendation" .screenshot} - ![Sample question that is fully addressed](/guide/model-documentation/checker-no-significant-gaps.png){fig-alt="A screenshot showing a question and the observation 'NO SIGNIFICANT GAPS' with a recommendation" .screenshot} + ![Sample question that is fully addressed](/guide/documentation/checker-no-significant-gaps.png){fig-alt="A screenshot showing a question and the observation 'NO SIGNIFICANT GAPS' with a recommendation" .screenshot} ::: ::: @@ -89,9 +89,9 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select **Development**. 1. Locate the {{< var vm.checker >}} box on the right and click **{{< fa check >}} Check Document**. @@ -101,7 +101,7 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/model-documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. @@ -124,7 +124,7 @@ b. Review questions that require attention. Each question includes: - **Observation** — An analysis of how the documentation currently addresses the question - **Recommendation** — If suggested, guidance on how to revise the documentation to better address the question -Use the feedback provided by the {{< var validmind.checker >}} to review the appropriate sections of your documentation and decide what revisions should be made. Or, if you have run the {{< var vm.checker >}} before and were just checking that all documentation issues have been addressed, submit your model for validation. +Use the feedback provided by the {{< var validmind.checker >}} to review the appropriate sections of your documentation and decide what revisions should be made. Or, if you have run the {{< var vm.checker >}} before and were just checking that all documentation issues have been addressed, submit your record for validation. #### 3. (Optional) Export results @@ -143,9 +143,9 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Validation**. +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select **Validation**. 1. Locate {{< fa file-circle-check >}} Check Document on the right and click to expand the menu, then click **{{< fa check >}} Check Document**. @@ -155,7 +155,7 @@ To export the results of the {{< var vm.checker >}} to a `.pdf` (Portable Docume a. In the {{< var vm.checker >}} modal, select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to check your document against: - ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/model-documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} + ![Example **[regulation or policy]{.smallcaps}** and **[assessment]{.smallcaps}** selected to check a document against](/guide/documentation/checker-selection.png){fig-alt="A screenshot showing the REGULATION OR POLICY and ASSESSMENT dropdowns in the Document Checker" .screenshot} A list of regulation-based questions appears for your review. diff --git a/site/guide/documentation/_comment-activity.qmd b/site/guide/documentation/_comment-activity.qmd new file mode 100644 index 0000000000..14997aaf28 --- /dev/null +++ b/site/guide/documentation/_comment-activity.qmd @@ -0,0 +1,17 @@ + + +:::: {.content-visible unless-format="revealjs"} +While working with content blocks,^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd)] you can comment directly on specific portions of the text. + +All users associated with a record, such as developers and validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the **{{< fa home >}} Dashboard**.^[[Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +While working with content blocks, you can comment directly on specific portions of the text. + +All users associated with a record, such as developers and validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the [**{{< fa home >}} Dashboard**](/guide/configuration/customize-your-dashboard.qmd){target="_blank"}. + +:::: \ No newline at end of file diff --git a/site/guide/model-documentation/_commenting.qmd b/site/guide/documentation/_commenting.qmd similarity index 100% rename from site/guide/model-documentation/_commenting.qmd rename to site/guide/documentation/_commenting.qmd diff --git a/site/guide/model-documentation/_document-checker.qmd b/site/guide/documentation/_document-checker.qmd similarity index 100% rename from site/guide/model-documentation/_document-checker.qmd rename to site/guide/documentation/_document-checker.qmd diff --git a/site/guide/documentation/_document-overview.qmd b/site/guide/documentation/_document-overview.qmd new file mode 100644 index 0000000000..2a62793a50 --- /dev/null +++ b/site/guide/documentation/_document-overview.qmd @@ -0,0 +1,34 @@ + + +:::: {.content-visible unless-format="revealjs"} +::: {.callout title="Static PDF uploads do not include a Document Overview."} +Only PDFs converted to editable documents,^[[Manage documents](/guide/templates/manage-documents.qmd#add-record-documents)] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} include a Document Overview. +::: + +The **Document Overview** shows a section-by-section outline of your record's documentation, as well as summaries of: + +- Any unresolved conversations^[[Collaborate with others](/guide/documentation/collaborate-with-others.qmd)] +- The number of associated artifacts^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] +- The completion status for your documentation^[[Assign section statuses](/guide/documentation/assign-development-section-statuses.qmd)] +- Recent activity on your record^[[View record activity](/guide/inventory/view-record-activity.qmd)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +The **Document Overview** shows a section-by-section outline of your record's documentation, as well as summaries of: + +- Any unresolved conversations +- The number of associated artifacts +- The completion status for your documentation +- Recent activity on your record + +::: {.embed .pr3 .pl3 .f5} +**Static PDF uploads do not include a Document Overview.** + +Only PDFs converted to editable documents, documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} include a Document Overview. +::: + +:::: + diff --git a/site/guide/documentation/_locate-document-overview.qmd b/site/guide/documentation/_locate-document-overview.qmd new file mode 100644 index 0000000000..59a5a4513d --- /dev/null +++ b/site/guide/documentation/_locate-document-overview.qmd @@ -0,0 +1,26 @@ + + +To locate your document overview for a record: + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] + +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] + +1. Click on a Development type file.^[[Working with documents](/guide/templates/working-with-documents.qmd)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Select a record or [find your record by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="blank"}. + +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select **Development**. + +:::: + diff --git a/site/guide/model-documentation/_submit-for-approval.qmd b/site/guide/documentation/_submit-for-approval.qmd similarity index 81% rename from site/guide/model-documentation/_submit-for-approval.qmd rename to site/guide/documentation/_submit-for-approval.qmd index a5d0388d47..df5d437772 100644 --- a/site/guide/model-documentation/_submit-for-approval.qmd +++ b/site/guide/documentation/_submit-for-approval.qmd @@ -3,18 +3,18 @@ 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"} -When you're ready, verify your workflow's status, and then submit your model documentation or validation report for approval. +When you're ready, verify your workflow's status, and then submit your documents for review or approval. :::: :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} -When you're ready, verify your workflow's status, and then submit your model documentation for approval. +When you're ready, verify your workflow's status, and then submit your documents for review or approval. :::: :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} -When you're ready, verify your workflow's status, and then submit your validation report for approval. +When you're ready, verify your workflow's status, and then submit your documents for review or approval. :::: \ No newline at end of file diff --git a/site/guide/model-documentation/_test-result-metadata.qmd b/site/guide/documentation/_test-result-metadata.qmd similarity index 100% rename from site/guide/model-documentation/_test-result-metadata.qmd rename to site/guide/documentation/_test-result-metadata.qmd diff --git a/site/guide/model-documentation/_view-test-result-metadata.qmd b/site/guide/documentation/_view-test-result-metadata.qmd similarity index 92% rename from site/guide/model-documentation/_view-test-result-metadata.qmd rename to site/guide/documentation/_view-test-result-metadata.qmd index eac461556b..f54c744e7b 100644 --- a/site/guide/model-documentation/_view-test-result-metadata.qmd +++ b/site/guide/documentation/_view-test-result-metadata.qmd @@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 6. Hover over the test result until the top-right hand corner menu appears and select **{{< fa clock >}} See Timeline**: - The [Active]{.green-bg} (most recent) test result is highlighted. - - On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details, such as **Model Information** or **Dataset Information**. + - On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details, such as **Record Information** or **Dataset Information**. When you are done, you can either click **Cancel** or **{{< fa x >}}** to close the metadata menu.. @@ -23,7 +23,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 5. Hover over the test result until the top-right hand corner menu appears and select **{{< fa clock >}} See Timeline**: - The [Active]{.green-bg} (most recent) test result is highlighted. - - On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details, such as **Model Information** or **Dataset Information**. + - On the test result timeline, click on the **{{< fa chevron-down >}}** associated with a test run to expand for details, such as **Record Information** or **Dataset Information**. When you are done, you can either click **Cancel** or **{{< fa x >}}** to close the metadata menu. diff --git a/site/guide/model-documentation/add-content-block.gif b/site/guide/documentation/add-content-block.gif similarity index 100% rename from site/guide/model-documentation/add-content-block.gif rename to site/guide/documentation/add-content-block.gif diff --git a/site/guide/model-documentation/assign-documentation-section-statuses.qmd b/site/guide/documentation/assign-development-section-statuses.qmd similarity index 61% rename from site/guide/model-documentation/assign-documentation-section-statuses.qmd rename to site/guide/documentation/assign-development-section-statuses.qmd index 685d36f4f1..c97784d3cc 100644 --- a/site/guide/model-documentation/assign-documentation-section-statuses.qmd +++ b/site/guide/documentation/assign-development-section-statuses.qmd @@ -2,13 +2,14 @@ # 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: "Assign documentation section statuses" +title: "Assign development section statuses" date: last-modified aliases: - /guide/assign-documentation-section-statuses.html + - /guide/model-documentation/assign-documentation-section-statuses.html --- -Assign a completion status to individual sections of your model documentation that will be reflected in your Document Overview. +Assign a completion status to individual sections of your Development type documents that will be reflected in your Document Overview. ::: {.callout title="Section statuses cannot be assigned on static PDF documents."} You can only assign section statuses for PDFs converted to editable documents,[^1] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}}. @@ -19,7 +20,7 @@ You can only assign section statuses for PDFs converted to editable documents,[^ ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are documenting is registered in the model inventory.[^2] +- [x] The record you are documenting is registered in the inventory.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] ::: @@ -28,13 +29,13 @@ You can only assign section statuses for PDFs converted to editable documents,[^ 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.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] 4. Click on a Development type file.[^6] - Jump to any section of the model documentation by selecting the relevant section you would like to view. + Jump to any section of the documentation by selecting the relevant section you would like to view. 4. Next to the heading of each section, you can assign a status from the drop-down: - [**In Progress**]{.bubble} @@ -45,7 +46,7 @@ The documentation completion status summary will then be updated on your Documen -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) @@ -53,6 +54,6 @@ The documentation completion status summary will then be updated on your Documen [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^6]: [Working with model documentation](working-with-model-documentation.qmd#document-overview) +[^6]: [Working with documentation](working-with-documentation.qmd#document-overview) diff --git a/site/guide/model-documentation/check-documents-for-compliance.qmd b/site/guide/documentation/check-documents-for-compliance.qmd similarity index 79% rename from site/guide/model-documentation/check-documents-for-compliance.qmd rename to site/guide/documentation/check-documents-for-compliance.qmd index a75e7feaed..47c51499e2 100644 --- a/site/guide/model-documentation/check-documents-for-compliance.qmd +++ b/site/guide/documentation/check-documents-for-compliance.qmd @@ -15,7 +15,8 @@ listing: - ../../templates/customize-document-checker.qmd - ../../about/overview-llm-features.qmd aliases: - - /guide/model-documentation/check-documentation-for-compliance.html + - /guide/documentation/check-documentation-for-compliance.html + - /guide/model-documentation/check-documents-for-compliance.html --- Use the {{< var validmind.checker >}} to analyze your completed documents by comparing them against regulatory standards. @@ -27,8 +28,8 @@ Use the {{< var validmind.checker >}} to analyze your completed documents by com ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are documenting is registered in the model inventory.[^1] -- [x] The model must have sufficiently complete documents that can be checked against a regulatory standard. +- [x] The record you are documenting is registered in the inventory.[^1] +- [x] The record must have sufficiently complete documents that can be checked against a regulatory standard. - [x] Regulations or policies and associated assessments have been configured for the document types you are checking.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] @@ -36,7 +37,7 @@ Use the {{< var validmind.checker >}} to analyze your completed documents by com ## Check documents -{{< include /guide/model-documentation/_check-model-documents.qmd >}} +{{< include /guide/documentation/_check-documents.qmd >}} ## Learn more diff --git a/site/guide/model-documentation/checker-gap-identified.png b/site/guide/documentation/checker-gap-identified.png similarity index 100% rename from site/guide/model-documentation/checker-gap-identified.png rename to site/guide/documentation/checker-gap-identified.png diff --git a/site/guide/model-documentation/checker-no-significant-gaps.png b/site/guide/documentation/checker-no-significant-gaps.png similarity index 100% rename from site/guide/model-documentation/checker-no-significant-gaps.png rename to site/guide/documentation/checker-no-significant-gaps.png diff --git a/site/guide/model-documentation/checker-partial-gap.png b/site/guide/documentation/checker-partial-gap.png similarity index 100% rename from site/guide/model-documentation/checker-partial-gap.png rename to site/guide/documentation/checker-partial-gap.png diff --git a/site/guide/model-documentation/checker-selection.png b/site/guide/documentation/checker-selection.png similarity index 100% rename from site/guide/model-documentation/checker-selection.png rename to site/guide/documentation/checker-selection.png diff --git a/site/guide/model-documentation/collaborate-with-others.qmd b/site/guide/documentation/collaborate-with-others.qmd similarity index 81% rename from site/guide/model-documentation/collaborate-with-others.qmd rename to site/guide/documentation/collaborate-with-others.qmd index dd15b0972e..a8f9bf43a3 100644 --- a/site/guide/model-documentation/collaborate-with-others.qmd +++ b/site/guide/documentation/collaborate-with-others.qmd @@ -7,31 +7,24 @@ date: last-modified aliases: - /guide/collaborate-on-documentation-projects.html - /guide/collaborate-with-others.html + - /guide/model-documentation/collaborate-with-others.html --- -Use the real-time collaboration features to track changes, add comments, and access the revision history for model documents. +Use the {{< var validmind.platform >}}'s real-time collaboration features to simultaneously edit documents alongside other contributors, hold comment discussions right within documents, and retain saved versions of edits with revision history. ::: {.callout title="You cannot interact within static PDF documents."} You can only track changes, review revision history, and comment in PDFs converted to editable documents,[^1] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}}. ::: -## Feature highlights - -- **Real-time collaboration** — Simultaneously edit model documents, leave and respond to comments and suggestions, and access revision history. Changes to model documents are also automatically added to {{< var vm.product >}}'s activity feed. - -- **Spell and grammar checker** — Have your content checked automatically by the built-in spell and grammar checker. - -- **Math formulas** — Add math formulas to documents by clicking the **MathType** button and using the toolbar, or switch to handwriting. - ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^2] -- [x] Documents exist and are completed or are in progress for your model.[^3] -- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] +- [x] There are records registered in the inventory.[^2] +- [x] Documents exist and are completed or are in progress for your record.[^3] +- [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] ::: @@ -43,7 +36,7 @@ While working with content blocks in documents,[^5] you can suggest changes inst 1. Click the **{{< fa file-pen >}} Track changes** button in the toolbar to turn on suggestion mode. -2. Make your changes to the model document. +2. Make your changes to the document. When changes tracking is enabled, other contributors can accept or decline the suggested changes. @@ -51,7 +44,7 @@ While working with content blocks in documents,[^5] you can suggest changes inst 1. Suggested changes appear in [green]{.green} or [~~red~~]{.red} highlighted text, depending on if the change is adding or removing content respectively. - - To accept or decline a change, click the highlighted text, then click [{{< fa check >}}]{.green} or [{{< fa xmark >}}]{.red}. + - To accept or decline a change, click the highlighted text, then click [{{< fa check >}}]{.green} or [{{< fa xmark >}}]{.red}. - You can also reply to a suggested change. 2. To mass accept or decline suggestions, click the dropdown arrow next to the **{{< fa file-pen >}} Track changes** button and select one of the options: @@ -70,7 +63,7 @@ If you have write permissions for the document you're editing, you can choose to ## Revision history -While working with content blocks in documents,[^7] you can save named versions of your edits to retain specific revisions you'd like to keep. +While working with content blocks in documents,[^7] you can save named versions of your edits to retain specific revisions you'd like to keep. 1. Click the **{{< fa clock-rotate-left >}} Revision history** button in the toolbar. @@ -88,14 +81,14 @@ While working with content blocks in documents,[^7] you can save named versions a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history** to view a history of all saved versions as well as your current version. -b. To see the the change made with each version, select the version in the right sidebar. +b. To see the the change made with each version, select the version in the right sidebar. - - Changes made in that version are highlighted. + - Changes made in that version are highlighted. - Hover over the highlighted content to see who made the change. ### Compare versions -a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. +a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. b. Click on the version you would like to compare another version to. @@ -105,13 +98,13 @@ d. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select **C ### Rename a version -a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. +a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. b. Click on the title of the version you want to rename to change it. ### Restore a version -a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. +a. Click **{{< fa clock-rotate-left >}} Revision history** and select **Open revision history**. b. Click on the desired version and select **Restore this version**. @@ -119,7 +112,7 @@ c. The restored version will now appear under revision history with the name: `R ::: -## Commenting +## Commenting {{< include _comment-activity.qmd >}} @@ -149,11 +142,11 @@ To delete a comment in a resolved thread, follow the same steps but click the ** -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^3]: [Working with documents](/guide/templates/working-with-documents.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) diff --git a/site/guide/model-documentation/content-editing-toolbar.png b/site/guide/documentation/content-editing-toolbar.png similarity index 100% rename from site/guide/model-documentation/content-editing-toolbar.png rename to site/guide/documentation/content-editing-toolbar.png diff --git a/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd b/site/guide/documentation/content_blocks/_generate-with-ai.qmd similarity index 89% rename from site/guide/model-documentation/content_blocks/_generate-with-ai.qmd rename to site/guide/documentation/content_blocks/_generate-with-ai.qmd index 85423462ed..8df9c71777 100644 --- a/site/guide/model-documentation/content_blocks/_generate-with-ai.qmd +++ b/site/guide/documentation/content_blocks/_generate-with-ai.qmd @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible when-format="html" when-meta="includes.pdf-context"} - You can also include model attachments in `.pdf` format^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd#manage-attachments)] as context documents: + You can also include record attachments in `.pdf` format^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd#manage-attachments)] as context documents: a. Click **{{< fa square-plus >}}** and select **{{< fa file-circle-plus >}} Add Document to Context**. a. Check off the attachment files you would like to include as extra context. @@ -36,7 +36,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> 1. Enter in a custom prompt and click **Send**, or click **Generate Content** to compose a draft for review. :::: {.content-visible when-format="revealjs" when-meta="includes.pdf-context"} - You can also include [model attachments in `.pdf` format](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} as context documents: + You can also include [record attachments in `.pdf` format](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} as context documents: a. Click **{{< fa square-plus >}}** and select **{{< fa file-circle-plus >}} Add Document to Context**. a. Check off the attachment files you would like to include as extra context. diff --git a/site/guide/model-documentation/content_blocks/_insert-mathematical-formulas.qmd b/site/guide/documentation/content_blocks/_insert-mathematical-formulas.qmd similarity index 72% rename from site/guide/model-documentation/content_blocks/_insert-mathematical-formulas.qmd rename to site/guide/documentation/content_blocks/_insert-mathematical-formulas.qmd index ef0401768d..71037b822a 100644 --- a/site/guide/model-documentation/content_blocks/_insert-mathematical-formulas.qmd +++ b/site/guide/documentation/content_blocks/_insert-mathematical-formulas.qmd @@ -16,7 +16,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> - To insert the equation inline, leave **Display mode** untoggled. - To insert the equation on its own line, toggle **Display mode** on. - ![The two formula display modes](/guide/model-documentation/content_blocks/formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"} + ![The two formula display modes](/guide/documentation/content_blocks/formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"} 1. Click **[{{< fa check >}}]{.green}** to add the equation to your content block. @@ -36,10 +36,10 @@ b. Enter your LaTeX formula in the text box and confirm that the Equation previe - To insert the equation inline, leave **Display mode** untoggled. - To insert the equation on its own line, toggle **Display mode** on. - ![The two formula display modes](/guide/model-documentation/content_blocks/formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"} + ![The two formula display modes](/guide/documentation/content_blocks/formula-display-modes.png){fig-alt="A screenshot showing the two formula display modes" .screenshot group="latex"} c. Click **[{{< fa check >}}]{.green}** to add the equation to your content block. :::: -[^equation-preview]: ![Equation preview in the formula editor](/guide/model-documentation/content_blocks/equation-preview.png){fig-alt="A screenshot showing the equation preview in the formula editor" .screenshot group="latex"} +[^equation-preview]: ![Equation preview in the formula editor](/guide/documentation/content_blocks/equation-preview.png){fig-alt="A screenshot showing the equation preview in the formula editor" .screenshot group="latex"} diff --git a/site/guide/model-documentation/content_blocks/_metric-over-time-block.qmd b/site/guide/documentation/content_blocks/_metric-over-time-block.qmd similarity index 100% rename from site/guide/model-documentation/content_blocks/_metric-over-time-block.qmd rename to site/guide/documentation/content_blocks/_metric-over-time-block.qmd diff --git a/site/guide/model-documentation/content_blocks/_reference-field-values.qmd b/site/guide/documentation/content_blocks/_reference-field-values.qmd similarity index 69% rename from site/guide/model-documentation/content_blocks/_reference-field-values.qmd rename to site/guide/documentation/content_blocks/_reference-field-values.qmd index 34a0ab0bd0..0fd536c6c1 100644 --- a/site/guide/model-documentation/content_blocks/_reference-field-values.qmd +++ b/site/guide/documentation/content_blocks/_reference-field-values.qmd @@ -9,15 +9,15 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ``` --> :::: {.content-visible unless-format="revealjs" when-meta="includes.blocks"} -- The associated model's inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] -- Fields from artifacts logged on the associated model^[[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd)] +- The associated record's inventory fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] +- Fields from artifacts logged on the associated record^[[Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd)] 1. Click **{ } Insert Variable {{< fa angle-down >}}** in the toolbar while editing a content block. 1. Select the variable you want to reference from the drop-down menus: - - **[model]{.smallcaps}** — Model inventory field values by field group. - - **[{artifact type}]{.smallcaps}** — Artifact field values grouped by artifact type, where `{artifact type}` represents the name of your artifact type. Only types of artifacts already logged on the associated model will appear in this selection. + - **[record]{.smallcaps}** — Record field values by field group. + - **[{artifact type}]{.smallcaps}** — Artifact field values grouped by artifact type, where `{artifact type}` represents the name of your artifact type. Only types of artifacts already logged on the associated record will appear in this selection. 1. Click away from the content block to apply your changes, and confirm that the correct variable value is displayed in the content block as expected. @@ -32,7 +32,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs" unless-meta="includes.blocks"} a. Click **{ } Insert Variable {{< fa angle-down >}}** in the toolbar while editing a content block. -b. Select the **Model {{< fa arrow-right >}}** variable you want to reference from the drop-down menu.^[Model inventory field values: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] +b. Select the **Record {{< fa arrow-right >}}** variable you want to reference from the drop-down menu.^[Record field values: [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] c. Click away from the content block to apply your changes, and confirm that the correct variable value is displayed in the content block as expected. diff --git a/site/guide/model-documentation/content_blocks/_simple-text-block.qmd b/site/guide/documentation/content_blocks/_simple-text-block.qmd similarity index 70% rename from site/guide/model-documentation/content_blocks/_simple-text-block.qmd rename to site/guide/documentation/content_blocks/_simple-text-block.qmd index 9e2c6aeaa5..b461efd7af 100644 --- a/site/guide/model-documentation/content_blocks/_simple-text-block.qmd +++ b/site/guide/documentation/content_blocks/_simple-text-block.qmd @@ -3,4 +3,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> simple text block [new, from library]{.smallercaps .pink} -: Can be added anywhere on model documents and edited to include additional documentation in text format. \ No newline at end of file +: Can be added anywhere on documents and edited to include additional documentation in text format. \ No newline at end of file diff --git a/site/guide/model-documentation/content_blocks/_test-driven-block.qmd b/site/guide/documentation/content_blocks/_test-driven-block.qmd similarity index 100% rename from site/guide/model-documentation/content_blocks/_test-driven-block.qmd rename to site/guide/documentation/content_blocks/_test-driven-block.qmd diff --git a/site/guide/model-documentation/content_blocks/equation-preview.png b/site/guide/documentation/content_blocks/equation-preview.png similarity index 100% rename from site/guide/model-documentation/content_blocks/equation-preview.png rename to site/guide/documentation/content_blocks/equation-preview.png diff --git a/site/guide/model-documentation/content_blocks/formula-display-modes.png b/site/guide/documentation/content_blocks/formula-display-modes.png similarity index 100% rename from site/guide/model-documentation/content_blocks/formula-display-modes.png rename to site/guide/documentation/content_blocks/formula-display-modes.png diff --git a/site/guide/model-documentation/submit-for-approval.qmd b/site/guide/documentation/submit-documents.qmd similarity index 82% rename from site/guide/model-documentation/submit-for-approval.qmd rename to site/guide/documentation/submit-documents.qmd index 63dd86eec4..7a4557819a 100644 --- a/site/guide/model-documentation/submit-for-approval.qmd +++ b/site/guide/documentation/submit-documents.qmd @@ -2,20 +2,21 @@ # 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: "Submit for approval" +title: "Submit documents" date: last-modified aliases: - /guide/submit-for-approval.html + - /guide/model-documentation/submit-for-approval.html --- -{{< include /guide/model-documentation/_submit-for-approval.qmd >}} +{{< include /guide/documentation/_submit-for-approval.qmd >}} ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] +- [x] The record you want to submit documents for is registered in the inventory.[^1] - [x] The approval workflow has been configured by an administrator.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] diff --git a/site/guide/model-documentation/test-driven-block-menu.png b/site/guide/documentation/test-driven-block-menu.png similarity index 100% rename from site/guide/model-documentation/test-driven-block-menu.png rename to site/guide/documentation/test-driven-block-menu.png diff --git a/site/guide/model-documentation/view-documentation-guidelines.qmd b/site/guide/documentation/view-development-guidelines.qmd similarity index 59% rename from site/guide/model-documentation/view-documentation-guidelines.qmd rename to site/guide/documentation/view-development-guidelines.qmd index e9affee120..a00c7c2dfa 100644 --- a/site/guide/model-documentation/view-documentation-guidelines.qmd +++ b/site/guide/documentation/view-development-guidelines.qmd @@ -2,13 +2,14 @@ # 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: "View documentation guidelines" +title: "View development guidelines" date: last-modified aliases: - /guide/view-documentation-guidelines.html + - /guide/model-documentation/view-documentation-guidelines.html --- -View the guidelines for model documentation associated with a template to ensure that you are compliant with documentation requirements. +View the guidelines for Development type documents associated with a template to ensure that you are compliant with documentation requirements. ::: {.callout title="Static PDF uploads do not contain documentation guidelines."} Only PDFs converted to editable documents,[^1] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} contain documentation guidelines. @@ -19,7 +20,7 @@ Only PDFs converted to editable documents,[^1] documents generated by the {{< va ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are documenting is registered in the model inventory.[^2] +- [x] The record you are documenting is registered in the inventory.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] ::: {.callout title="To configure documentation guidelines for templates, you must have sufficient guideline permissions."} @@ -33,20 +34,20 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss 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.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] 4. Click on a Development type file.[^6] -5. In any section of the documentation for a model, click **{{< var vm.product >}} Insights™** in the top right corner to expand the **{{< var vm.product >}} Insights™** sidebar. +5. In any section of the documentation for a record, click **{{< var vm.product >}} Insights™** in the top right corner to expand the **{{< var vm.product >}} Insights™** sidebar. - **Guidelines** are shown for each document section, associated with the template configured by your model validation team. + **Guidelines** are shown for each document section, associated with the template configured by your validation team. -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) @@ -54,6 +55,6 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^6]: [Working with model documentation](working-with-model-documentation.qmd#document-overview) \ No newline at end of file +[^6]: [Working with documentation](working-with-documentation.qmd#document-overview) \ No newline at end of file diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/documentation/work-with-content-blocks.qmd similarity index 78% rename from site/guide/model-documentation/work-with-content-blocks.qmd rename to site/guide/documentation/work-with-content-blocks.qmd index 81a70d1ea1..cd1344e9b6 100644 --- a/site/guide/model-documentation/work-with-content-blocks.qmd +++ b/site/guide/documentation/work-with-content-blocks.qmd @@ -6,16 +6,17 @@ title: "Work with content blocks" date: last-modified aliases: - /guide/work-with-content-blocks.html + - /guide/model-documentation/work-with-content-blocks.html includes: pdf-context: true blocks: true --- -Make edits to your model documents by adding or removing content blocks directly in the online editor. +Make edits to your documents by adding or removing content blocks directly in the online editor. ## What are content blocks? -Content blocks provide you with sections that are part of a template, and are used in model documents. +Content blocks provide you with sections that are part of a template, and are used in documents. - You can think of these sections as an empty canvas that you fill in with text and test results. - Multiple sections are joined to create a longer document with a table of contents that has different heading and subheading levels, such as "1.," "1.1.," and so on. @@ -36,13 +37,13 @@ Content blocks can be new, blank blocks, or prepopulated via your library of log ### Content editing toolbar -![Content editing toolbar](/guide/model-documentation/content-editing-toolbar.png){fig-alt="A screenshot showing the content editing toolbar" .screenshot} +![Content editing toolbar](/guide/documentation/content-editing-toolbar.png){fig-alt="A screenshot showing the content editing toolbar" .screenshot} The content editing toolbar is a rich text editor that enables you to: - Undo or redo changes - Format your text, including adding hyperlinks and code blocks -- Reference related model inventory and artifact field values with variables[^2] +- Reference related record and artifact field values with variables[^2] - Insert LaTex formulas[^3] - Attach images via upload or URL @@ -57,15 +58,15 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^5] -- [x] Documents exist and are completed or are in progress for your model.[^6] +- [x] There are records registered in the inventory.[^5] +- [x] Documents exist and are completed or are in progress for your record.[^6] - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^7] ::: ## Add content blocks -{{< include /guide/model-documentation/_add-content-blocks.qmd >}} +{{< include /guide/documentation/_add-content-blocks.qmd >}} 6. Click {{< fa square-plus >}} and then select one of the available options: @@ -98,7 +99,7 @@ While editing a simple text block within documents, you can reference values in ::: {.callout} - To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^12] -- Note that while you are able to select fields with empty values within available model inventory or artifact type fields, no value will be displayed in the content block until the field is populated. +- Note that while you are able to select fields with empty values within available record or artifact type fields, no value will be displayed in the content block until the field is populated. ::: @@ -127,7 +128,7 @@ To generate content drafts: {{< include content_blocks/_generate-with-ai.qmd >}} -When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Model Activity[^15] just like other updates to your documents. +When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Activity[^15] just like other updates to your documents.
    @@ -138,13 +139,13 @@ When generating content drafts with AI, accepted versions and edits are retained When you generate content, the content builder uses the following context: - Template guidelines — Instructions from the document template for the current section -- Model metadata: - - Model name - - Model purpose - - Model use - - Model ID - - Model inventory fields -- Model document content — Text blocks and test result descriptions from your document (figures and tables are not included) +- Record metadata: + - Record name + - Record purpose + - Record use + - Record ID + - Record fields +- Record document content — Text blocks and test result descriptions from your document (figures and tables are not included) ::: ::: @@ -157,9 +158,9 @@ Test-driven or metric over time blocks can be re-added later on but **text block 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.[^16] +2. Select a record or find your record by applying a filter or searching for it.[^16] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^17] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^17] 4. Click on the document file you want to remove a block from.[^18] @@ -174,7 +175,7 @@ Test-driven or metric over time blocks can be re-added later on but **text block -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Reference field values](#reference-field-values) @@ -184,17 +185,17 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^5]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^6]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^6]: [Working with documents](/guide/templates/working-with-documents.qmd) [^7]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^8]: [Manage text block library](/guide/templates/manage-text-block-library.qmd) -[^9]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd) +[^9]: [Work with test results](/guide/documentation/work-with-test-results.qmd) [^10]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd) -[^11]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd) +[^11]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd) [^12]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults) @@ -206,6 +207,6 @@ Test-driven or metric over time blocks can be re-added later on but **text block [^16]: [Working with the model inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-models) -[^17]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^17]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^18]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) \ No newline at end of file +[^18]: [Working with documents](/guide/templates/working-with-documents.qmd) \ No newline at end of file diff --git a/site/guide/model-documentation/work-with-document-versions.qmd b/site/guide/documentation/work-with-document-versions.qmd similarity index 68% rename from site/guide/model-documentation/work-with-document-versions.qmd rename to site/guide/documentation/work-with-document-versions.qmd index ef70f87705..8c1ad1cdae 100644 --- a/site/guide/model-documentation/work-with-document-versions.qmd +++ b/site/guide/documentation/work-with-document-versions.qmd @@ -4,6 +4,8 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Work with document versions" date: last-modified +aliases: + - /guide/model-documentation/work-with-document-versions.html --- Save read-only versions of your documents in the {{< var validmind.platform >}} for reference and archival purposes. @@ -13,8 +15,8 @@ Save read-only versions of your documents in the {{< var validmind.platform >}} ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] -- [x] Documents exist and are completed or are in progress for your model.[^2] +- [x] There are records registered in the inventory.[^1] +- [x] Documents exist and are completed or are in progress for your record.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or [{{< fa circle-check >}} Validator]{.bubble}, or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] ::: @@ -23,9 +25,9 @@ Save read-only versions of your documents in the {{< var validmind.platform >}} 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.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab. +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab. 4. Click on the document file you want to save a version of.[^5] @@ -41,11 +43,11 @@ If you save another version before 5 minutes is up, you'll receive a warning toa ## View saved document versions -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. +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.[^6] +2. Select a record or find your record by applying a filter or searching for it.[^6] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Saved Versions** tab. +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Saved Versions** tab. 4. Click on the document file you want to review the saved version for.[^7] @@ -54,15 +56,15 @@ If you save another version before 5 minutes is up, you'll receive a warning toa [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^2]: [Working with documents](/guide/templates/working-with-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) [^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^7]: [Working with documents](/guide/templates/working-with-documents.qmd) diff --git a/site/guide/model-documentation/work-with-test-results.qmd b/site/guide/documentation/work-with-test-results.qmd similarity index 77% rename from site/guide/model-documentation/work-with-test-results.qmd rename to site/guide/documentation/work-with-test-results.qmd index cfa20b64e5..778e152aaf 100644 --- a/site/guide/model-documentation/work-with-test-results.qmd +++ b/site/guide/documentation/work-with-test-results.qmd @@ -6,6 +6,7 @@ title: "Work with test results" date: last-modified aliases: - /developer/model-documentation/work-with-test-results.html + - /guide/model-documentation/work-with-test-results.html --- Once generated via the {{< var validmind.developer >}}, view and add the test results to your documentation in the {{< var validmind.platform >}}. @@ -20,8 +21,8 @@ You can only upload and work with test results for PDFs converted to editable do ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you want to attach test results to is registered in the model inventory.[^2] -- [x] Test results have already been documented via the {{< var validmind.developer >}} for your model.[^3] +- [x] The record you want to attach test results to is registered in the inventory.[^2] +- [x] Test results have already been documented via the {{< var validmind.developer >}} for your record.[^3] - [x] You are a assigned a role with sufficient permissions to perform the tasks in this guide.[^4]
    @@ -29,8 +30,8 @@ You can only upload and work with test results for PDFs converted to editable do ::: {.callout-button .pl4 .nt4} ::: {.callout collapse="true" appearance="minimal"} ### What are the default permissions for adding test-driven blocks? -- By default, the [{{< fa code >}} Developer]{.bubble} role can add test-driven blocks within model documentation or ongoing-monitoring plans. -- By default, the [{{< fa circle-check >}} Validator]{.bubble} role can add test-driven blocks within validation reports. +- By default, the [{{< fa code >}} Developer]{.bubble} role can add test-driven blocks within Development type (for example, model documentation) or Monitoring type (ongoing monitoring reports) documents. +- By default, the [{{< fa circle-check >}} Validator]{.bubble} role can add test-driven blocks within Validation type (validation reports) documents. - Permissions for custom document types are defined by your organization. ::: @@ -41,7 +42,7 @@ You can only upload and work with test results for PDFs converted to editable do ## Add test results - + {{< include _add-test-results.qmd >}} @@ -61,17 +62,17 @@ Once added to your documents, configure how the logged test results are displaye ## View test result metadata -{{< include /guide/model-documentation/_test-result-metadata.qmd >}} +{{< include /guide/documentation/_test-result-metadata.qmd >}} 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.[^6] +2. Select a record by clicking on it or find your record by applying a filter or searching for it.[^6] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] 4. Click on the document file you want to review test result metadata for.[^8] -{{< include /guide/model-documentation/_view-test-result-metadata.qmd >}} +{{< include /guide/documentation/_view-test-result-metadata.qmd >}} #### Filter historical test results @@ -84,7 +85,7 @@ To narrow down test runs, you can apply some filters: 2. On the **Select Your Filters** dialog that opens, enter your filtering criteria for: - Date range - - Model + - Record - Dataset - Run by @@ -99,7 +100,7 @@ Filters can be removed from the list of test result metadata by clicking on the -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) @@ -120,6 +121,6 @@ Filters can be removed from the list of test result metadata by clicking on the [^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) \ No newline at end of file +[^8]: [Working with documents](/guide/templates/working-with-documents.qmd) \ No newline at end of file diff --git a/site/guide/model-documentation/working-with-model-documentation.qmd b/site/guide/documentation/working-with-documentation.qmd similarity index 58% rename from site/guide/model-documentation/working-with-model-documentation.qmd rename to site/guide/documentation/working-with-documentation.qmd index 8f491dd228..566f2e7f94 100644 --- a/site/guide/model-documentation/working-with-model-documentation.qmd +++ b/site/guide/documentation/working-with-documentation.qmd @@ -2,7 +2,7 @@ # 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: "Working with model documentation" +title: "Working with documentation" date: last-modified listing: - id: draft-documentation @@ -12,7 +12,7 @@ listing: sort: false fields: [title, description] contents: - - view-documentation-guidelines.qmd + - view-development-guidelines.qmd - work-with-content-blocks.qmd - work-with-test-results.qmd - work-with-document-versions.qmd @@ -23,22 +23,23 @@ listing: sort: false fields: [title, description] contents: - - assign-documentation-section-statuses.qmd + - assign-development-section-statuses.qmd - check-documents-for-compliance.qmd - collaborate-with-others.qmd - - submit-for-approval.qmd + - submit-documents.qmd aliases: - /guide/working-with-model-documentation.html + - /guide/model-documentation/working-with-model-documentation.html --- -After you upload initial model documentation through the {{< var vm.developer >}}, use the {{< var vm.platform >}} to make qualitative edits to model documentation, view guidelines, collaborate with validators, and submit your model documentation for approval. +After you upload initial documentation through the {{< var validmind.developer >}} as part of your development process, use the {{< var validmind.platform >}} to make qualitative edits to documentation, collaborate with other stakeholders, and submit your work for review. ::: {.callout} -## Looking to get started as a model developer? +## Looking to get started as a developer? -This section describes how to work with model documentation in the {{< var validmind.platform >}}. Typically, you perform the tasks described here **after you have uploaded some initial model documentation** with the {{< var validmind.developer >}}. +This section describes how to work with Development type documents[^1] (for example, model documentation) in the {{< var validmind.platform >}}. Typically, you perform the tasks described here **after you have uploaded some initial documentation** with the {{< var validmind.developer >}}. -[{{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/validmind-library.qmd) +[Learn more about the {{< var validmind.developer >}} {{< fa hand-point-right>}}](/developer/validmind-library.qmd){.button .button-green} ::: ::: {.attn} @@ -46,9 +47,9 @@ This section describes how to work with model documentation in the {{< var valid ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are documenting is registered in the model inventory.[^1] -- [x] You have provided some content for the documentation, either by uploading it through the {{< var validmind.developer >}}[^2] or via the {{< var validmind.platform >}}. -- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] +- [x] The record you are documenting is registered in the inventory.[^2] +- [x] You have provided some content for the documentation, either by uploading it through the {{< var vm.developer >}}[^3] or via the {{< var vm.platform >}}. +- [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] ::: @@ -88,12 +89,12 @@ This section describes how to work with model documentation in the {{< var valid ### Add or edit documentation ::: {.callout title="Static PDF uploads cannot be edited."} -Only PDFs converted to editable documents,[^4] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} can be edited. +Only PDFs converted to editable documents,[^5] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} can be edited. ::: -Modify the contents of the **Latest** version of your document:[^5] +Modify the contents of the **Latest** version of your document:[^6] -1. From the **Document Overview**, jump to any section of the model documentation by clicking on the heading you would like to view. +1. From the **Document Overview**, jump to any section of the documentation by clicking on the heading you would like to view. 5. In any section of the documentation, click to add or edit content. @@ -111,14 +112,14 @@ Modify the contents of the **Latest** version of your document:[^5] [Include any common issues or errors that may arise during the task and how to resolve them.] ---> -## Prepare model documentation +## Prepare documentation -Draft, edit, and refine your model documentation, complete with supporting test results: +Draft, edit, and refine your documentation, complete with supporting test results: :::{#draft-documentation} ::: -Wrap up your model documentation, collaborate with other stakeholders, and submit your work for approval: +Wrap up your documentation, collaborate with other stakeholders, and submit your work for review: :::{#complete-documentation} ::: @@ -126,12 +127,14 @@ Wrap up your model documentation, collaborate with other stakeholders, and submi -[^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) +[^1]: [Manage document types](/guide/templates/manage-document-types.qmd) -[^2]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) +[^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) +[^3]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) -[^4]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) \ No newline at end of file +[^5]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) + +[^6]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) \ No newline at end of file diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd index b3628ba037..4a14c93ebf 100644 --- a/site/guide/guides.qmd +++ b/site/guide/guides.qmd @@ -61,26 +61,26 @@ listing: sort: false fields: [title, description] contents: - - templates/working-with-model-documents.qmd + - templates/working-with-documents.qmd - templates/working-with-document-templates.qmd - templates/manage-text-block-library.qmd - templates/customize-document-checker.qmd - - id: model-documentation + - id: documentation type: grid max-description-length: 250 sort: false fields: [title, description] contents: - - model-documentation/working-with-model-documentation.qmd - - id: model-validation + - documentation/working-with-documentation.qmd + - id: validation type: grid max-description-length: 250 sort: false fields: [title, description] contents: - - model-validation/managing-model-validation.qmd - - model-validation/preparing-validation-reports.qmd - - model-validation/working-with-artifacts.qmd + - validation/managing-validation.qmd + - validation/preparing-validation-reports.qmd + - validation/working-with-artifacts.qmd - id: reporting type: grid max-description-length: 250 @@ -144,14 +144,14 @@ Our guides offer step-by-step instructions for frequent tasks you perform within :::{#documents-templates} ::: -## Model documentation +## Documentation -:::{#model-documentation} +:::{#documentation} ::: -## Model validation +## Validation -:::{#model-validation} +:::{#validation} ::: ## Reporting diff --git a/site/guide/integrations/configure-analytics-exports.qmd b/site/guide/integrations/configure-analytics-exports.qmd index d77b523692..24ca319819 100644 --- a/site/guide/integrations/configure-analytics-exports.qmd +++ b/site/guide/integrations/configure-analytics-exports.qmd @@ -167,6 +167,6 @@ Data you exported previously will remain in the cloud storage destination unchan [^2]: [Manage secrets](/guide/integrations/manage-secrets.qmd) -[^3]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^3]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) [^4]: [View record activity](/guide/inventory/view-record-activity.qmd) diff --git a/site/guide/integrations/link-external-models.qmd b/site/guide/integrations/link-external-models.qmd index 76d7dce10c..3c3aa16ee7 100644 --- a/site/guide/integrations/link-external-models.qmd +++ b/site/guide/integrations/link-external-models.qmd @@ -17,7 +17,7 @@ You can link, refresh, edit, and remove these connections as needed. ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] +- [x] The record you want to link external models for is registered in the inventory.[^1] - [x] A connection is configured for the external system you want to link to.[^2] - [x] You are assigned a role with sufficient permissions to manage model links, such as [{{< fa hand >}} Customer Admin]{.bubble}.[^3] diff --git a/site/guide/inventory/_add-edit-record-types.qmd b/site/guide/inventory/_add-edit-record-types.qmd index daadf34dd8..ff0ca938fa 100644 --- a/site/guide/inventory/_add-edit-record-types.qmd +++ b/site/guide/inventory/_add-edit-record-types.qmd @@ -17,7 +17,7 @@ c. Include optional information for your record type: - Enter a **[description]{.smallcaps}** to indicate the purpose of the record type displayed on the list of record types. - Enter a URL-safe **[slug]{.smallcaps}** where a list of records of this type will be accessible in your {{< var validmind.platform >}} URL under the inventory path.[^url-slug] - Select the **[document types]{.smallcaps}** available to be created for this record type.^[[Manage document types](/guide/templates/manage-document-types.qmd)] - - Select the **[artifact types]{.smallcaps}** available to be logged on this record type.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] + - Select the **[artifact types]{.smallcaps}** available to be logged on this record type.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] - Select the **[stakeholder types]{.smallcaps}** that should be displayed on this record type.^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] - Select the **[default stakeholder types]{.smallcaps}** that should be displayed by default on this record type. @@ -58,7 +58,7 @@ b. Include optional information for your record type: - Enter a **[description]{.smallcaps}** to indicate the purpose of the record type displayed on the list of record types. - Enter a URL-safe **[slug]{.smallcaps}** where a list of records of this type will be accessible in your {{< var validmind.platform >}} URL under the inventory path. If left blank, a slug will be automatically generated in `kebab-case` format - Select the [**[document types]{.smallcaps}**](/guide/templates/manage-document-types.qmd){target="_blank"} available to be created for this record type. - - Select the [**[artifact types]{.smallcaps}**](/guide/model-validation/manage-artifact-types.qmd){target="_blank"} available to be logged on this record type. + - Select the [**[artifact types]{.smallcaps}**](/guide/validation/manage-artifact-types.qmd){target="_blank"} available to be logged on this record type. - Select the [**[stakeholder types]{.smallcaps}**](/guide/configuration/manage-record-stakeholder-types.qmd){target="_blank"} that should be displayed on this record type. - Select the **[default stakeholder types]{.smallcaps}** that should be displayed by default on this record type. diff --git a/site/guide/inventory/_field-types.qmd b/site/guide/inventory/_field-types.qmd index 9c3d46d5bd..619e33d3d4 100644 --- a/site/guide/inventory/_field-types.qmd +++ b/site/guide/inventory/_field-types.qmd @@ -6,9 +6,9 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible when-format="html" when-meta="includes.inventory"} Aggregation -: Automatically compute a read-only value from downstream artifacts^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] linked to this record. +: Automatically compute a read-only value from downstream artifacts^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] linked to this record. -1. Select the type of **[artifacts]{.smallcaps}** to aggregate from.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] +1. Select the type of **[artifacts]{.smallcaps}** to aggregate from.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] 2. Select an **[aggregation function]{.smallcaps}**:^[For MIN or MAX, also select the Date type **[artifact field]{.smallcaps}** to aggregate on.] @@ -62,7 +62,7 @@ Attachments :::: {.content-visible when-format="html" when-meta="includes.artifacts"} Attachments -: Upload supporting files for your artifact.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] Files must be less than 50 MB each in size. +: Upload supporting files for your artifact.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] Files must be less than 50 MB each in size. :::: Calculation @@ -121,7 +121,7 @@ Your calculated field is grouped under `Model Risk` inventory fields, and can on ### Example — Use artifact types in your formulas to create dynamic calculations -Use simple dot notation to include [artifact types](/guide/model-validation/manage-artifact-types.qmd){target="_blank"}: +Use simple dot notation to include [artifact types](/guide/validation/manage-artifact-types.qmd){target="_blank"}: - `finding_type.tag` — Technical tag: `VALIDATION_ISSUE` - `finding_type.name` — Human-readable name: `Validation Issue` @@ -248,7 +248,7 @@ User :::: {.content-hidden unless-format="revealjs"} Attachments -: Upload supporting files for your [record](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} or [artifact](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Files must be less than 50 MB each in size. +: Upload supporting files for your [record](/guide/inventory/edit-inventory-fields.qmd#manage-attachments){target="_blank"} or [artifact](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Files must be less than 50 MB each in size. Calculation : Define a `formula(params)` function that automatically calculates and returns a read-only value based on the params dictionary, which includes selected custom field keys retrieved from your other inventory record fields. diff --git a/site/guide/inventory/_inventory-record-types.qmd b/site/guide/inventory/_inventory-record-types.qmd index 117430be88..1d0e037293 100644 --- a/site/guide/inventory/_inventory-record-types.qmd +++ b/site/guide/inventory/_inventory-record-types.qmd @@ -2,4 +2,6 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Configure the record types available in your inventory. Each record type has associated fields and stakeholder types that can be customized for your organization's unique requirements. \ No newline at end of file +Configure the record types available in your inventory. Each record type has associated fields and stakeholder types that can be customized for your organization's unique requirements. + +*Records* are tools tracked in the {{< var validmind.platform >}} inventory such as models, AI agents, or other assets that are used to make decisions or perform tasks, subject to validation and governance as part of your organization's risk management oversight. \ No newline at end of file diff --git a/site/guide/inventory/_reference-field-values.qmd b/site/guide/inventory/_reference-field-values.qmd index d091e30af0..48643150f9 100644 --- a/site/guide/inventory/_reference-field-values.qmd +++ b/site/guide/inventory/_reference-field-values.qmd @@ -16,7 +16,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.flex .flex-wrap .justify-around} ::: {.w-50-ns .tc} -[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} +[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} ::: @@ -47,7 +47,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.flex .flex-wrap .justify-around} ::: {.w-50-ns .tc} -[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} +[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#reference-field-values){.button .button-green} ::: diff --git a/site/guide/inventory/_view-record-activity-overview.qmd b/site/guide/inventory/_view-record-activity-overview.qmd index 112e2dc2fb..a238d728bf 100644 --- a/site/guide/inventory/_view-record-activity-overview.qmd +++ b/site/guide/inventory/_view-record-activity-overview.qmd @@ -6,11 +6,11 @@ The **{{< fa wifi >}} Activity** page shows a record of activities for the selec :::: {.content-visible unless-format="revealjs"} - Fields updated^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] -- Stage transitions^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] -- Updates to documents: documentation,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] validation reports,^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)], or custom documents +- Stage transitions^[[Manage record stages](/guide/workflows/manage-record-stages.qmd)] +- Updates to documents: documentation,^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] validation reports,^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)], or custom documents - Test results or metrics added via the {{< var vm.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] -- Artifacts added, updated, or removed^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] -- User comment creation and replies on documents^[[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting)] +- Artifacts added, updated, or removed^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] +- User comment creation and replies on documents^[[Collaborate with others](/guide/documentation/collaborate-with-others.qmd#commenting)] - Stakeholders added or removed^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records)] - Workflow activity^[[Working with workflows](/guide/workflows/working-with-workflows.qmd)] diff --git a/site/guide/inventory/archive-delete-records.qmd b/site/guide/inventory/archive-delete-records.qmd index 9b87df9af2..6e665792b9 100644 --- a/site/guide/inventory/archive-delete-records.qmd +++ b/site/guide/inventory/archive-delete-records.qmd @@ -6,7 +6,6 @@ title: "Archive and delete records" date: last-modified aliases: - /guide/model-inventory/archive-delete-models.html - - /guide/inventory/archive-delete-models.html --- Archive records within the {{< var vm.product >}} inventory when they are decommissioned or delete records that you no need to track, keeping your inventory accurate and up to date with your organization's current resources. @@ -102,7 +101,7 @@ If a record was created in error, or you otherwise no longer require a record to [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^4]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) +[^4]: [Manage record stages](/guide/workflows/manage-record-stages.qmd) [^5]: [Setting up workflows](/guide/workflows/setting-up-workflows.qmd) diff --git a/site/guide/inventory/configure-record-interdependencies.qmd b/site/guide/inventory/configure-record-interdependencies.qmd index 8adb69d1fa..458ce53913 100644 --- a/site/guide/inventory/configure-record-interdependencies.qmd +++ b/site/guide/inventory/configure-record-interdependencies.qmd @@ -6,7 +6,6 @@ title: "Configure record interdependencies" date: last-modified aliases: - /guide/model-inventory/configure-model-interdependencies.html - - /guide/inventory/configure-model-interdependencies.html --- Link two or more records in your {{< var vm.product >}} inventory together. Dependencies are useful to understand how a record is diff --git a/site/guide/inventory/customize-inventory-layout.qmd b/site/guide/inventory/customize-inventory-layout.qmd index b846b0bff4..d5e4eed899 100644 --- a/site/guide/inventory/customize-inventory-layout.qmd +++ b/site/guide/inventory/customize-inventory-layout.qmd @@ -7,7 +7,6 @@ date: last-modified aliases: - /guide/customize-model-inventory-layout.html - /guide/model-inventory/customize-model-inventory-layout.html - - /guide/inventory/customize-model-inventory-layout.html includes: inventory: true --- diff --git a/site/guide/inventory/customize-record-overview-page.qmd b/site/guide/inventory/customize-record-overview-page.qmd index b213c53ddc..932638431f 100644 --- a/site/guide/inventory/customize-record-overview-page.qmd +++ b/site/guide/inventory/customize-record-overview-page.qmd @@ -6,7 +6,6 @@ title: "Customize record overview page" date: last-modified aliases: - /guide/model-inventory/customize-model-overview-page.html - - /guide/inventory/customize-model-overview-page.html --- Configure what and how inventory fields appear when you open a record’s details in the inventory. diff --git a/site/guide/inventory/edit-inventory-fields.qmd b/site/guide/inventory/edit-inventory-fields.qmd index 0085fd894a..f9885de76f 100644 --- a/site/guide/inventory/edit-inventory-fields.qmd +++ b/site/guide/inventory/edit-inventory-fields.qmd @@ -7,7 +7,6 @@ date: last-modified aliases: - /guide/edit-model-inventory-fields.html - /guide/model-inventory/edit-model-inventory-fields.html - - /guide/inventory/edit-model-inventory-fields.html includes: pdf-context: true inventory: true @@ -20,7 +19,7 @@ Edit individual detail fields on a record to ensure that record details are accu ## Prerequisites - [x] {{< var link.login >}} -- [x] The record is registered in the inventory.[^1] +- [x] The record you want to edit fields for is registered in the inventory.[^1] - [x] You are the record owner[^2] for the record you want to edit, a [{{< fa hand >}} Customer Admin]{.bubble}, or assigned another role or stakeholder type with sufficient permissions to perform the tasks in this guide.[^3] ::: @@ -129,7 +128,7 @@ To work with attachments on records, first add an attachment inventory field.[^9 [^9]: [Manage inventory fields](manage-inventory-fields.qmd#inventory-field-types) :::: {.content-visible when-format="html" when-meta="includes.pdf-context"} -[^10]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#generate-content) +[^10]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#generate-content) :::: diff --git a/site/guide/inventory/manage-inventory-fields.qmd b/site/guide/inventory/manage-inventory-fields.qmd index 4f2286b4ce..e9541ad0da 100644 --- a/site/guide/inventory/manage-inventory-fields.qmd +++ b/site/guide/inventory/manage-inventory-fields.qmd @@ -8,7 +8,6 @@ aliases: - manage-inventory-custom-fields.html - /guide/manage-inventory-custom-fields.html - /guide/model-inventory/manage-model-inventory-fields.html - - /guide/inventory/manage-model-inventory-fields.html includes: inventory: true --- diff --git a/site/guide/inventory/managing-the-inventory.qmd b/site/guide/inventory/managing-the-inventory.qmd index f7c5356961..b5095eebb4 100644 --- a/site/guide/inventory/managing-the-inventory.qmd +++ b/site/guide/inventory/managing-the-inventory.qmd @@ -16,7 +16,6 @@ listing: - archive-delete-records.qmd aliases: - /guide/model-inventory/managing-model-inventory.html - - /guide/inventory/managing-model-inventory.html --- Once you're familiar with the {{< var vm.product >}} inventory, dive into more advanced features like managing record interdependencies, and manually changing the stage of records. diff --git a/site/guide/inventory/register-records-in-inventory.qmd b/site/guide/inventory/register-records-in-inventory.qmd index e593ea3930..5bc0d1ea7d 100644 --- a/site/guide/inventory/register-records-in-inventory.qmd +++ b/site/guide/inventory/register-records-in-inventory.qmd @@ -7,7 +7,6 @@ date: last-modified aliases: - /guide/register-models-in-model-inventory.html - /guide/model-inventory/register-models-in-inventory.html - - /guide/inventory/register-models-in-inventory.html tbl-cap-location: bottom --- diff --git a/site/guide/inventory/view-record-activity.qmd b/site/guide/inventory/view-record-activity.qmd index 7dd4d5b50b..b710fd5959 100644 --- a/site/guide/inventory/view-record-activity.qmd +++ b/site/guide/inventory/view-record-activity.qmd @@ -5,10 +5,9 @@ title: "View record activity" date: last-modified aliases: - - /guide/model-documentation/view-documentation-activity.html + - /guide/documentation/view-documentation-activity.html - /guide/view-documentation-activity.html - /guide/model-inventory/view-model-activity.html - - /guide/inventory/view-model-activity.html --- Use the audit trail functionality in the {{< var validmind.platform >}} to track or audit all the information events associated with a specific record. See a record of comments, workflow status changes, and updates made to the record. @@ -111,7 +110,7 @@ Filters persist in the URL, so you can share or bookmark a filtered view. [^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^6]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^7]: For example, selecting **Artifacts: Validation Issue** shows all validation issue artifact type events. @@ -121,21 +120,21 @@ Filters persist in the URL, so you can share or bookmark a filtered view. [^10]: [Edit inventory fields](edit-inventory-fields.qmd) -[^11]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^11]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^12]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) -[^13]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) +[^13]: [Manage record stages](/guide/workflows/manage-record-stages.qmd) [^14]: [Working with workflows](/guide/workflows/working-with-workflows.qmd) -[^15]: [Working with artifacts](/guide/model-validation/working-with-artifacts.qmd) +[^15]: [Working with artifacts](/guide/validation/working-with-artifacts.qmd) [^16]: For example, selecting **Artifacts: Validation Issue** shows a secondary selection for the names of validation issue artifact type events. [^17]: [Edit inventory fields](edit-inventory-fields.qmd) -[^18]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^18]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^19]: [{{< var validmind.developer >}}](/developer/validmind-library.qmd) diff --git a/site/guide/inventory/working-with-the-inventory.qmd b/site/guide/inventory/working-with-the-inventory.qmd index 3e35086c7f..45bf466ba2 100644 --- a/site/guide/inventory/working-with-the-inventory.qmd +++ b/site/guide/inventory/working-with-the-inventory.qmd @@ -19,7 +19,6 @@ listing: aliases: - /guide/working-with-model-inventory.html - /guide/model-inventory/working-with-model-inventory.html - - /guide/inventory/working-with-model-inventory.html includes: inventory: true --- @@ -84,8 +83,8 @@ For example, if you first search by keyword for `ValidMind` without clearing tha - [**[business unit]{.smallcaps}**](/guide/configuration/set-up-your-organization.qmd#manage-business-units) - [**[use]{.smallcaps}**](/guide/configuration/set-up-your-organization.qmd#manage-use-cases) - **[tier]{.smallcaps}** -- [**[stage]{.smallcaps}**](/guide/workflows/manage-model-stages.qmd) +- [**[stage]{.smallcaps}**](/guide/workflows/manage-record-stages.qmd) - **[creation date]{.smallcaps}** - [**[vendor name]{.smallcaps}**](/about/glossary/glossary.qmd#vendor-model) - **[updated date]{.smallcaps}** -- [**[documentation updated date]{.smallcaps}**](/guide/model-documentation/working-with-model-documentation.qmd) \ No newline at end of file +- [**[documentation updated date]{.smallcaps}**](/guide/documentation/working-with-documentation.qmd) \ No newline at end of file diff --git a/site/guide/model-documentation/_add-content-blocks.qmd b/site/guide/model-documentation/_add-content-blocks.qmd deleted file mode 100644 index 99a824a9a5..0000000000 --- a/site/guide/model-documentation/_add-content-blocks.qmd +++ /dev/null @@ -1,32 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] - -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] - -1. Click on the document file you want to add a content block to.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] - -1. Click on a section header to expand that section and add content. - -1. Hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: - - ![Adding a content block in the {{< var validmind.platform >}}](/guide/model-documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the ValidMind Platform" .screenshot} - -:::: - - - - -:::: {.content-hidden unless-format="revealjs"} -In any section of your model documentation, hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: - - ![Adding a content block in the UI](/guide/model-documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} - -After adding the block to your documentation, generate a content draft with AI using the [content editing toolbar](/guide/model-documentation/work-with-content-blocks.qmd#content-editing-toolbar){target="_blank"}: - -:::: \ No newline at end of file diff --git a/site/guide/model-documentation/_comment-activity.qmd b/site/guide/model-documentation/_comment-activity.qmd deleted file mode 100644 index 729d7a3e95..0000000000 --- a/site/guide/model-documentation/_comment-activity.qmd +++ /dev/null @@ -1,17 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -While working with content blocks,^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)] you can comment directly on specific portions of the text. - -All users associated with a model, such as model developers and model validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the **{{< fa home >}} Dashboard**.^[[Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd)] - -:::: - -:::: {.content-hidden unless-format="revealjs"} -While working with content blocks, you can comment directly on specific portions of the text. - -All users associated with a model, such as model developers and model validators, will see a notification that a comment has been posted in their **Recent Activity** feed, accessible via the [**{{< fa home >}} Dashboard**](/guide/configuration/customize-your-dashboard.qmd){target="_blank"}. - -:::: \ No newline at end of file diff --git a/site/guide/model-documentation/_document-overview.qmd b/site/guide/model-documentation/_document-overview.qmd deleted file mode 100644 index ba3fc8f57a..0000000000 --- a/site/guide/model-documentation/_document-overview.qmd +++ /dev/null @@ -1,34 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -::: {.callout title="Static PDF uploads do not include a Document Overview."} -Only PDFs converted to editable documents,^[[Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents)] documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} include a Document Overview. -::: - -The **Document Overview** shows a section-by-section outline of your model's documentation, as well as summaries of: - -- Any unresolved conversations^[[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)] -- The number of model artifacts^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] -- The completion status for your model's documentation^[[Assign section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd)] -- Recent activity on your model^[[View record activity](/guide/inventory/view-record-activity.qmd)] - -:::: - -:::: {.content-hidden unless-format="revealjs"} -The **Document Overview** shows a section-by-section outline of your model's documentation, as well as summaries of: - -- Any unresolved conversations -- The number of model artifacts -- The completion status for your model's documentation -- Recent activity on your model - -::: {.embed .pr3 .pl3 .f5} -**Static PDF uploads do not include a Document Overview.** - -Only PDFs converted to editable documents, documents generated by the {{< var validmind.developer >}}, or documents created in the {{< var validmind.platform >}} include a Document Overview. -::: - -:::: - diff --git a/site/guide/model-documentation/_locate-document-overview.qmd b/site/guide/model-documentation/_locate-document-overview.qmd deleted file mode 100644 index c8dc37038e..0000000000 --- a/site/guide/model-documentation/_locate-document-overview.qmd +++ /dev/null @@ -1,26 +0,0 @@ - - -To locate your document overview for a model: - -:::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] - -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] - -1. Click on a Development type file.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] - -:::: - -:::: {.content-hidden unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or [find your model by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="blank"}. - -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select **Development**. - -:::: - diff --git a/site/guide/model-validation/_add-artifacts-on-documentation.qmd b/site/guide/model-validation/_add-artifacts-on-documentation.qmd deleted file mode 100644 index 04717e789c..0000000000 --- a/site/guide/model-validation/_add-artifacts-on-documentation.qmd +++ /dev/null @@ -1,58 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] - -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] - -1. Click on a Development type file.^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd#document-overview)] - - - -1. On your model's documentation page, click **{{< fa square-plus >}} Add Model Artifact**. - -1. Select the artifact type^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] you want to add: - - - Validation Issue - - Policy Exception - - Model Limitation - -1. On the modal that opens, provide information for your artifact. - -1. When you are done, click **Save** to submit the artifact. - - Once created, you can then add supporting documentation to your artifact.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] - -:::: - -:::: {.content-hidden unless-format="revealjs"} -1. In the left sidebar, click **{{< fa cubes >}} Inventory**. - -1. Select a model or [find your model by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. - -1. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. - - - -1. On your model's documentation page, click **{{< fa plus >}} Add Model Artifact**. - -1. Select the [artifact type](/guide/model-validation/manage-artifact-types.qmd){target="_blank"} you want to add: - - - Validation Issue - - Policy Exception - - Model Limitation - -1. On the modal that opens, provide information for your artifact. - -1. When you are done, click **Save** to submit the artifact. - - Once created, you can then [add supporting documentation to your artifact](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. - -:::: - - - diff --git a/site/guide/model-validation/_validation-guidelines.qmd b/site/guide/model-validation/_validation-guidelines.qmd deleted file mode 100644 index 439e32722c..0000000000 --- a/site/guide/model-validation/_validation-guidelines.qmd +++ /dev/null @@ -1,5 +0,0 @@ - - -Validation guidelines ensure that models are accurate, reliable, and fit for their intended purpose by outlining standards for assessing their conceptual soundness, implementation, and performance in compliance with regulatory and internal governance requirements. \ No newline at end of file diff --git a/site/guide/monitoring/enable-monitoring.qmd b/site/guide/monitoring/enable-monitoring.qmd index 086ff75e2e..4445972aeb 100644 --- a/site/guide/monitoring/enable-monitoring.qmd +++ b/site/guide/monitoring/enable-monitoring.qmd @@ -148,8 +148,8 @@ After you have enabled ongoing monitoring and run your code to generate some out [^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^8]: [Working with documents](/guide/templates/working-with-documents.qmd) [^9]: [Review monitoring results](review-monitoring-results.qmd) \ No newline at end of file diff --git a/site/guide/monitoring/ongoing-monitoring.qmd b/site/guide/monitoring/ongoing-monitoring.qmd index cb351f3d83..6bd12dd7d2 100644 --- a/site/guide/monitoring/ongoing-monitoring.qmd +++ b/site/guide/monitoring/ongoing-monitoring.qmd @@ -153,6 +153,6 @@ To try out monitoring, check out the code sample for ongoing monitoring of model [^1]: [Regulatory requirements](/about/overview-model-risk-management.qmd#regulatory-requirements) -[^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^2]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^3]: [Quickstart for ongoing monitoring of models with {{< var vm.product >}}](../../notebooks/use_cases/ongoing_monitoring/quickstart_customer_churn_ongoing_monitoring.ipynb) diff --git a/site/guide/monitoring/review-monitoring-results.qmd b/site/guide/monitoring/review-monitoring-results.qmd index c957c6a5bd..f9dbf3118e 100644 --- a/site/guide/monitoring/review-monitoring-results.qmd +++ b/site/guide/monitoring/review-monitoring-results.qmd @@ -21,7 +21,7 @@ To ensure your model continues to perform as expected, it's important to regular ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] +- [x] The record you want to review monitoring results for is registered in the inventory.[^1] - [x] Monitoring has been enabled for your model.[^2] - [x] You are a [{{< fa code >}} Developer]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] - [x] The model is in the pre-approval stage for performance testing or the model has been approved and is in production. @@ -123,7 +123,7 @@ The final assessment is that the model requires attention: [^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^6]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^7]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^7]: [Working with documents](/guide/templates/working-with-documents.qmd) diff --git a/site/guide/monitoring/work-with-metrics-over-time.qmd b/site/guide/monitoring/work-with-metrics-over-time.qmd index 08fd9483a7..1fce02b5aa 100644 --- a/site/guide/monitoring/work-with-metrics-over-time.qmd +++ b/site/guide/monitoring/work-with-metrics-over-time.qmd @@ -48,7 +48,7 @@ Learn how to log metrics over time, set thresholds, and analyze model performanc 6. Hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: - ![Adding a content block in the UI](/guide/model-documentation/add-content-block.gif){fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} + ![Adding a content block in the UI](/guide/documentation/add-content-block.gif){fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} 7. Click {{< fa square-plus >}} and then select **Metric Over Time**[^7] under [from library]{.smallcaps}. @@ -150,17 +150,17 @@ After you have added metrics over time to your document, you can view the follow [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^6]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^6]: [Working with documents](/guide/templates/working-with-documents.qmd) -[^7]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) +[^7]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) [^8]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^9]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^9]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^10]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^10]: [Working with documents](/guide/templates/working-with-documents.qmd) [^11]: [Configure connections](/guide/integrations/configure-connections.qmd) and [Link external models](/guide/integrations/link-external-models.qmd) diff --git a/site/guide/reporting/_create-a-visualization.qmd b/site/guide/reporting/_create-a-visualization.qmd index 0e5bb2d3b6..2735588020 100644 --- a/site/guide/reporting/_create-a-visualization.qmd +++ b/site/guide/reporting/_create-a-visualization.qmd @@ -23,8 +23,8 @@ a. Select a **[visualization type]{.smallcaps}**: a. Select a **[dataset]{.smallcaps}**: - - **Artifact - Model Limitations** — Logged Model Limitation type artifacts only.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] - - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only.^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] + - **Artifact - Model Limitations** — Logged Model Limitation type artifacts only.^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] + - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only.^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] - **Artifact - Validation Issues** — Logged Validation Issue type artifacts only. - **Inventory Models** — Models logged in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] @@ -47,7 +47,7 @@ a. Select a **[visualization type]{.smallcaps}**: a. Select a **[dataset]{.smallcaps}**: - - **Artifact - Model Limitations** — Logged Model Limitation type [artifacts](/guide/model-validation/working-with-artifacts.qmd){target="_blank"}. only. + - **Artifact - Model Limitations** — Logged Model Limitation type [artifacts](/guide/validation/working-with-artifacts.qmd){target="_blank"}. only. - **Artifact - Policy Exceptions** — Logged Policy Exception type artifacts only. - **Artifact - Validation Issues** — Logged Validation Issue type artifacts only. - **Inventory Models** — [Models logged in your inventory](/guide/inventory/working-with-the-inventory.qmd){target="_blank"}. diff --git a/site/guide/reporting/_view-report-data.qmd b/site/guide/reporting/_view-report-data.qmd index dd2ac4f4ed..0a773b634f 100644 --- a/site/guide/reporting/_view-report-data.qmd +++ b/site/guide/reporting/_view-report-data.qmd @@ -18,8 +18,8 @@ Reports will not include data or artifacts from archived models.^[[Archive and d a. Click on the **Validation Issues** tab. b. Under **Validation Issues by Risk Area**, click on the risk area you want more details for. c. On the page that opens, the applicable validation issues are listed: - - Filter this list of validation issues^[[Filter and sort artifacts](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] - - Or customize column headers that display on this validation issue view^[[Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd)] + - Filter this list of validation issues^[[Filter and sort artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] + - Or customize column headers that display on this validation issue view^[[Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd)] d. To get more details on the validation issue itself, click on the title of the validation issue to take you to the **{{< fa triangle-exclamation >}} Validation Issues** section for the specific model the issue applies to. :::: @@ -37,8 +37,8 @@ Reports will not include data or artifacts from archived models.^[[Archive and d a. Click on the **Validation Issues** tab. b. Under **Validation Issues by Risk Area**, click on the risk area you want more details for. c. On the page that opens, the applicable validation issues are listed: - - [Filter this list of validation issues](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} - - Or customize column headers that display on this [validation issue view](/guide/model-validation/customize-artifact-layouts.qmd){target="_blank"} + - [Filter this list of validation issues](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} + - Or customize column headers that display on this [validation issue view](/guide/validation/customize-artifact-layouts.qmd){target="_blank"} d. To get more details on the validation issue itself, click on the title of the issue to take you to the **{{< fa triangle-exclamation >}} Validation Issues** section for the specific model the validation issue applies to. :::: \ No newline at end of file diff --git a/site/guide/reporting/export-analytics.qmd b/site/guide/reporting/export-analytics.qmd index c543c29019..5b7f382ca2 100644 --- a/site/guide/reporting/export-analytics.qmd +++ b/site/guide/reporting/export-analytics.qmd @@ -36,5 +36,5 @@ Export analytics widgets as comma-delimited tables (`.csv`). [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) +[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) diff --git a/site/guide/reporting/export-artifacts.qmd b/site/guide/reporting/export-artifacts.qmd index b2772655b4..1c358f5d6d 100644 --- a/site/guide/reporting/export-artifacts.qmd +++ b/site/guide/reporting/export-artifacts.qmd @@ -15,7 +15,7 @@ Export tracked model artifacts as comma-delimited tables (`.csv`). ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] - [x] There are artifacts logged on any model.[^2] ::: @@ -62,17 +62,17 @@ Export tracked model artifacts as comma-delimited tables (`.csv`). [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) +[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) -[^3]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts) +[^3]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts) -[^4]: [Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd) +[^4]: [Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd) -[^5]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^5]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) -[^6]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts) +[^6]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts) -[^7]: [Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd) +[^7]: [Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd) diff --git a/site/guide/reporting/export-documents.qmd b/site/guide/reporting/export-documents.qmd index 03bb65549c..fbe902a80e 100644 --- a/site/guide/reporting/export-documents.qmd +++ b/site/guide/reporting/export-documents.qmd @@ -6,7 +6,7 @@ title: "Export documents" date: last-modified aliases: - /guide/export-documentation.html - - /guide/model-documentation/export-documentation.html + - /guide/documentation/export-documentation.html --- Export model documents as XML-based Microsoft Word (`.docx`) or Adobe Portable Document Format `.pdf` files. @@ -21,7 +21,7 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] - [x] Documents exist and are completed or are in progress for your model.[^2] - [x] You are assigned a role with sufficient permissions to perform the tasks in this guide.[^3] @@ -65,27 +65,27 @@ Documents exported from {{< var vm.product >}} are compatible with Word 365, Wor [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^2]: [Working with documents](/guide/templates/working-with-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^6]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^6]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) -[^7]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^7]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) [^8]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) [^9]: [Manage document types](/guide/templates/manage-document-types.qmd) -[^10]: [Assess compliance](/guide/model-validation/assess-compliance.qmd) +[^10]: [Assess compliance](/guide/validation/assess-compliance.qmd) -[^11]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) +[^11]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) -[^12]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#commenting) +[^12]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd#commenting) [^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. diff --git a/site/guide/reporting/export-inventory.qmd b/site/guide/reporting/export-inventory.qmd index 38aa9d2a92..7abf57bc75 100644 --- a/site/guide/reporting/export-inventory.qmd +++ b/site/guide/reporting/export-inventory.qmd @@ -13,7 +13,7 @@ Export lists of models tracked in the inventory as comma-delimited tables (`.csv ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] ::: diff --git a/site/guide/reporting/view-report-data.qmd b/site/guide/reporting/view-report-data.qmd index bdea93b40d..1d91bccb2b 100644 --- a/site/guide/reporting/view-report-data.qmd +++ b/site/guide/reporting/view-report-data.qmd @@ -13,7 +13,7 @@ Review detailed data on your models or artifacts within the {{< var validmind.pl ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] - [x] There are artifacts logged on any model.[^2] ::: @@ -27,4 +27,4 @@ Review detailed data on your models or artifacts within the {{< var validmind.pl [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) \ No newline at end of file +[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) \ No newline at end of file diff --git a/site/guide/reporting/working-with-analytics.qmd b/site/guide/reporting/working-with-analytics.qmd index 7dbcdd4139..9decbbcd07 100644 --- a/site/guide/reporting/working-with-analytics.qmd +++ b/site/guide/reporting/working-with-analytics.qmd @@ -6,7 +6,7 @@ title: "Working with analytics" date: last-modified aliases: - /guide/view-reports.html - - /guide/model-validation/view-reports.html + - /guide/validation/view-reports.html listing: - id: reports type: grid @@ -37,7 +37,7 @@ Reports are primarily designed for model validators or Chief Risk Officers (CROs ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] +- [x] There are records registered in the inventory.[^1] - [x] There are validation issue type artifacts logged on any model.[^2] ::: @@ -137,15 +137,15 @@ Rearrange report widgets on your analytics pages, including your custom pages:[^ [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd) +[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) [^3]: [Manage roles](/guide/configuration/manage-roles.qmd) [^4]: [Manage business units](/guide/configuration/set-up-your-organization.qmd#manage-business-units) -[^5]: [Manage model stages](/guide/workflows/manage-model-stages.qmd) +[^5]: [Manage record stages](/guide/workflows/manage-record-stages.qmd) -[^6]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd#available-artifact-types) +[^6]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd#available-artifact-types) [^7]: [Customize your dashboard](/guide/configuration/customize-your-dashboard.qmd#manage-widgets) diff --git a/site/guide/shared/work-with-filters.qmd b/site/guide/shared/work-with-filters.qmd index 9f8ace4ba7..a54a8020c0 100644 --- a/site/guide/shared/work-with-filters.qmd +++ b/site/guide/shared/work-with-filters.qmd @@ -11,7 +11,7 @@ aliases: # NR This page exists only to provide a page we can link to from the filter modal in the product. # The page is intentionally not included in the sidebar because the docs for the filter modal are already embedded in the correct context: # - /guide/inventory/working-with-the-inventory.qmd -# - /guide/model-validation/view-filter-artifacts.qmd +# - /guide/validation/view-filter-artifacts.qmd --- {{< include /guide/shared/_work-with-filters.qmd >}} diff --git a/site/guide/templates/_add-text-blocks.qmd b/site/guide/templates/_add-text-blocks.qmd index c51b6e8e1f..1112ab6430 100644 --- a/site/guide/templates/_add-text-blocks.qmd +++ b/site/guide/templates/_add-text-blocks.qmd @@ -25,15 +25,15 @@ To create a new text block via the block library: #### Reference field values -While composing content for a library text block, you can reference values in the form of variables from model inventory fields. When the text block is inserted into a document, values from the associated model's inventory fields will automatically be populated in the content block if not empty. +While composing content for a library text block, you can reference values in the form of variables from inventory record fields. When the text block is inserted into a document, values from the associated record's inventory fields will automatically be populated in the content block if not empty. -{{< include /guide/model-documentation/content_blocks/_reference-field-values.qmd >}} --> +{{< include /guide/documentation/content_blocks/_reference-field-values.qmd >}} --> #### Insert mathematical formulas While composing content for a library text block, you can insert math equations using the formula editor: -{{< include /guide/model-documentation/content_blocks/_insert-mathematical-formulas.qmd >}} +{{< include /guide/documentation/content_blocks/_insert-mathematical-formulas.qmd >}} diff --git a/site/guide/templates/_customize-document-templates.qmd b/site/guide/templates/_customize-document-templates.qmd index cb90ab3659..e94cd2314e 100644 --- a/site/guide/templates/_customize-document-templates.qmd +++ b/site/guide/templates/_customize-document-templates.qmd @@ -10,13 +10,13 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ``` --> :::: {.content-visible when-format="html" when-meta="includes.customize"} -Edit outlines for document templates from **{{< fa gear >}} Settings** or directly on model documents: +Edit outlines for document templates from **{{< fa gear >}} Settings** or directly on documents: ::: {.panel-tabset} #### From **{{< fa gear >}} Settings** -Editing outlines for document templates from **{{< fa gear >}} Settings** will create a new version of the template that can be applied to model documents: +Editing outlines for document templates from **{{< fa gear >}} Settings** will create a new version of the template that can be applied to documents: 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -24,10 +24,10 @@ Editing outlines for document templates from **{{< fa gear >}} Settings** will c 1. Select one of the tabs for the type of template you want to edit: - - **Development**^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] - - **Validation**^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] + - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] + - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] + - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] 1. Click the template to edit and on the template details page, select **{{< fa pencil >}} Edit Outline**. @@ -45,11 +45,11 @@ Editing outlines for templates on documents will only apply changes to that docu 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document you would like to customize the template outline for.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] +1. Click on the document you would like to customize the template outline for.^[[Working with documents](/guide/templates/working-with-documents.qmd)] 1. On the template details page, click **{{< fa pencil >}} Edit Outline**. @@ -72,11 +72,11 @@ Edit outlines for templates directly on documents to only apply changes to that 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on the document you would like to customize the template outline for.^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] +1. Click on the document you would like to customize the template outline for.^[[Working with documents](/guide/templates/working-with-documents.qmd)] 1. On the template details page, click **{{< fa pencil >}} Edit Outline**. @@ -90,7 +90,7 @@ Edit outlines for templates directly on documents to only apply changes to that :::: :::: {.content-hidden unless-format="revealjs"} -Customize {{< var vm.product >}}'s templates for model documents to fit your specific case-by-case needs, such as type or complexity of model or model use case. +Customize {{< var vm.product >}}'s templates for documents to fit your specific case-by-case needs, such as type or complexity of record or record use case. 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -119,7 +119,7 @@ Customize {{< var vm.product >}}'s templates for model documents to fit your spe - To add a subsection within the current section, select **{{< fa arrow-right >}} Subsection**. a. **Add content to sections** — In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}: - **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink} - - [**{{< fa circle-check >}} Guideline Block**](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates){target="_blank"} [validation reports only]{.smallercaps .pink} + - [**{{< fa circle-check >}} Guideline Block**](/guide/validation/manage-validation-guidelines.qmd#add-guidelines-to-templates){target="_blank"} [validation reports only]{.smallercaps .pink} - [**{{< fa align-left >}} Text Block**](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines){target="_blank"} ::: diff --git a/site/guide/templates/_document-templates.qmd b/site/guide/templates/_document-templates.qmd index e9894de55f..b73fc86122 100644 --- a/site/guide/templates/_document-templates.qmd +++ b/site/guide/templates/_document-templates.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Use {{< var vm.product >}}'s versioned document templates to ensure consistent and comprehensive model documentation, validation reports, ongoing monitoring reports, and other document types across all your models. \ No newline at end of file +Use {{< var vm.product >}}'s versioned document templates to ensure consistent and comprehensive documentation, validation reports, ongoing monitoring reports, and other document types across all your records. \ No newline at end of file diff --git a/site/guide/templates/_duplicate-template.qmd b/site/guide/templates/_duplicate-template.qmd index 11d3e33995..41aa0abacc 100644 --- a/site/guide/templates/_duplicate-template.qmd +++ b/site/guide/templates/_duplicate-template.qmd @@ -11,10 +11,10 @@ To duplicate an existing template and start with version one of that new templat 1. Select one of the tabs for the type of template you want to duplicate: - - **Development**^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] - - **Validation**^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] + - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] + - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] + - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] 1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**. @@ -22,7 +22,7 @@ To duplicate an existing template and start with version one of that new templat 1. Click **Duplicate Template** to create a copy of your template. -Once duplicated, customize your new template to your needs, making it available for use with your model documents. +Once duplicated, customize your new template to your needs, making it available for use with your documents. :::: @@ -34,7 +34,7 @@ To duplicate an existing template and start with version one of that new templat 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"}. +1. Select one of the tabs for the [type of template you want to duplicate](/guide/templates/working-with-documents.qmd){target="blank"}. 1. Click on the template to duplicate and on the template details page, select **{{< fa copy >}} Duplicate Template**. @@ -42,6 +42,6 @@ To duplicate an existing template and start with version one of that new templat 1. Click **Duplicate Template** to create a copy of your template. -Once duplicated, customize your new template to your needs, making it available for use with your model documents. +Once duplicated, customize your new template to your needs, making it available for use with your documents. :::: \ No newline at end of file diff --git a/site/guide/templates/_outline-editing-mode.qmd b/site/guide/templates/_outline-editing-mode.qmd index d2b98119d6..87725dfd4f 100644 --- a/site/guide/templates/_outline-editing-mode.qmd +++ b/site/guide/templates/_outline-editing-mode.qmd @@ -34,7 +34,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> Add content to sections : In any section of a template that does not have child sections, click **{{< fa plus >}}** to add additional [content]{.smallcaps}: - **{{< fa align-justify >}} Summary Block** [validation reports only]{.smallercaps .pink} - - **{{< fa circle-check >}} Guideline Block**^[[Add guidelines to templates](/guide/model-validation/manage-validation-guidelines.qmd#add-guidelines-to-templates)] [validation reports only]{.smallercaps .pink} + - **{{< fa circle-check >}} Guideline Block**^[[Add guidelines to templates](/guide/validation/manage-validation-guidelines.qmd#add-guidelines-to-templates)] [validation reports only]{.smallercaps .pink} - **{{< fa align-left >}} Text Block**^[[Add text blocks via template outlines](/guide/templates/customize-document-templates.qmd#add-text-blocks-via-template-outlines)] ::: \ No newline at end of file diff --git a/site/guide/templates/_text-blocks.qmd b/site/guide/templates/_text-blocks.qmd index a3b56db24d..3dcea362fd 100644 --- a/site/guide/templates/_text-blocks.qmd +++ b/site/guide/templates/_text-blocks.qmd @@ -3,7 +3,7 @@ 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"} -Build a library of reusable text blocks to insert into your model documents. Reusable text blocks can be private, visible only to the user, or shared, accessible across your organization. +Build a library of reusable text blocks to insert into your documents. Reusable text blocks can be private, visible only to the user, or shared, accessible across your organization. ::: {.callout} ## By default, only the [{{< fa hand >}} Customer Admin]{.bubble} role[^1] is able to add, edit, or delete shared text blocks. @@ -15,6 +15,6 @@ Private blocks can be modified by any user role and are unique to that user. :::: {.content-hidden unless-format="revealjs"} -Build a library of reusable text blocks to insert into your model documents. Reusable text blocks can be private, visible only to the user, or shared, accessible across your organization. +Build a library of reusable text blocks to insert into your documents. Reusable text blocks can be private, visible only to the user, or shared, accessible across your organization. :::: \ No newline at end of file diff --git a/site/guide/templates/_view-document-templates.qmd b/site/guide/templates/_view-document-templates.qmd index aa6fc9ee86..f374270c08 100644 --- a/site/guide/templates/_view-document-templates.qmd +++ b/site/guide/templates/_view-document-templates.qmd @@ -11,10 +11,10 @@ To review the existing templates available to your organization: 1. Select one of the tabs for the document type with the templates you want to view: - - **Development**^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] - - **Validation**^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)] + - **Development**^[[Working with documentation](/guide/documentation/working-with-documentation.qmd)] + - **Validation**^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd)] - **Monitoring**^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)] - - **Custom**^[[Working with model documents](/guide/templates/working-with-model-documents.qmd)] + - **Custom**^[[Working with documents](/guide/templates/working-with-documents.qmd)] Displayed in list view is an overview of information for templates under that specific document type. @@ -31,7 +31,7 @@ To review the existing templates available to your organization: - Template version owner - Version creation date - Version notes -- Models using selected template version +- Records using selected template version - Template outline ::: @@ -43,7 +43,7 @@ To review the existing templates available to your organization: - Template description - Template owner - Template creation date -- Models using that template and which versions +- Records using that template and which versions ::: @@ -55,7 +55,7 @@ To review the existing templates available to your organization: [^template-info]: - **Versions & outlines:** [Customize document templates](/guide/templates/customize-document-templates.qmd#edit-template-outlines) - - **Types:** [Working with model documents](/guide/templates/working-with-model-documents.qmd) + - **Types:** [Working with documents](/guide/templates/working-with-documents.qmd) :::: @@ -65,7 +65,7 @@ To review the existing templates available to your organization: 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"}. +1. Select one of the tabs for [the document type with the templates you want to view](/guide/templates/working-with-documents.qmd){target="blank"}. 1. Select one of the available templates to view detailed information about the template. diff --git a/site/guide/templates/_what-is-document-checker.qmd b/site/guide/templates/_what-is-document-checker.qmd index 1877ec5310..bb20d68bee 100644 --- a/site/guide/templates/_what-is-document-checker.qmd +++ b/site/guide/templates/_what-is-document-checker.qmd @@ -12,7 +12,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: ::: {.w-75-ns} -{{< include /guide/model-documentation/_document-checker.qmd >}} +{{< include /guide/documentation/_document-checker.qmd >}} :::: {.content-visible when-format="html" when-meta="includes.customize"} -Customizing the {{< var validmind.checker >}} to support your organization's unique regulatory requirements and policies helps start quality assurance early in the model lifecycle and enables individual contributors to actively participate in risk-management oversight. +Customizing the {{< var validmind.checker >}} to support your organization's unique regulatory requirements and policies helps start quality assurance early in record lifecycles and enables individual contributors to actively participate in risk-management oversight. :::: :::: {.content-visible when-format="html" unless-meta="includes.customize"} -As a compliance tool, the {{< var validmind.checker >}} is most useful when your documentation or report is sufficiently complete and you are preparing models for regulatory submission or internal audit, as it helps reduce manual review effort and improve quality assurance. +As a compliance tool, the {{< var validmind.checker >}} is most useful when your documentation or report is sufficiently complete and you are preparing records for regulatory submission or internal audit, as it helps reduce manual review effort and improve quality assurance. :::: diff --git a/site/guide/templates/customize-document-checker.qmd b/site/guide/templates/customize-document-checker.qmd index 5c05105d48..2ff9e2bccc 100644 --- a/site/guide/templates/customize-document-checker.qmd +++ b/site/guide/templates/customize-document-checker.qmd @@ -12,7 +12,7 @@ listing: sort: false fields: [title, description] contents: - - ../../model-documentation/check-documents-for-compliance.qmd + - ../../documentation/check-documents-for-compliance.qmd - ../../about/overview-llm-features.qmd aliases: - /guide/templates/customize-virtual-document-validator.html diff --git a/site/guide/templates/customize-document-templates.qmd b/site/guide/templates/customize-document-templates.qmd index c3c6b3a2bd..80cc008058 100644 --- a/site/guide/templates/customize-document-templates.qmd +++ b/site/guide/templates/customize-document-templates.qmd @@ -6,13 +6,13 @@ title: "Customize document templates" date: last-modified aliases: - /guide/customize-documentation-templates.html - - /guide/model-documentation/customize-documentation-templates.html + - /guide/documentation/customize-documentation-templates.html - /guide/templates/customize-documentation-templates.html includes: customize: true --- -Customize templates for document types to fit your specific case-by-case needs, such as type or complexity of model or model use case. +Customize templates for document types to fit your specific case-by-case needs, such as type or complexity of record or record use case. - Templates are versioned and saving a template after making changes or reverting to a previous version state always creates a new version, or you can duplicate templates to create new independent templates in your library. - Document templates are stored as YAML files edited directly using the advanced editor, allowing you full control over the minitua such as desired guidelines. @@ -39,10 +39,10 @@ Check the [document template]{.smallcaps} section[^3] in the right sidebar. ## Configure assessment options[^4] ::: {.callout} -{{< include /guide/model-validation/_assessment-options.qmd >}} +{{< include /guide/validation/_assessment-options.qmd >}} -[Configure assessment options](/guide/model-validation/configure-assessment-options.qmd){.button} +[Configure assessment options](/guide/validation/configure-assessment-options.qmd){.button} ::: @@ -156,7 +156,7 @@ c. Finish editing your template, then save a new version. [^4]: [validation report templates only]{.smallcaps .pink} -[^5]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^5]: [Working with documents](/guide/templates/working-with-documents.qmd) [^6]: [Template schema](#template-schema) diff --git a/site/guide/templates/manage-document-templates.qmd b/site/guide/templates/manage-document-templates.qmd index dd25d3aa8a..da5aee54a7 100644 --- a/site/guide/templates/manage-document-templates.qmd +++ b/site/guide/templates/manage-document-templates.qmd @@ -6,10 +6,10 @@ title: "Manage document templates" date: last-modified aliases: - /guide/swap-documentation-templates.html - - /guide/model-documentation/swap-documentation-templates.html + - /guide/documentation/swap-documentation-templates.html - /guide/templates/swap-documentation-templates.html - /guide/view-documentation-templates.html - - /guide/model-documentation/view-documentation-templates.html + - /guide/documentation/view-documentation-templates.html - /guide/templates/view-documentation-templates.html --- @@ -50,9 +50,9 @@ Switch a document to a completely different template, or apply another version o 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.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] 4. Select the document you want to view the template for: @@ -137,7 +137,7 @@ Delete templates no longer required by your organization: [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^5]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) [^6]: @@ -152,13 +152,13 @@ Delete templates no longer required by your organization: [^7]: [Customize document templates](customize-document-templates.qmd#edit-template-outlines) -[^8]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^8]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) -[^9]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +[^9]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) [^10]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) -[^11]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^11]: [Working with documents](/guide/templates/working-with-documents.qmd) [^12]: diff --git a/site/guide/templates/manage-document-types.qmd b/site/guide/templates/manage-document-types.qmd index 420a6f7ae1..d8def7e441 100644 --- a/site/guide/templates/manage-document-types.qmd +++ b/site/guide/templates/manage-document-types.qmd @@ -8,10 +8,10 @@ date: last-modified Customize the document types available to your organization. Document types have their own configurable and reusable templates. -::: {.callout title="Model documentation, validation report, and ongoing monitoring report document types are provided by default."} +::: {.callout title="Development, Validation, and Monitoring document types are provided by default."} These stock document types cannot be deleted, only edited: -- **Development** — Model documentation +- **Development** — Development documentation, such as model documentation - **Validation** — Validation reports - **Monitoring** — Ongoing monitoring reports @@ -37,16 +37,17 @@ These stock document types cannot be deleted, only edited: 4. Enter in the document type details: - Provide a **[name]{.smallcaps}** and an optional **[description]{.smallcaps}**. - - Toggle whether this document type should be automatically created **[when model is registered]{.smallcaps}**. - - (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] - - (Optional) Select the model stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^5] - + - Toggle whether this document type should be automatically created **[when record is registered]{.smallcaps}**. + - Select the **[inventory record types]{.smallcaps}** that should have access to this document type.[^2] + - (Optional) Under **[default on inventory record types]{.smallcaps}**, select which inventory record types should display this document type by default. + - (Optional) Toggle a **[default template]{.smallcaps}** for this document type.[^3] + - Select the inventory record stakeholder types[^4] that should have **[update document]{.smallcaps}** permissions for this document type.[^5] + - (Optional) Select the inventory record stakeholder types that should have **[update document outline]{.smallcaps}** permissions for this document type.[^6] 5. Click **Create Document Type** to add your document type. ::: {.callout} -Once created, customize the available templates for your document type.[^6] +Once created, customize the available templates for your document type.[^7] ::: @@ -77,9 +78,9 @@ b. When the **{{< fa ellipsis-vertical >}}** appears under the Actions column, c 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. +## Development, Validation, and Monitoring document types are stock types and cannot be deleted. -In order to delete a document type, there must be no models using that document type. +In order to delete a document type, there must be no records using that document type. ::: @@ -89,18 +90,20 @@ In order to delete a document type, there must be no models using that document [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^2]: Select a template to be assigned as default from the drop-down menu. +[^2]: [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) + +[^3]: Select a template to be assigned as default from the drop-down menu. -[^3]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) +[^4]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd) -[^4]: [Manage model documents](manage-model-documents.qmd#edit-model-documents) +[^5]: [Manage documents](manage-documents.qmd#edit-record-documents) -[^5]: +[^6]: - - At least one model stakeholder type must be assigned to **[update document]{.smallcaps}** permissions in order to adjust **[update document outline]{.smallcaps}** permissions. + - At least one inventory record 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) +[^7]: [Customize document templates](customize-document-templates.qmd) diff --git a/site/guide/templates/manage-model-documents.qmd b/site/guide/templates/manage-documents.qmd similarity index 79% rename from site/guide/templates/manage-model-documents.qmd rename to site/guide/templates/manage-documents.qmd index 772e0d7c53..001220bb4a 100644 --- a/site/guide/templates/manage-model-documents.qmd +++ b/site/guide/templates/manage-documents.qmd @@ -2,39 +2,32 @@ # 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: "Manage model documents" +title: "Manage documents" date: last-modified +aliases: + - /guide/templates/manage-model-documents.html --- -Add or delete documents available on individual models in your inventory. - -::: {.callout title="A standard model documentation, validation report, and ongoing monitoring report documents are provided by default."} -These stock document types cannot be deleted, only edited: - -- **Development** — Model documentation -- **Validation** — Validation reports -- **Monitoring** — Ongoing monitoring reports - -::: +Add or delete documents available on individual records in your inventory. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] +- [x] The record you want to manage documents for is registered in the inventory.[^1] - [x] Document types[^2] and document templates[^3] have been set up for use. -- [x] You are assigned a role with sufficient permissions to create or modify documents on models.[^4] +- [x] You are assigned a role with sufficient permissions to create or modify documents on records.[^4] ::: -## Add model documents +## Add record documents 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.[^5] +2. Select a record or find your record by applying a filter or searching for it.[^5] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^6] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^6] 4. Click **{{< fa plus >}} Create Document**. @@ -130,7 +123,7 @@ If a conversion appears to be stuck, click **Cancel** in the conversion progress ::: -## Edit model documents +## Edit record documents ::: {.callout title="Static PDF documents cannot be edited."} You can view static PDF documents within {{< var validmind.platform >}} but you cannot modify their structure or contents.[^14] @@ -139,9 +132,9 @@ You can view static PDF documents within {{< var validmind.platform >}} but you 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.[^15] +2. Select a record or find your record by applying a filter or searching for it.[^15] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^16] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^16] 4. Click on the document file you'd like to edit. @@ -151,30 +144,30 @@ You can view static PDF documents within {{< var validmind.platform >}} but you Use the text editor functions to edit the content of the section. -## Delete model documents +## Delete record documents ::: {.callout-important} -Deletion of documents on models is permanent and cannot be undone. +Deletion of documents on records is permanent and cannot be undone. ::: 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.[^18] +2. Select a record or find your record by applying a filter or searching for it.[^18] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^19] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^19] 4. Hover over the document you want to delete. 5. When the **{{< fa ellipsis-vertical >}}** appears, click on it and select [**{{< fa trash-can >}} Delete**]{.red} to remove the document. -6. Click **Yes, Delete Document** to confirm permanent deletion of that document from the model. +6. Click **Yes, Delete Document** to confirm permanent deletion of that document from the record. ## What's next Learn more about how to work with the default document types within the {{< var validmind.platform >}}: -- [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) -- [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd) +- [Working with documentation](/guide/documentation/working-with-documentation.qmd) +- [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd) - [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd) @@ -190,7 +183,7 @@ Learn more about how to work with the default document types within the {{< var [^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^6]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^6]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) [^7]: A unique document ID will automatically be created from the title. @@ -223,17 +216,17 @@ Learn more about how to work with the default document types within the {{< var -[^14]: [Add model documents](#add-model-documents) +[^14]: [Add record documents](#add-record-documents) [^15]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^16]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^16]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^17]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd) +[^17]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd) [^18]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^19]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^19]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) diff --git a/site/guide/templates/manage-text-block-library.qmd b/site/guide/templates/manage-text-block-library.qmd index 32208ab8cf..b43d1ac6cc 100644 --- a/site/guide/templates/manage-text-block-library.qmd +++ b/site/guide/templates/manage-text-block-library.qmd @@ -26,9 +26,9 @@ To transform an existing text block into a reusable block: 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.[^2] +2. Select a record or find your record by applying a filter or searching for it.[^2] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^3] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^3] 4. Click on the file you'd like to copy a text block from.[^4] @@ -96,11 +96,11 @@ To remove an existing text block from your block library: [^2]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^3]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^3]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^4]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^4]: [Working with documents](/guide/templates/working-with-documents.qmd) -[^5]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#add-content-blocks) +[^5]: [Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#add-content-blocks) [^6]: [Customize document templates](/guide/templates/customize-document-templates.qmd#add-text-blocks-to-templates) diff --git a/site/guide/templates/working-with-document-templates.qmd b/site/guide/templates/working-with-document-templates.qmd index e01f6ec28e..57aed31def 100644 --- a/site/guide/templates/working-with-document-templates.qmd +++ b/site/guide/templates/working-with-document-templates.qmd @@ -15,9 +15,9 @@ listing: - customize-document-templates.qmd - manage-document-templates.qmd aliases: - - /guide/working-with-documentation-templates.html - - /guide/model-documentation/working-with-documentation-templates.html - - /guide/templates/working-with-documentation-templates.html + - /guide/working-with-document-templates.html + - /guide/documentation/working-with-document-templates.html + - /guide/templates/working-with-document-templates.html - /guide/templates/working-with-templates.html --- @@ -30,5 +30,5 @@ aliases: ## What's next -- [Working with model documents](working-with-model-documents.qmd) +- [Working with documents](working-with-documents.qmd) - [Manage text block library](manage-text-block-library.qmd) \ No newline at end of file diff --git a/site/guide/templates/working-with-model-documents.qmd b/site/guide/templates/working-with-documents.qmd similarity index 55% rename from site/guide/templates/working-with-model-documents.qmd rename to site/guide/templates/working-with-documents.qmd index f5da412688..e598a9a236 100644 --- a/site/guide/templates/working-with-model-documents.qmd +++ b/site/guide/templates/working-with-documents.qmd @@ -2,10 +2,10 @@ # 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: "Working with model documents" +title: "Working with documents" date: last-modified listing: - - id: model-documents + - id: documents type: grid grid-columns: 2 max-description-length: 250 @@ -13,13 +13,15 @@ listing: fields: [title, description] contents: - manage-document-types.qmd - - manage-model-documents.qmd + - manage-documents.qmd +aliases: + - /guide/templates/working-with-model-documents.html --- -Set up document types, categories of model-related content, for use on models across your organization, and the regulations and policies that oversee your documents within the {{< var validmind.platform >}}. +Set up document types, categories of record-related content, for use on records across your organization, and the regulations and policies that oversee your documents within the {{< var validmind.platform >}}. -:::{#model-documents} +:::{#documents} :::
    @@ -28,3 +30,4 @@ Set up document types, categories of model-related content, for use on models ac - [Working with document templates](working-with-document-templates.qmd) - [Manage text block library](manage-text-block-library.qmd) +- [Customize {{< var validmind.checker >}}](customize-document-checker.qmd) diff --git a/site/guide/model-validation/_add-artifact-severities.qmd b/site/guide/validation/_add-artifact-severities.qmd similarity index 91% rename from site/guide/model-validation/_add-artifact-severities.qmd rename to site/guide/validation/_add-artifact-severities.qmd index b844dbece9..a09b569fa7 100644 --- a/site/guide/model-validation/_add-artifact-severities.qmd +++ b/site/guide/validation/_add-artifact-severities.qmd @@ -17,7 +17,7 @@ To add additional severities: 1. Click **Add Severity** to create the severity. - Once added, [reorder the severities](/guide/model-validation/manage-artifact-severities.qmd#reorder-artifact-severities) as required. + Once added, [reorder the severities](/guide/validation/manage-artifact-severities.qmd#reorder-artifact-severities) as required. :::: diff --git a/site/guide/validation/_add-artifacts-on-documentation.qmd b/site/guide/validation/_add-artifacts-on-documentation.qmd new file mode 100644 index 0000000000..6018aa579d --- /dev/null +++ b/site/guide/validation/_add-artifacts-on-documentation.qmd @@ -0,0 +1,58 @@ + + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] + +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] + +1. Click on a Development type file.^[[Working with documentation](/guide/documentation/working-with-documentation.qmd#document-overview)] + + + +1. On your record's documentation page, click **{{< fa square-plus >}} Add Artifact**. + +1. Select the artifact type^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] you want to add: + + - Validation Issue + - Policy Exception + - Limitation + +1. On the modal that opens, provide information for your artifact. + +1. When you are done, click **Save** to submit the artifact. + + Once created, you can then add supporting documentation to your artifact.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] + +:::: + +:::: {.content-hidden unless-format="revealjs"} +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +1. Select a record or [find your record by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. + +1. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. + + + +1. On your record's documentation page, click **{{< fa plus >}} Add Artifact**. + +1. Select the [artifact type](/guide/validation/manage-artifact-types.qmd){target="_blank"} you want to add: + + - Validation Issue + - Policy Exception + - Limitation + +1. On the modal that opens, provide information for your artifact. + +1. When you are done, click **Save** to submit the artifact. + + Once created, you can then [add supporting documentation to your artifact](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. + +:::: + + + diff --git a/site/guide/model-validation/_add-edit-artifact-fields.qmd b/site/guide/validation/_add-edit-artifact-fields.qmd similarity index 75% rename from site/guide/model-validation/_add-edit-artifact-fields.qmd rename to site/guide/validation/_add-edit-artifact-fields.qmd index 11c04234cb..8a581a02f2 100644 --- a/site/guide/model-validation/_add-edit-artifact-fields.qmd +++ b/site/guide/validation/_add-edit-artifact-fields.qmd @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> To add a new artifact field, click **{{< fa plus >}} Add Field**: -a. Artifact fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**,^[[Artifact field types](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types)] and indicate what **[artifact types]{.smallcaps}**^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] the field is available on. +a. Artifact fields require you to enter a **[title]{.smallcaps}** (name), select a field **[type]{.smallcaps}**,^[[Artifact field types](/guide/validation/manage-artifact-fields.qmd#artifact-field-types)] and indicate what **[artifact types]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] the field is available on. a. Include optional information for your artifact field: @@ -18,14 +18,14 @@ 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{.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] + - Assign a field to a **[group{.smallcaps}]**.^[Ungrouped fields will be listed under No Group: [Add artifact field groups](/guide/validation/manage-artifact-fields.qmd#add-artifact-field-groups)] + - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by inventory record 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)] +Expand any inventory field group to see more fields.^[[Add artifact field groups](/guide/validation/manage-artifact-fields.qmd#add-artifact-field-groups)] To edit an existing artifact field: @@ -33,7 +33,7 @@ a. Click on the artifact field you want to edit. 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)] + Field keys for artifact fields can be renamed under the **[actions]{.smallcaps}** column.^[[Rename artifact field keys](/guide/validation/manage-artifact-fields.qmd#rename-artifact-field-keys)] ::: @@ -44,7 +44,7 @@ a. Make your desired changes to your artifact field, then click **Save**. ::: {.callout} ## All other users will have read-only access unless specified under the **[write permissions]{.smallcaps}**. - - [**Model Stakeholders**](/guide/configuration/manage-record-stakeholder-types.qmd) — Write permissions on a per model basis. + - [**Record Stakeholders**](/guide/configuration/manage-record-stakeholder-types.qmd) — Write permissions on a per record basis. - [**Application Roles**](/guide/configuration/manage-roles.qmd) — Write permissions on a per field basis across all artifacts. ::: @@ -69,7 +69,7 @@ a. Make your desired changes to your artifact field, then click **Save**. - 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]{.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. + - Assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by inventory record 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/validation/_add-edit-artifact-statuses.qmd similarity index 100% rename from site/guide/model-validation/_add-edit-artifact-statuses.qmd rename to site/guide/validation/_add-edit-artifact-statuses.qmd diff --git a/site/guide/model-validation/_add-edit-artifact-types.qmd b/site/guide/validation/_add-edit-artifact-types.qmd similarity index 65% rename from site/guide/model-validation/_add-edit-artifact-types.qmd rename to site/guide/validation/_add-edit-artifact-types.qmd index 02faa08d61..7f52899cd1 100644 --- a/site/guide/model-validation/_add-edit-artifact-types.qmd +++ b/site/guide/validation/_add-edit-artifact-types.qmd @@ -20,13 +20,13 @@ 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 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 inventory fields](/guide/inventory/edit-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. + - **[record fields display]{.smallcaps}**[^add-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record 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 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. + - **[create artifact]{.smallcaps}** — Inventory record stakeholder types or user roles[^add-permissions] that can create this type of artifact. + - **[update artifact]{.smallcaps}** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. ## Edit artifact types @@ -41,13 +41,13 @@ 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 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 inventory fields](/guide/inventory/edit-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. + - **[record fields display]{.smallcaps}**[^edit-record-fields-config] — Select which upstream record fields^[[Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd)] to display as read-only under the Inventory Record Information section on artifacts of this type and click **Save Record 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 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. + - **[create artifact]{.smallcaps}** — Inventory record stakeholder types or user roles[^edit-permissions] that can create this type of artifact. + - **[update artifact]{.smallcaps}** — Inventory record stakeholder types or user roles that can update existing artifacts of this type. :::: @@ -56,14 +56,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> [^add-fields-callout]: ::: {.callout title="Only default fields are available to be selected in this view."} - To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) + To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) ::: -[^add-model-fields-config]: +[^add-record-fields-config]: - Drag-and-drop fields to reorder them. - - Click **Save Model Fields Configuration** to apply changes. + - Click **Save Record Fields Configuration** to apply changes. [^add-permissions]: @@ -73,14 +73,14 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> [^edit-fields-callout]: ::: {.callout title="Only default fields are available to be selected in this view."} - To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) + To further customize fields displayed on artifact types, refer to: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) ::: -[^edit-model-fields-config]: +[^edit-record-fields-config]: - Drag-and-drop fields to reorder them. - - Click **Save Model Fields Configuration** to apply changes. + - Click **Save Record Fields Configuration** to apply changes. [^edit-permissions]: @@ -104,7 +104,7 @@ d. Click on your newly created artifact type to edit its details and permissions 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. + - For **[record fields display]{.smallcaps}** configuration, click **Save Record Fields Configuration** to apply changes. #### Edit artifact types @@ -115,7 +115,7 @@ b. Make your desired changes to the artifact type's details and permissions. 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. + - For **[record fields display]{.smallcaps}** configuration, click **Save Record Fields Configuration** to apply changes. :::: diff --git a/site/guide/model-validation/_add-risk-areas.qmd b/site/guide/validation/_add-risk-areas.qmd similarity index 93% rename from site/guide/model-validation/_add-risk-areas.qmd rename to site/guide/validation/_add-risk-areas.qmd index e6c662000b..13ab78e8bb 100644 --- a/site/guide/model-validation/_add-risk-areas.qmd +++ b/site/guide/validation/_add-risk-areas.qmd @@ -14,7 +14,7 @@ a. Click **Add Risk Area** to create your risk area. :::: :::: {.content-hidden unless-format="revealjs"} -{{< include /guide/model-validation/_risk-areas.qmd >}} +{{< include /guide/validation/_risk-areas.qmd >}} a. Click **{{< fa plus >}} Add Risk Area**. diff --git a/site/guide/model-validation/_add-validation-guidelines.qmd b/site/guide/validation/_add-validation-guidelines.qmd similarity index 94% rename from site/guide/model-validation/_add-validation-guidelines.qmd rename to site/guide/validation/_add-validation-guidelines.qmd index 5872f0d7d1..6f8e9b9142 100644 --- a/site/guide/model-validation/_add-validation-guidelines.qmd +++ b/site/guide/validation/_add-validation-guidelines.qmd @@ -15,7 +15,7 @@ a. Click **Add Guideline** to insert your guideline to that risk area. :::: :::: {.content-hidden unless-format="revealjs"} -{{< include /guide/model-validation/_validation-guidelines.qmd >}} +{{< include /guide/validation/_validation-guidelines.qmd >}} a. Hover over the risk area you want to add a guideline to. diff --git a/site/guide/model-validation/_artifact-fields.qmd b/site/guide/validation/_artifact-fields.qmd similarity index 74% rename from site/guide/model-validation/_artifact-fields.qmd rename to site/guide/validation/_artifact-fields.qmd index 899a684c61..78337046b7 100644 --- a/site/guide/model-validation/_artifact-fields.qmd +++ b/site/guide/validation/_artifact-fields.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Manage the fields that appear on all artifact types logged on your models. Choose from an array of field types with different properties and use cases. \ No newline at end of file +Manage the fields that appear on all artifact types logged on your records. Choose from an array of field types with different properties and use cases. \ No newline at end of file diff --git a/site/guide/model-validation/_artifact-severities.qmd b/site/guide/validation/_artifact-severities.qmd similarity index 58% rename from site/guide/model-validation/_artifact-severities.qmd rename to site/guide/validation/_artifact-severities.qmd index 12712ac9dd..77d7141751 100644 --- a/site/guide/model-validation/_artifact-severities.qmd +++ b/site/guide/validation/_artifact-severities.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -Configure the severities available to the artifacts logged on models to ensure that they reflect your organization's tracking requirements. \ No newline at end of file +Configure the severities available to the artifacts logged on records to ensure that they reflect your organization's tracking requirements. \ No newline at end of file diff --git a/site/guide/model-validation/_artifact-types.qmd b/site/guide/validation/_artifact-types.qmd similarity index 85% rename from site/guide/model-validation/_artifact-types.qmd rename to site/guide/validation/_artifact-types.qmd index 2f2858aff1..97b9ddf966 100644 --- a/site/guide/model-validation/_artifact-types.qmd +++ b/site/guide/validation/_artifact-types.qmd @@ -3,12 +3,12 @@ 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"} -Prepare to track the progress and resolution of artifacts by customizing artifact types and their associated statuses available to be logged on models in your inventory. +Prepare to track the progress and resolution of artifacts by customizing artifact types and their associated statuses available to be logged on records in your inventory. :::: :::: {.content-hidden unless-format="revealjs"} -Prepare to track the progress and resolution of artifacts by customizing artifact (finding) types and their associated statuses available to be logged on models in your inventory. +Prepare to track the progress and resolution of artifacts by customizing artifact (finding) types and their associated statuses available to be logged on records in your inventory. :::: \ No newline at end of file diff --git a/site/guide/model-validation/_assessment-options.qmd b/site/guide/validation/_assessment-options.qmd similarity index 100% rename from site/guide/model-validation/_assessment-options.qmd rename to site/guide/validation/_assessment-options.qmd diff --git a/site/guide/model-validation/_autogenerate-validation-issues.qmd b/site/guide/validation/_autogenerate-validation-issues.qmd similarity index 86% rename from site/guide/model-validation/_autogenerate-validation-issues.qmd rename to site/guide/validation/_autogenerate-validation-issues.qmd index 36b53d1802..013d19ecf3 100644 --- a/site/guide/model-validation/_autogenerate-validation-issues.qmd +++ b/site/guide/validation/_autogenerate-validation-issues.qmd @@ -10,7 +10,7 @@ Contact your administrator if you don't see the **Suggest Validation Issues** op 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] 1. In the left sidebar, click **Validation** to open the validation report. @@ -23,7 +23,7 @@ Contact your administrator if you don't see the **Suggest Validation Issues** op 1. Review the suggested validation issues: Each suggestion includes: - + - A proposed title describing the issue - A severity level based on the identified gap - Recommended remediation actions @@ -33,7 +33,7 @@ Contact your administrator if you don't see the **Suggest Validation Issues** op - Click **{{< fa check >}} Approve** to create the validation issue and link it to your report. - Click **{{< fa xmark >}} Dismiss** to reject the suggestion if it doesn't apply. -1. After approving a validation issue, you can further customize it by clicking on the issue to edit fields such as owner, due date, and status.^[[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd)] +1. After approving a validation issue, you can further customize it by clicking on the issue to edit fields such as owner, due date, and status.^[[Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd)] ::: {.callout-important title="AI suggestions require review"} Always review AI-generated validation issues before approving them. The suggestions are based on patterns in your risk assessment notes and may need adjustment to accurately reflect your findings. diff --git a/site/guide/model-validation/_link-artifacts-to-reports.qmd b/site/guide/validation/_link-artifacts-to-reports.qmd similarity index 72% rename from site/guide/model-validation/_link-artifacts-to-reports.qmd rename to site/guide/validation/_link-artifacts-to-reports.qmd index d602b98441..d4df471212 100644 --- a/site/guide/model-validation/_link-artifacts-to-reports.qmd +++ b/site/guide/validation/_link-artifacts-to-reports.qmd @@ -5,21 +5,21 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview)] 1. Expand any subsection of the validation report you would like to work with. -1. In any section of the report where the button is available, click **{{< fa link >}} Link Artifact to Report** and select the artifact type^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] you want to add: +1. In any section of the report where the button is available, click **{{< fa link >}} Link Artifact to Report** and select the artifact type^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] you want to add: - Validation Issue - Policy Exception - - Model Limitation + - Limitation -1. On the **Link Artifact to Report** modal that opens, select from the list of available artifacts, or click **{{< fa plus >}} Update Linked Artifacts**.^[[Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports)] +1. On the **Link Artifact to Report** modal that opens, select from the list of available artifacts, or click **{{< fa plus >}} Update Linked Artifacts**.^[[Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports)] 1. Click **Update Linked Artifacts**. @@ -29,15 +29,15 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-hidden unless-format="revealjs"} -1. From the **{{< fa cubes >}} Inventory** in the ValidMind Platform, go to the model you connected to earlier. +1. From the **{{< fa cubes >}} Inventory** in the ValidMind Platform, go to the record you connected to earlier. -1. In the left sidebar that appears for your model, click **Validation** under {{< fa file >}} Documents. +1. In the left sidebar that appears for your record, click **Validation** under {{< fa file >}} Documents. 1. Locate the Data Preparation section and click on **2.2.2. Model Performance** to expand that section. 1. Under the Model Performance Metrics section, locate Artifacts then click **Link Artifact to Report**. -1. Select **Validation Issue** as the [type of artifact](/guide/model-validation/manage-artifact-types.qmd){target="_blank"}. +1. Select **Validation Issue** as the [type of artifact](/guide/validation/manage-artifact-types.qmd){target="_blank"}. 1. Click **{{< fa plus >}} Add Validation Issue** to add a validation issue type artifact. diff --git a/site/guide/model-validation/_link-validator-evidence.qmd b/site/guide/validation/_link-validator-evidence.qmd similarity index 79% rename from site/guide/model-validation/_link-validator-evidence.qmd rename to site/guide/validation/_link-validator-evidence.qmd index 869047e461..fb243d9ae4 100644 --- a/site/guide/model-validation/_link-validator-evidence.qmd +++ b/site/guide/validation/_link-validator-evidence.qmd @@ -9,11 +9,11 @@ To link validator evidence to a report, you must first log tests as a validator 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview)] You can now expand any subsection of the validation report you would like to work with. @@ -32,16 +32,16 @@ To link validator evidence to a report, you must first log tests as a validator :::: {.content-hidden unless-format="revealjs"} -With some test results logged, let's head to the model we connected to at the beginning of this notebook and insert our test results into the validation report as evidence. +With some test results logged, let's head to the record we connected to at the beginning of this notebook and insert our test results into the validation report as evidence. While the example below focuses on a specific test result, you can follow the same general procedure for your other results: ::: {.panel-tabset} ### 1. Link data quality test results -a. From the **{{< fa cubes >}} Inventory** in the {{< var validmind.platform >}}, go to the model you connected to earlier. +a. From the **{{< fa cubes >}} Inventory** in the {{< var validmind.platform >}}, go to the record you connected to earlier. -a. In the left sidebar that appears for your model, click **Validation** under {{< fa file >}} Documents. +a. In the left sidebar that appears for your record, click **Validation** under {{< fa file >}} Documents. a. Locate the Data Preparation section and click on **2.2.1. Data Quality** to expand that section. diff --git a/site/guide/model-validation/_provide-compliance-assessments.qmd b/site/guide/validation/_provide-compliance-assessments.qmd similarity index 68% rename from site/guide/model-validation/_provide-compliance-assessments.qmd rename to site/guide/validation/_provide-compliance-assessments.qmd index 6f9ccc9406..ad5456259d 100644 --- a/site/guide/model-validation/_provide-compliance-assessments.qmd +++ b/site/guide/validation/_provide-compliance-assessments.qmd @@ -4,16 +4,16 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} ::: {.callout title="Assessment options available for selection depend on configuration for individual validation report templates."} -Your organization can customize these options to match its own assessment framework, or choose to remove them from templates entirely.^[[Configure assessment options](/guide/model-validation/configure-assessment-options.qmd)] +Your organization can customize these options to match its own assessment framework, or choose to remove them from templates entirely.^[[Configure assessment options](/guide/validation/configure-assessment-options.qmd)] ::: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)] +1. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.^[[Work with document versions](/guide/documentation/work-with-document-versions.qmd)] -1. Click on a Validation type file.^[[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview)] +1. Click on a Validation type file.^[[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview)] Expand any subsection of the validation report you would like to work with. @@ -21,7 +21,7 @@ Your organization can customize these options to match its own assessment framew Confirm that the compliance summary shown for each subsection provides an accurate overview for current qualitative and quantitative risk assessments. -1. Click under **Risk Assessment Notes** to add your risk assessment notes for that section using the content editing toolbar.^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#content-editing-toolbar)] +1. Click under **Risk Assessment Notes** to add your risk assessment notes for that section using the content editing toolbar.^[[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd#content-editing-toolbar)] :::: @@ -33,7 +33,7 @@ Your organization can customize these options to match its own assessment framew 1. Confirm that the compliance summary shown for each subsection under 2. Validation provides an accurate overview for current qualitative and quantitative risk assessments: - ![Risk assessment compliance summary](/guide/model-validation/assess-compliance-summary.png){fig-alt="A screenshot of the risk assessment compliance summary" .screenshot group="compliance"} + ![Risk assessment compliance summary](/guide/validation/assess-compliance-summary.png){fig-alt="A screenshot of the risk assessment compliance summary" .screenshot group="compliance"} :::: {.pa3 .mt3 .f5 .embed} **Assessment options available for selection depend on configuration for individual validation report templates.** diff --git a/site/guide/model-validation/_reorder-artifact-severities.qmd b/site/guide/validation/_reorder-artifact-severities.qmd similarity index 100% rename from site/guide/model-validation/_reorder-artifact-severities.qmd rename to site/guide/validation/_reorder-artifact-severities.qmd diff --git a/site/guide/model-validation/_risk-areas.qmd b/site/guide/validation/_risk-areas.qmd similarity index 81% rename from site/guide/model-validation/_risk-areas.qmd rename to site/guide/validation/_risk-areas.qmd index 740e24da0d..62ae3cde4b 100644 --- a/site/guide/model-validation/_risk-areas.qmd +++ b/site/guide/validation/_risk-areas.qmd @@ -2,4 +2,4 @@ Refer to the LICENSE file in the root of this repository for details. SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> -A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, model performance, and regulatory compliance are addressed effectively. \ No newline at end of file +A risk area is a specific domain within an organization that requires monitoring and management to ensure factors like data quality, performance, and regulatory compliance are addressed effectively. \ No newline at end of file diff --git a/site/guide/model-validation/_track-artifact-resolution.qmd b/site/guide/validation/_track-artifact-resolution.qmd similarity index 67% rename from site/guide/model-validation/_track-artifact-resolution.qmd rename to site/guide/validation/_track-artifact-resolution.qmd index 0848e7b02b..384082c022 100644 --- a/site/guide/model-validation/_track-artifact-resolution.qmd +++ b/site/guide/validation/_track-artifact-resolution.qmd @@ -7,13 +7,13 @@ As you prepare your validation report, review open or past due artifacts, close 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] ::: {.panel-tabset} #### Track resolution of validation issues -a. In the left sidebar that appears for your model, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues associated with that model. +a. In the left sidebar that appears for your record, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues associated with that record. a. Go through the open validation issues one-by-one: @@ -24,19 +24,19 @@ a. Go through the open validation issues one-by-one: - **If part or all of the validation issue remains to be addressed** — - - Assess if the issue identified by the validation issue prevents the model from being approved. + - Assess if the issue identified by the validation issue prevents the record from being approved. - If a remediation plan is required, enter the details in the **Proposed Remediation Plan** section of the validation issue. a. Track open issues until all validation issues are resolved or a remediation plan is in place for post-approval issues. #### Track resolution of other artifact types -a. In the left sidebar that appears for your model, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types associated with that model. +a. In the left sidebar that appears for your record, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types associated with that record. -a. Select an artifact type^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] for a list of that artifact type: +a. Select an artifact type^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] for a list of that artifact type: - Policy Exception - - Model Limitation + - Limitation a. Go through the open artifacts one-by-one: @@ -47,7 +47,7 @@ a. Go through the open artifacts one-by-one: - **If part or all of the artifact remains to be addressed** — - - Assess if the issue identified by the artifact prevents the model from being approved. + - Assess if the issue identified by the artifact prevents the record from being approved. - Add comments indicating next required steps. a. Track open artifacts until all artifacts are resolved or plans are in place for post-approval issues. @@ -59,11 +59,11 @@ a. Track open artifacts until all artifacts are resolved or plans are in place f :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. #### Track resolution of validation issues -a. In the left sidebar that appears for your model, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues associated with that model. +a. In the left sidebar that appears for your record, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues associated with that record. a. Go through the open validation issues one-by-one: @@ -74,19 +74,19 @@ a. Go through the open validation issues one-by-one: - **If part or all of the validation issue remains to be addressed** — - - Assess if the issue identified by the validation issue prevents the model from being approved. + - Assess if the issue identified by the validation issue prevents the record from being approved. - If a remediation plan is required, enter the details in the **Proposed Remediation Plan** section of the validation issue. a. Track open issues until all validation issues are resolved or a remediation plan is in place for post-approval issues. #### Track resolution of other artifact types -a. In the left sidebar that appears for your model, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types associated with that model. +a. In the left sidebar that appears for your record, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types associated with that record. -a. Select an [artifact type](/guide/model-validation/manage-artifact-types.qmd){target="_blank"} for a list of that artifact type: +a. Select an [artifact type](/guide/validation/manage-artifact-types.qmd){target="_blank"} for a list of that artifact type: - Policy Exception - - Model Limitation + - Limitation a. Go through the open artifacts one-by-one: @@ -97,7 +97,7 @@ a. Go through the open artifacts one-by-one: - **If part or all of the artifact remains to be addressed** — - - Assess if the issue identified by the artifact prevents the model from being approved. + - Assess if the issue identified by the artifact prevents the record from being approved. - Add comments indicating next required steps. a. Track open artifacts until all artifacts are resolved or plans are in place for post-approval issues. diff --git a/site/guide/validation/_validation-guidelines.qmd b/site/guide/validation/_validation-guidelines.qmd new file mode 100644 index 0000000000..8a0d244b36 --- /dev/null +++ b/site/guide/validation/_validation-guidelines.qmd @@ -0,0 +1,5 @@ + + +Validation guidelines ensure that records are accurate, reliable, and fit for their intended purpose by outlining standards for assessing their conceptual soundness, implementation, and performance in compliance with regulatory and internal governance requirements. \ No newline at end of file diff --git a/site/guide/model-validation/_view-all-artifacts.qmd b/site/guide/validation/_view-all-artifacts.qmd similarity index 53% rename from site/guide/model-validation/_view-all-artifacts.qmd rename to site/guide/validation/_view-all-artifacts.qmd index ff0acbd4c4..cd600c0956 100644 --- a/site/guide/model-validation/_view-all-artifacts.qmd +++ b/site/guide/validation/_view-all-artifacts.qmd @@ -7,11 +7,11 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> #### View all validation issues -In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all models: +In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all records: -- Filter this list to include only validation issues you want to see,^[[Filter and sort artifacts](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd)] +- Filter this list to include only validation issues you want to see,^[[Filter and sort artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd)] -- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage attachments on artifacts](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments)] +- Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)] Attachments are listed with the following information: @@ -26,16 +26,16 @@ In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** #### View all other artifacts -1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all models. +1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all records. -1. Select an artifact type^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] to view from the tabs: +1. Select an artifact type^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] to view from the tabs: - Policy Exception - - Model Limitation + - Limitation In the page that opens is a list of all artifacts for that type. - - Filter this list to include only artifacts you want to see,^[[Filter and sort artifacts](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/model-validation/customize-artifact-layouts.qmd)] + - Filter this list to include only artifacts you want to see,^[[Filter and sort artifacts](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts)] or toggle visibilty for column headers.^[[Customize artifact layouts](/guide/validation/customize-artifact-layouts.qmd)] - Click on any artifact for more information. @@ -47,13 +47,13 @@ In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** #### View all validation issues -To view a list of validation issues across all models: +To view a list of validation issues across all records: 1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues**. - [Filter this list](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} to include only validation issues you want to see, or [toggle visibilty for column headers](/guide/model-validation/customize-artifact-layouts.qmd){target="_blank"}. + [Filter this list](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} to include only validation issues you want to see, or [toggle visibilty for column headers](/guide/validation/customize-artifact-layouts.qmd){target="_blank"}. -1. Click on any validation issue for more information, including the proposed remediation plan and [any supporting attachments](/guide/model-validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. +1. Click on any validation issue for more information, including the proposed remediation plan and [any supporting attachments](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}. Attachments are listed with the following information: @@ -68,18 +68,18 @@ To view a list of validation issues across all models: #### View all other artifacts -To view lists of other artifact types across all models: +To view lists of other artifact types across all records: 1. In the left sidebar, click **{{< fa border-all >}} Artifacts**. -1. Select an [artifact type](/guide/model-validation/manage-artifact-types.qmd){target="_blank"} to view from the tabs: +1. Select an [artifact type](/guide/validation/manage-artifact-types.qmd){target="_blank"} to view from the tabs: - Policy Exception - - Model Limitation + - Limitation In the page that opens is a list of all artifacts for that type. - [Filter this list](/guide/model-validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} to include only artifacts you want to see, or [toggle visibilty for column headers](/guide/model-validation/customize-artifact-layouts.qmd){target="_blank"}. + [Filter this list](/guide/validation/view-filter-artifacts.qmd#filter-and-sort-artifacts){target="_blank"} to include only artifacts you want to see, or [toggle visibilty for column headers](/guide/validation/customize-artifact-layouts.qmd){target="_blank"}. 1. Click on any artifact for more information. diff --git a/site/guide/model-validation/add-manage-artifacts.qmd b/site/guide/validation/add-manage-artifacts.qmd similarity index 75% rename from site/guide/model-validation/add-manage-artifacts.qmd rename to site/guide/validation/add-manage-artifacts.qmd index 666b903de6..0e7a43aac7 100644 --- a/site/guide/model-validation/add-manage-artifacts.qmd +++ b/site/guide/validation/add-manage-artifacts.qmd @@ -7,9 +7,10 @@ date: last-modified aliases: - add-update-model-findings.html - add-manage-model-findings.html + - /guide/model-validation/add-manage-artifacts.html --- -Add artifacts at the model or documentation section level, update your artifacts to include proposed remediation plans and supporting documentation, or delete artifacts that no longer need to be tracked. +Add artifacts at the record or documentation section level, update your artifacts to include proposed remediation plans and supporting documentation, or delete artifacts that no longer need to be tracked. {{< include /guide/inventory/_reference-field-values.qmd >}} @@ -18,8 +19,8 @@ Add artifacts at the model or documentation section level, update your artifacts ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] -- [x] Model documentation is completed or in progress for your model.[^2] +- [x] The record you want to add or manage artifacts for is registered in the inventory.[^1] +- [x] Development documentation is completed or in progress for your record.[^2] - [x] Artifact statuses have been set up for use with artifacts.[^3] - [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] @@ -31,13 +32,13 @@ Add artifacts at the model or documentation section level, update your artifacts ## Add artifacts on validation reports -When linking artifacts to validation reports,[^5] you can add artifacts as you assess a model's compliance: +When linking artifacts to validation reports,[^5] you can add artifacts as you assess a record's compliance: 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.[^6] +2. Select a record or find your record by applying a filter or searching for it.[^6] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] 4. Click on a Validation type file.[^8] @@ -45,7 +46,7 @@ When linking artifacts to validation reports,[^5] you can add artifacts as you a - Validation Issue - Policy Exception - - Model Limitation + - Limitation 6. On the Link Artifact to Report modal that opens, click **{{< fa plus >}} Add {Artifact Type}**. @@ -55,7 +56,7 @@ When linking artifacts to validation reports,[^5] you can add artifacts as you a ## Update artifacts -As artifacts get resolved or require other changes during the model validation process, you can update them: +As artifacts get resolved or require other changes during the validation process, you can update them: 1. Locate the artifact you want to update.[^10] @@ -118,19 +119,19 @@ If you logged an artifact in error or otherwise no longer need to track that art [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^2]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^3]: [Manage artifact types](manage-artifact-types.qmd#manage-artifact-type-statuses) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Link artifacts to reports](/guide/model-validation/assess-compliance.qmd#link-artifacts-to-reports) +[^5]: [Link artifacts to reports](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) [^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^7]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview) +[^8]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview) [^9]: [Manage artifact types](manage-artifact-types.qmd) @@ -138,7 +139,7 @@ If you logged an artifact in error or otherwise no longer need to track that art [^11]: [View record activity](/guide/inventory/view-record-activity.qmd) -[^12]: [Link artifacts to reports](/guide/model-validation/assess-compliance.qmd#link-artifacts-to-reports) +[^12]: [Link artifacts to reports](/guide/validation/assess-compliance.qmd#link-artifacts-to-reports) [^13]: [View and filter artifacts](view-filter-artifacts.qmd) diff --git a/site/guide/model-validation/assess-compliance-summary.png b/site/guide/validation/assess-compliance-summary.png similarity index 100% rename from site/guide/model-validation/assess-compliance-summary.png rename to site/guide/validation/assess-compliance-summary.png diff --git a/site/guide/model-validation/assess-compliance.qmd b/site/guide/validation/assess-compliance.qmd similarity index 70% rename from site/guide/model-validation/assess-compliance.qmd rename to site/guide/validation/assess-compliance.qmd index b139f5d89e..e87cb793d1 100644 --- a/site/guide/model-validation/assess-compliance.qmd +++ b/site/guide/validation/assess-compliance.qmd @@ -6,9 +6,10 @@ title: "Assess compliance" date: last-modified aliases: - /guide/assess-compliance.html + - /guide/model-validation/assess-compliance.html --- -Use the {{< var validmind.platform >}} to assess compliance of your models with guidelines based on analyzing evidence and artifacts. +Use the {{< var validmind.platform >}} to assess compliance of your records with guidelines based on analyzing evidence and artifacts. Compliance assessments provide an unbiased starting point that enables more efficient discussions between validators and developers and involves the following steps: @@ -26,8 +27,8 @@ You can only assess compliance within PDFs converted to editable documents,[^1] ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are validating is registered in the model inventory.[^2] -- [x] A model developer has submitted their model documentation for validation.[^3] +- [x] The record you are validating is registered in the inventory.[^2] +- [x] Documentation has been submitted to you for validation.[^3] - [x] Assessment options have been configured for the validation report template if required by your organization.[^4] - [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^5] @@ -35,25 +36,30 @@ You can only assess compliance within PDFs converted to editable documents,[^1] ## Link evidence to reports +::: {.callout title="Stuck on where to start?"} +Use {{< var vm.product >}}'s AI-assisted tools to automate mapping and assessing evidence.[^6] + +::: + ### Link developer evidence To link evidence logged by developers^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] to your validation report: 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.[^6] +2. Select a record or find your record by applying a filter or searching for it.[^7] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^7] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^8] -4. Click on a Validation type file.[^8] +4. Click on a Validation type file.[^9] Expand any subsection of the validation report you would like to work with. -5. In any section of the report where the button is available, click **{{< fa link >}} Link Developer Evidence**. +5. In any section of the report where the button is available, click **{{< fa link >}} Link Developer Evidence**. -6. On the **Link Developer Evidence to Validation Document** page that opens, select the evidence that is related to your assessment. - - - Available evidence is associated with the relevant documentation section. +6. On the **Link Developer Evidence to Validation Document** page that opens, select the evidence that is related to your assessment. + + - Available evidence is associated with the relevant documentation section. - If you are not sure if something is relevant, you can expand the section by clicking **{{< fa chevron-down >}}** for more details. 7. Click **Update Linked Evidence**. @@ -80,18 +86,20 @@ To link evidence logged by developers^[[{{< var validmind.developer >}}](/develo -[^1]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^1]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^3]: [Submit for approval](/guide/model-documentation/submit-for-approval.qmd) +[^3]: [Submit for approval](/guide/documentation/submit-documents.qmd) -[^4]: [Configure assessment options](/guide/model-validation/configure-assessment-options.qmd) +[^4]: [Configure assessment options](/guide/validation/configure-assessment-options.qmd) [^5]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^6]: [Map and assess evidence](map-and-assess-evidence.qmd) + +[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^8]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^8]: [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd#validation-overview) +[^9]: [Preparing validation reports](/guide/validation/preparing-validation-reports.qmd#validation-overview) diff --git a/site/guide/model-validation/assess-evidence-panel.png b/site/guide/validation/assess-evidence-panel.png similarity index 100% rename from site/guide/model-validation/assess-evidence-panel.png rename to site/guide/validation/assess-evidence-panel.png diff --git a/site/guide/model-validation/configure-assessment-options.qmd b/site/guide/validation/configure-assessment-options.qmd similarity index 97% rename from site/guide/model-validation/configure-assessment-options.qmd rename to site/guide/validation/configure-assessment-options.qmd index 6684b4a7f5..bd0bce9097 100644 --- a/site/guide/model-validation/configure-assessment-options.qmd +++ b/site/guide/validation/configure-assessment-options.qmd @@ -4,6 +4,8 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Configure assessment options" date: last-modified +aliases: + - /guide/model-validation/configure-assessment-options.html --- {{< include _assessment-options.qmd >}} diff --git a/site/guide/model-validation/customize-artifact-layouts.qmd b/site/guide/validation/customize-artifact-layouts.qmd similarity index 84% rename from site/guide/model-validation/customize-artifact-layouts.qmd rename to site/guide/validation/customize-artifact-layouts.qmd index e951af0cb8..47ac87c566 100644 --- a/site/guide/model-validation/customize-artifact-layouts.qmd +++ b/site/guide/validation/customize-artifact-layouts.qmd @@ -6,6 +6,7 @@ title: "Customize artifact layouts" date: last-modified aliases: - customize-model-findings-layouts.qmd + - /guide/model-validation/customize-artifact-layouts.html --- Configure the information that displays by default on the list of all tracked artifacts for each artifact type. @@ -15,8 +16,8 @@ Configure the information that displays by default on the list of all tracked ar ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] -- [x] There are artifacts logged on any model.[^2] +- [x] There are records registered in the inventory.[^1] +- [x] There are artifacts logged on any record.[^2] ::: @@ -32,7 +33,7 @@ Customize what is displayed on your list of all artifacts for each artifact type #### Customize layout for validation issues -1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all models: +1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all records: 2. Click **{{< fa table >}} Manage Columns**. @@ -44,12 +45,12 @@ Once customized, you can save a view for later application.[^4] #### Customize layout for all other artifact types -1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all models. +1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all records. 2. Select an artifact type[^5] to view from the tabs: - Policy Exception - - Model Limitation + - Limitation In the page that opens is a list of all artifacts for that type. @@ -92,7 +93,7 @@ Deletion of saved views is permanent. To modify a saved validation issues view: -1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** for a list of validation issues across all models. +1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** for a list of validation issues across all records. {{< include /guide/inventory/_remove-layout-view.qmd >}} @@ -100,10 +101,10 @@ To modify a saved validation issues view: To modify a saved view for all other artifact types: -1. In the left sidebar, click **{{< fa border-all >}} Artifacts** for lists of other artifact types across all models, then select an artifact type[^9] for a list of that artifact type: +1. In the left sidebar, click **{{< fa border-all >}} Artifacts** for lists of other artifact types across all records, then select an artifact type[^9] for a list of that artifact type: - Policy Exception - - Model Limitation + - Limitation {{< include /guide/inventory/_remove-layout-view.qmd >}} @@ -120,7 +121,7 @@ To modify a saved view for all other artifact types: [^4]: [Manage custom artifact views](#manage-custom-artifact-views) -[^5]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^5]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) [^6]: [Manage artifact fields](manage-artifact-fields.qmd) @@ -128,4 +129,4 @@ To modify a saved view for all other artifact types: [^8]: [Filter and sort artifacts](view-filter-artifacts.qmd#filter-and-sort-artifacts) -[^9]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^9]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) diff --git a/site/guide/model-validation/customize-artifact-overview-page.qmd b/site/guide/validation/customize-artifact-overview-page.qmd similarity index 79% rename from site/guide/model-validation/customize-artifact-overview-page.qmd rename to site/guide/validation/customize-artifact-overview-page.qmd index bf75d10b68..1d5a5d507b 100644 --- a/site/guide/model-validation/customize-artifact-overview-page.qmd +++ b/site/guide/validation/customize-artifact-overview-page.qmd @@ -4,11 +4,12 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Customize artifact overview page" date: last-modified -aliases: +aliases: - customize-finding-overview-page.html + - /guide/model-validation/customize-artifact-overview-page.html --- -Configure what and how artifact fields appear when you pull up artifacts logged on models. +Configure what and how artifact fields appear when you pull up artifacts logged on records. :::{.callout title="Changes are automatically saved to your account and do not affect other users."} Customizations will apply to all artifacts in your inventory. @@ -20,8 +21,8 @@ Customizations will apply to all artifacts in your inventory. ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^1] -- [x] There are artifacts logged on models.[^2] +- [x] There are records registered in the inventory.[^1] +- [x] There are artifacts logged on records.[^2] ::: @@ -31,7 +32,7 @@ Customizations will apply to all artifacts in your inventory. Default fields will always appear on your artifact overview pages and are represented by by faded cells. Their positions cannot be adjusted. ::: -1. Open an artifact logged on any model.[^3] +1. Open an artifact logged on any record.[^3] 2. Click on **{{< fa wrench >}} Customize Layout**. @@ -42,7 +43,7 @@ Default fields will always appear on your artifact overview pages and are repres To narrow down your list of fields, search via the **{{< fa filter >}} Filter** bar. -4. Click **Save Layout** to apply your changes to all model overview pages. +4. Click **Save Layout** to apply your changes to all record overview pages. @@ -53,4 +54,4 @@ Default fields will always appear on your artifact overview pages and are repres [^3]: [View and filter artifacts](view-filter-artifacts.qmd) -[^4]: [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types) +[^4]: [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd#artifact-field-types) diff --git a/site/guide/model-validation/link-evidence.png b/site/guide/validation/link-evidence.png similarity index 100% rename from site/guide/model-validation/link-evidence.png rename to site/guide/validation/link-evidence.png diff --git a/site/guide/model-validation/manage-artifact-fields.qmd b/site/guide/validation/manage-artifact-fields.qmd similarity index 93% rename from site/guide/model-validation/manage-artifact-fields.qmd rename to site/guide/validation/manage-artifact-fields.qmd index 398805b261..dd9f290c76 100644 --- a/site/guide/model-validation/manage-artifact-fields.qmd +++ b/site/guide/validation/manage-artifact-fields.qmd @@ -6,11 +6,12 @@ title: "Manage artifact fields" date: last-modified aliases: - manage-model-finding-fields.html + - /guide/model-validation/manage-artifact-fields.html includes: artifacts: true --- -{{< include /guide/model-validation/_artifact-fields.qmd >}} +{{< include /guide/validation/_artifact-fields.qmd >}} ::: {.attn} @@ -62,7 +63,7 @@ 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 artifact creation. - **[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] + - **[write permissions]{.smallcaps}** — Which inventory record stakeholder types have permissions to edit this field.[^7] b. Click **Apply Filters** to narrow down your results by your configured criteria. @@ -82,7 +83,7 @@ For example, if you first search by keyword for `Regression` under **Title** wit Here you can edit existing artifact fields, or add a new one: -{{< include /guide/model-validation/_add-edit-artifact-fields.qmd >}} +{{< include /guide/validation/_add-edit-artifact-fields.qmd >}} ### Rename artifact field keys diff --git a/site/guide/model-validation/manage-artifact-severities.qmd b/site/guide/validation/manage-artifact-severities.qmd similarity index 87% rename from site/guide/model-validation/manage-artifact-severities.qmd rename to site/guide/validation/manage-artifact-severities.qmd index 5d21938ab5..bba73efccd 100644 --- a/site/guide/model-validation/manage-artifact-severities.qmd +++ b/site/guide/validation/manage-artifact-severities.qmd @@ -6,9 +6,10 @@ title: "Manage artifact severities" date: last-modified aliases: - manage-finding-severities.html + - /guide/model-validation/manage-artifact-severities.html --- -{{< include /guide/model-validation/_artifact-severities.qmd >}} +{{< include /guide/validation/_artifact-severities.qmd >}} ::: {.attn} @@ -21,7 +22,7 @@ aliases: ## Add artifact severities -{{< include /guide/model-validation/_add-artifact-severities.qmd >}} +{{< include /guide/validation/_add-artifact-severities.qmd >}} ## Edit artifact severities @@ -40,7 +41,7 @@ aliases: ## Reorder artifact severities -{{< include /guide/model-validation/_reorder-artifact-severities.qmd >}} +{{< include /guide/validation/_reorder-artifact-severities.qmd >}} ## Remove artifact severities diff --git a/site/guide/model-validation/manage-artifact-types.qmd b/site/guide/validation/manage-artifact-types.qmd similarity index 76% rename from site/guide/model-validation/manage-artifact-types.qmd rename to site/guide/validation/manage-artifact-types.qmd index a5ac2e9fe9..f7ad85c26f 100644 --- a/site/guide/model-validation/manage-artifact-types.qmd +++ b/site/guide/validation/manage-artifact-types.qmd @@ -7,22 +7,23 @@ date: last-modified aliases: - manage-finding-statuses.html - manage-finding-types.html + - /guide/model-validation/manage-artifact-types.html --- -{{< include /guide/model-validation/_artifact-types.qmd >}} +{{< include /guide/validation/_artifact-types.qmd >}} #### Artifact types By default, the {{< var validmind.platform >}} provides three artifact types: Validation Issue -: Problems discovered during model validation that reflect errors, inconsistencies, or gaps in data, methodology, implementation, or documentation that need to be addressed before the model is considered reliable. +: Problems discovered during record validation that reflect errors, inconsistencies, or gaps in data, methodology, implementation, or documentation that need to be addressed before the record is considered reliable. Policy Exception -: When a model or part of its development or usage does not comply with internal policies, regulatory requirements, or governance standards, but an explicit approval or waiver is granted to allow it under controlled conditions. +: When a record or part of its development or usage does not comply with internal policies, regulatory requirements, or governance standards, but an explicit approval or waiver is granted to allow it under controlled conditions. -Model Limitation -: Inherent weaknesses or constraints of the model itself that cannot be fully resolved; definitions under which the model's results should be interpreted with caution. +Limitation +: Inherent weaknesses or constraints of the record itself that cannot be fully resolved; definitions under which the record's results should be interpreted with caution.
    @@ -33,13 +34,13 @@ Model Limitation Yes, you can create custom artifact types to track categories of observations beyond the defaults. Common examples include: Change management -: Track requested changes to models, their approval status, and implementation timeline. Useful when model updates require formal change control processes. +: Track requested changes to records, their approval status, and implementation timeline. Useful when record updates require formal change control processes. Audit findings : Capture observations from internal or external audits that require follow-up. Separating these from validation issues helps distinguish regulatory audit trails from routine validation work. Enhancement requests -: Log suggested improvements that don't rise to the level of a validation issue. Helps capture ideas for future model iterations without cluttering the validation issue backlog. +: Log suggested improvements that don't rise to the level of a validation issue. Helps capture ideas for future record iterations without cluttering the validation issue backlog. Custom artifact types support the same features as default types, including statuses, fields, permissions, workflow triggers, and analytics exports. @@ -55,7 +56,7 @@ Custom artifact types support the same features as default types, including stat ::: -{{< include /guide/model-validation/_add-edit-artifact-types.qmd >}} +{{< include /guide/validation/_add-edit-artifact-types.qmd >}} ## Manage artifact type statuses @@ -70,7 +71,7 @@ Custom artifact types support the same features as default types, including stat 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. -{{< include /guide/model-validation/_add-edit-artifact-statuses.qmd >}} +{{< include /guide/validation/_add-edit-artifact-statuses.qmd >}} ## Archive and delete artifact types diff --git a/site/guide/model-validation/manage-validation-guidelines.qmd b/site/guide/validation/manage-validation-guidelines.qmd similarity index 94% rename from site/guide/model-validation/manage-validation-guidelines.qmd rename to site/guide/validation/manage-validation-guidelines.qmd index e287064d37..aba8522672 100644 --- a/site/guide/model-validation/manage-validation-guidelines.qmd +++ b/site/guide/validation/manage-validation-guidelines.qmd @@ -7,6 +7,7 @@ date: last-modified aliases: - view-validation-guidelines.html - /guide/view-validation-guidelines.html + - /guide/model-validation/manage-validation-guidelines.html --- Edit the guidelines for validation reports to align them with organization's requirements, and add the guidelines to your report templates to ensure that they are ready for use. @@ -38,7 +39,7 @@ To set up validation guidelines, you'll need to complete these two steps in sequ ### Manage risk areas -{{< include /guide/model-validation/_risk-areas.qmd >}} +{{< include /guide/validation/_risk-areas.qmd >}} 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -48,7 +49,7 @@ To set up validation guidelines, you'll need to complete these two steps in sequ #### Add risk areas -{{< include /guide/model-validation/_add-risk-areas.qmd >}} +{{< include /guide/validation/_add-risk-areas.qmd >}} #### Edit risk areas @@ -76,7 +77,7 @@ c. Click **Yes, Delete Risk Area** to confirm permanent deletion of that risk ar ### Manage guidelines -{{< include /guide/model-validation/_validation-guidelines.qmd >}} +{{< include /guide/validation/_validation-guidelines.qmd >}} 1. In the left sidebar, click **{{< fa gear >}} Settings**. @@ -86,7 +87,7 @@ c. Click **Yes, Delete Risk Area** to confirm permanent deletion of that risk ar #### Add guidelines -{{< include /guide/model-validation/_add-validation-guidelines.qmd >}} +{{< include /guide/validation/_add-validation-guidelines.qmd >}} #### Edit guidelines diff --git a/site/guide/model-validation/managing-model-validation.qmd b/site/guide/validation/managing-validation.qmd similarity index 92% rename from site/guide/model-validation/managing-model-validation.qmd rename to site/guide/validation/managing-validation.qmd index 461f1b388e..c42a5853b0 100644 --- a/site/guide/model-validation/managing-model-validation.qmd +++ b/site/guide/validation/managing-validation.qmd @@ -2,7 +2,7 @@ # 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: "Managing model validation" +title: "Managing validation" date: last-modified listing: - id: validation-reports @@ -24,6 +24,8 @@ listing: - manage-artifact-types.qmd - manage-artifact-severities.qmd - manage-artifact-fields.qmd +aliases: + - /guide/model-validation/managing-model-validation.html --- Enable your organization to use the {{< var validmind.platform >}} for validation by setting up guidelines and assessment options for validation reports, and configuring options for artifacts to align with your organization's requirements. diff --git a/site/guide/model-validation/map-and-assess-evidence.qmd b/site/guide/validation/map-and-assess-evidence.qmd similarity index 76% rename from site/guide/model-validation/map-and-assess-evidence.qmd rename to site/guide/validation/map-and-assess-evidence.qmd index ad342f8aa8..964b05fc7e 100644 --- a/site/guide/model-validation/map-and-assess-evidence.qmd +++ b/site/guide/validation/map-and-assess-evidence.qmd @@ -4,26 +4,17 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Map and assess evidence" date: last-modified -listing: - - id: whats-next - type: grid - grid-columns: 2 - max-description-length: 250 - sort: false - fields: [title, description] - contents: - - assess-compliance.qmd --- -Use AI-assisted tools to map relevant evidence to validation guidelines and generate compliance assessments based on linked evidence. These features streamline the validation workflow by reducing manual effort while maintaining quality. +Use {{< var vm.product >}}'s AI-assisted tools to streamline your validation workflow by automatically mapping relevant evidence to validation guidelines and drafting compliance assessments based on linked evidence. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are validating is registered in the model inventory.[^1] -- [x] A model developer has submitted their model documentation for validation.[^2] +- [x] The record you are validating is registered in the inventory.[^1] +- [x] Documentation has been submitted to you for validation.[^2] - [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions.[^3] ::: @@ -32,10 +23,10 @@ Use AI-assisted tools to map relevant evidence to validation guidelines and gene Validation reports require you to link supporting evidence to each guideline and write compliance assessments, a process that can be time-consuming when done manually across dozens of guidelines. -Map evidence +Map Evidence : Scans all available evidence from developers and validators, then suggests which items are relevant to each guideline. Instead of searching through evidence blocks yourself, you review AI-suggested matches and approve the ones that apply. Each suggestion includes a relevance score and explanation so you can make informed decisions. -Assess evidence +Assess Evidence : Analyzes the linked evidence for a guideline and drafts a structured compliance assessment. The generated assessment includes a compliance conclusion, specific observations about gaps or issues, and a technical review of what the evidence demonstrates. You review and approve the draft, and then make edits if needed — saving time while maintaining control over the final content. Both features are designed to accelerate validation without replacing your judgment. You always review and approve suggestions before they become part of the report. @@ -50,20 +41,22 @@ Map Evidence uses AI to suggest relevant evidence for each validation guideline, 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select the model you are validating.[^4] +2. Select a record or find your record by applying a filter or searching for it.[^4] -3. In the left sidebar, click **Validation** to open the validation report. +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^5] -4. Navigate to a section and expand the **Evidence** panel. +4. Click on a Validation type file.[^6] -5. Click **{{< fa wand-magic-sparkles >}} Map Evidence**. +5. Navigate to a section and expand the **Evidence** panel. -6. Configure the mapping options: +6. Click **{{< fa wand-magic-sparkles >}} Map Evidence**. + +7. Configure the mapping options: - Toggle **Developer Evidence** to include evidence logged via the {{< var validmind.developer >}}. - Toggle **Validator Evidence** to include evidence uploaded or created by validators. - Adjust the **Relevance Threshold** slider — lower values return more results while higher values show only the most relevant matches. -7. Click **Map Evidence** to run the AI mapping. +8. Click **Map Evidence** to run the AI mapping. The panel displays how many evidence items are available to review for each guideline in the section. @@ -71,7 +64,9 @@ Map Evidence uses AI to suggest relevant evidence for each validation guideline, After running Map Evidence, you can review and approve suggestions at three levels: -**For the entire report:** +::: {.panel-tabset} + +#### For the entire report 1. Open the validation report and look at the right sidebar. @@ -81,7 +76,7 @@ After running Map Evidence, you can review and approve suggestions at three leve 4. To re-run mapping with different settings, click **Remap Evidence**. This lets you adjust the relevance threshold or change which evidence types to include, then generate new suggestions. -**For an entire section:** +#### For an entire section 1. Navigate to a specific section in the validation report. @@ -91,7 +86,7 @@ After running Map Evidence, you can review and approve suggestions at three leve 4. To re-run mapping with different settings, click **Remap Evidence**. -**For individual guidelines:** +#### For individual guidelines 1. Navigate to a specific section in the validation report. @@ -110,6 +105,8 @@ After running Map Evidence, you can review and approve suggestions at three leve Approved evidence appears in the Evidence panel for that guideline, organized by evidence type (Developer Evidence or Validator Evidence). +::: + ## Assess evidence for compliance :::: {.column-margin} @@ -118,18 +115,26 @@ Approved evidence appears in the Evidence panel for that guideline, organized by Assess Evidence analyzes the linked evidence and generates a structured compliance assessment, identifying potential risks and compliance gaps. -1. Navigate to a section that has linked evidence. +1. In the left sidebar, click **{{< fa cubes >}} Inventory**. + +2. Select a record or find your record by applying a filter or searching for it.[^7] + +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^8] + +4. Click on a Validation type file.[^9] + +5. Navigate to a section that has linked evidence. -2. Expand the **Evidence** panel. +6. Expand the **Evidence** panel. -3. Click **{{< fa wand-magic-sparkles >}} Assess Evidence**. +7. Click **{{< fa wand-magic-sparkles >}} Assess Evidence**. -4. The AI analyzes the linked evidence and generates an **Evidence Assessment** containing: +8. The AI analyzes the linked evidence and generates an **Evidence Assessment** containing: - **Guideline Assessment** — A compliance conclusion indicating whether the guideline requirements are fully met, partially met, or not met, with an explanation of the evidence quality. - + - **Validation Observations** — Specific findings about gaps or issues in the evidence, with each observation covering a single concern and suggesting actions for developers. - + - **Evidence Review** — A detailed analysis of what the evidence demonstrates, including references to specific test outputs, documentation, and any limitations. The panel displays how many assessments are available to review. @@ -138,7 +143,9 @@ Assess Evidence analyzes the linked evidence and generates a structured complian After running Assess Evidence, you can review and approve assessments at three levels: -**For the entire report:** +::: {.panel-tabset} + +#### For the entire report 1. Open the validation report and look at the right sidebar. @@ -146,7 +153,7 @@ After running Assess Evidence, you can review and approve assessments at three l 3. Use **Approve All** to accept all generated assessments, or **Reject All** to dismiss all assessments. -**For an entire section:** +#### For an entire section 1. Navigate to a specific section in the validation report. @@ -156,7 +163,7 @@ After running Assess Evidence, you can review and approve assessments at three l 4. To regenerate assessments with updated evidence, click **Re-assess Evidence**. -**For individual guidelines:** +#### For individual guidelines 1. Navigate to a specific section in the validation report. @@ -170,9 +177,6 @@ After running Assess Evidence, you can review and approve assessments at three l 6. To regenerate an assessment, click **{{< fa wand-magic-sparkles >}} Reassess Evidence** to run the AI analysis again with any updated evidence. -## What's next - -:::{#whats-next} ::: @@ -180,8 +184,18 @@ After running Assess Evidence, you can review and approve assessments at three l [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Submit for approval](/guide/model-documentation/submit-for-approval.qmd) +[^2]: [Submit for approval](/guide/documentation/submit-documents.qmd) [^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) [^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^5]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) + +[^6]: [Preparing validation reports](preparing-validation-reports.qmd#validation-overview) + +[^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^8]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) + +[^9]: [Preparing validation reports](preparing-validation-reports.qmd#validation-overview) \ No newline at end of file diff --git a/site/guide/model-validation/map-evidence-panel.png b/site/guide/validation/map-evidence-panel.png similarity index 100% rename from site/guide/model-validation/map-evidence-panel.png rename to site/guide/validation/map-evidence-panel.png diff --git a/site/guide/model-validation/preparing-validation-reports.qmd b/site/guide/validation/preparing-validation-reports.qmd similarity index 71% rename from site/guide/model-validation/preparing-validation-reports.qmd rename to site/guide/validation/preparing-validation-reports.qmd index ead792d2fc..df1dc864ee 100644 --- a/site/guide/model-validation/preparing-validation-reports.qmd +++ b/site/guide/validation/preparing-validation-reports.qmd @@ -7,15 +7,16 @@ date: last-modified listing: - id: draft-reports type: grid - grid-columns: 2 + grid-columns: 3 max-description-length: 250 sort: false fields: [title, description] contents: - - review-model-documentation.qmd + - review-documentation.qmd + - map-and-assess-evidence.qmd - assess-compliance.qmd - - ../model-documentation/work-with-content-blocks.qmd - - ../model-documentation/work-with-document-versions.qmd + - ../documentation/work-with-content-blocks.qmd + - ../documentation/work-with-document-versions.qmd - id: complete-reports type: grid grid-columns: 3 @@ -23,11 +24,12 @@ listing: sort: false fields: [title, description] contents: - - ../model-documentation/check-documents-for-compliance.qmd - - ../model-documentation/collaborate-with-others.qmd - - ../model-documentation/submit-for-approval.qmd + - ../documentation/check-documents-for-compliance.qmd + - ../documentation/collaborate-with-others.qmd + - ../documentation/submit-documents.qmd aliases: - /guide/preparing-validation-reports.html + - /guide/model-validation/preparing-validation-reports.html --- Use the {{< var validmind.platform >}} to prepare detailed validation reports in adherence with your organization's guidelines. Link evidence and artifacts to your reports and assess compliance status at a granular level. @@ -37,10 +39,10 @@ Use the {{< var validmind.platform >}} to prepare detailed validation reports in ## Prerequisites - [x] {{< var link.login >}} -- [x] The model you are validating is registered in the model inventory.[^1] -- [x] A model developer has submitted their model documentation for validation.[^2] +- [x] The record you are validating is registered in the inventory.[^1] +- [x] Documentation has been submitted to you for validation.[^2] - [x] Validation guidelines are aligned with your organization's requirements and added to the correct validation templates.[^3] -- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] +- [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] ::: @@ -82,13 +84,13 @@ Use the {{< var validmind.platform >}} to prepare detailed validation reports in Only PDFs converted to editable documents,[^5] reports generated by the {{< var validmind.developer >}}, or reports created in the {{< var validmind.platform >}} include a Validation Overview. ::: -The **Validation Overview** shows a section-by-section outline of your model's validation report, as well as summary of overall compliance.[^6] +The **Validation Overview** shows a section-by-section outline of your record's validation report, as well as summary of overall compliance.[^6] 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.[^7] +2. Select a record or find your record by applying a filter or searching for it.[^7] -3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.[^8] +3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** or **Saved Versions** tab.[^8] 4. Click on a Validation type file.[^9] @@ -119,11 +121,14 @@ Compliance assessments and linking evidence and artifacts are both saved automat ## Prepare validation reports -Complete your validation report by reviewing submitted model documentation and assessing compliance: +Draft your validation report by reviewing submitted documentation, linking evidence and artifacts, and assessing compliance: :::{#draft-reports} ::: +:::{#edit-reports} +::: + Wrap up your report, collaborate with other stakeholders, and submit your work for approval: :::{#complete-reports} @@ -138,29 +143,29 @@ Wrap up your report, collaborate with other stakeholders, and submit your work f [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd) +[^2]: [Working with documentation](/guide/documentation/working-with-documentation.qmd) [^3]: [Manage validation guidelines](manage-validation-guidelines.qmd) [^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^5]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) -[^6]: [Assess compliance](/guide/model-validation/assess-compliance.qmd) +[^6]: [Assess compliance](/guide/validation/assess-compliance.qmd) [^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^8]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^8]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^9]: [Working with model documents](/guide/templates/working-with-model-documents.qmd) +[^9]: [Working with documents](/guide/templates/working-with-documents.qmd) -[^10]: [Manage model documents](/guide/templates/manage-model-documents.qmd#add-model-documents) +[^10]: [Manage documents](/guide/templates/manage-documents.qmd#add-record-documents) -[^11]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd) +[^11]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd) -[^12]: [Manage validation guidelines](/guide/model-validation/manage-validation-guidelines.qmd) +[^12]: [Manage validation guidelines](/guide/validation/manage-validation-guidelines.qmd) [^13]: [View record activity](/guide/inventory/view-record-activity.qmd) -[^14]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd) +[^14]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd) diff --git a/site/guide/model-validation/review-model-documentation.qmd b/site/guide/validation/review-documentation.qmd similarity index 57% rename from site/guide/model-validation/review-model-documentation.qmd rename to site/guide/validation/review-documentation.qmd index c74bd4ea5d..f9a0b5b88c 100644 --- a/site/guide/model-validation/review-model-documentation.qmd +++ b/site/guide/validation/review-documentation.qmd @@ -2,20 +2,21 @@ # 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: "Review model documentation" +title: "Review documentation" date: last-modified aliases: - /guide/review-model-documentation.html + - /guide/model-validation/review-model-documentation.html --- -Use the {{< var validmind.platform >}} to review the model documentation provided by a model developer as part of the formal validation process. +Use the {{< var validmind.platform >}} to review the documentation provided by developers as part of the formal validation process. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] A model developer has submitted model documentation for review.[^1] +- [x] A developer has submitted documentation for review.[^1] - [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^2] ::: @@ -26,19 +27,19 @@ Use the {{< var validmind.platform >}} to review the model documentation provide ## Document Overview -{{< include /guide/model-documentation/_document-overview.qmd >}} +{{< include /guide/documentation/_document-overview.qmd >}} -{{< include /guide/model-documentation/_locate-document-overview.qmd >}} +{{< include /guide/documentation/_locate-document-overview.qmd >}} ::: {.panel-tabset} #### Unresolved conversations -Hover over **{{< fa comment-dots >}} # Unresolved conversations** to see a preview of the unresolved conversation associated with the documentation section. +Hover over **{{< fa comment-dots >}} #** to see a preview of the unresolved conversation associated with the documentation section. Resolve conversations directly from this popup, or click to expand the conversation. -#### Model artifacts -Hover over **Model Artifacts {{< fa expand >}} #** to see a preview of model artifacts associated with the documentation section. +#### Validation issues +Hover over **{{< fa triangle-exclamation >}} #** to see a preview of validation issues associated with the documentation section. Click to expand the artifact. @@ -51,12 +52,12 @@ The **{{< fa check >}} #/# Done** indicator reflects the completion status of yo At the bottom of the Document Overview page, you will also see quick view of any recent documentation activity. - Use the top tabs to narrow down the recent activity. -- Click on **{{< fa eye >}} See All Activity** to be taken to the **{{< fa wifi >}} Activity** page. +- Click on **{{< fa eye >}} View All Activity** to be taken to the **{{< fa wifi >}} Activity** page. -[^1]: [Submit for approval](/guide/model-documentation/submit-for-approval.qmd) +[^1]: [Submit for approval](/guide/documentation/submit-documents.qmd) [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) \ No newline at end of file diff --git a/site/guide/model-validation/view-filter-artifacts.qmd b/site/guide/validation/view-filter-artifacts.qmd similarity index 73% rename from site/guide/model-validation/view-filter-artifacts.qmd rename to site/guide/validation/view-filter-artifacts.qmd index f17e69189d..c255f36d4c 100644 --- a/site/guide/model-validation/view-filter-artifacts.qmd +++ b/site/guide/validation/view-filter-artifacts.qmd @@ -6,11 +6,12 @@ title: "View and filter artifacts" date: last-modified aliases: - view-filter-model-findings.qmd + - /guide/model-validation/view-filter-artifacts.html includes: artifacts: true --- -Access a complete list of filterable artifacts logged across all your models in the {{< var validmind.platform >}}, or look at only artifacts linked to a specific model. +Access a complete list of filterable artifacts logged across all your records in the {{< var validmind.platform >}}, or look at only artifacts linked to a specific record. ::: {.callout} Within the {{< var validmind.platform >}}, artifacts are split into:[^1] @@ -24,33 +25,33 @@ Within the {{< var validmind.platform >}}, artifacts are split into:[^1] ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^2] -- [x] There are artifacts logged on any model.[^3] +- [x] There are records registered in the inventory.[^2] +- [x] There are artifacts logged on any record.[^3] - [x] You are a [{{< fa circle-check >}} Validator]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^4] ::: ## View artifacts -You can view artifacts for all models at once, or only view artifacts linked to a specific model. +You can view artifacts for all records at once, or only view artifacts linked to a specific record. ### View all artifacts {{< include _view-all-artifacts.qmd >}} -### View model-specific artifacts +### View record-specific artifacts 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.[^5] +2. Select a record or find your record by applying a filter or searching for it.[^5] -3. View validation issues or other artifact types for that model. +3. View validation issues or other artifact types for that record. ::: {.panel-tabset} -#### View model-specific validation issues +#### View record-specific validation issues -a. In the left sidebar that appears for your model, click **{{< fa triangle-exclamation >}} Validation Issues**. +a. In the left sidebar that appears for your record, click **{{< fa triangle-exclamation >}} Validation Issues**. b. Click on any validation issue for more information, including the proposed remediation plan and any supporting attachments.[^6] @@ -65,14 +66,14 @@ b. Click on any validation issue for more information, including the proposed re Click on the attachment to view or download the file. -#### View model-specific artifacts of other types +#### View record-specific artifacts of other types -a. In the left sidebar that appears for your model, click **{{< fa border-all >}} Artifacts**. +a. In the left sidebar that appears for your record, click **{{< fa border-all >}} Artifacts**. b. Select an artifact type[^7] to view from the tabs: - Policy Exception - - Model Limitation + - Limitation In the page that opens is a list of all artifacts for that type. @@ -83,7 +84,7 @@ c. Click on any artifact for more information. ## Filter and sort artifacts -- By default, artifacts for all models are listed by creation date in descending order. +- By default, artifacts for all records are listed by creation date in descending order. - To sort artifacts by a column in ascending ({{< fa angle-down >}}) or descending ({{< fa angle-up >}}) order, click on the column header. To narrow down artifacts, you can apply some filters: @@ -92,7 +93,7 @@ To narrow down artifacts, you can apply some filters: ### Filter all validation issues -1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all models. +1. In the left sidebar, click **{{< fa triangle-exclamation >}} Validation Issues** to view a list of validation issues across all records. 2. Click **{{< fa filter >}} Filter**. @@ -114,12 +115,12 @@ Changes are automatically saved to your account and do not affect other users. ### Filter all other artifacts -1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all models. +1. In the left sidebar, click **{{< fa border-all >}} Artifacts** to view lists of other artifact types across all records. 2. Select an artifact type[^8] to view from the tabs: - Policy Exception - - Model Limitation + - Limitation 3. Click **{{< fa filter >}} Filter**. @@ -139,7 +140,7 @@ Changes are automatically saved to your account and do not affect other users. -[^1]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^1]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) [^2]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) @@ -151,6 +152,6 @@ Changes are automatically saved to your account and do not affect other users. [^6]: [Add and manage artifacts](add-manage-artifacts.qmd#manage-attachments) -[^7]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^7]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) -[^8]: [Manage artifact types](/guide/model-validation/manage-artifact-types.qmd) +[^8]: [Manage artifact types](/guide/validation/manage-artifact-types.qmd) diff --git a/site/guide/model-validation/working-with-artifacts.qmd b/site/guide/validation/working-with-artifacts.qmd similarity index 65% rename from site/guide/model-validation/working-with-artifacts.qmd rename to site/guide/validation/working-with-artifacts.qmd index 7a327e73e5..ddf6faba54 100644 --- a/site/guide/model-validation/working-with-artifacts.qmd +++ b/site/guide/validation/working-with-artifacts.qmd @@ -5,7 +5,7 @@ title: "Working with artifacts" date: last-modified listing: - - id: model-artifacts + - id: artifacts type: grid max-description-length: 250 sort: false @@ -20,18 +20,21 @@ aliases: - work-with-model-findings.html - /guide/work-with-model-findings.html - working-with-model-findings.html + - /guide/model-validation/working-with-artifacts.html --- -Use {{< var validmind.platform >}} to log thorough artifacts as you validate your models. From status and severity to proposed remediation plans and due dates, {{< var vm.product >}} allows you to oversee the minutiae to ensure organizational compliance. +Use {{< var validmind.platform >}} to log thorough artifacts as you validate your records. From status and severity to proposed remediation plans and due dates, {{< var vm.product >}} allows you to oversee the minutiae to ensure organizational compliance. ## Key concepts -Model artifacts (findings) are detailed observations identified during the model validation process, highlighting any major or minor issues, deficiencies, model limitations, stability and robustness concerns, or needed adjustments. +Artifacts (findings) are detailed observations identified during the validation process, highlighting any major or minor issues, deficiencies, limitations, stability and robustness concerns, or needed adjustments. -- These artifacts are critical for understanding the risk exposure and compliance status of models within an organization. -- To make them easier to track, artifacts are typically categorized by risk area, business unit, model status, and individual model, enabling targeted resolution and informed decision-making to mitigate identified risks and ensure model reliability and accuracy. +- These artifacts are critical for understanding the risk exposure and compliance status of records within an organization. +- To make them easier to track, artifacts are typically categorized by risk area, business unit, record status, and individual record, enabling targeted resolution and informed decision-making to mitigate identified risks and ensure record reliability and accuracy. -Good artifacts help explain how well the model performs in terms of predictive accuracy, generalization to new data, and the importance of variables or features used in the modeling process, and typically include: +Good artifacts help explain how well the records such as models perform in terms of predictive accuracy, generalization to new data, and the importance of variables or features used in the modeling process. + +For example, artifacts logged on models typically include: :::: {.flex .flex-wrap .justify-around} @@ -43,7 +46,7 @@ performance metrics feature importance : The ranking of input variables based on their contribution to the predictive power of the model. -model interpretability +model interpretability, interpretability : Insights into how the model makes its predictions, which can help in understanding the decision-making process. ::: @@ -66,7 +69,7 @@ residual analysis ## Manage artifacts -:::{#model-artifacts} +:::{#artifacts} ::: ## What's next diff --git a/site/guide/workflows/_abort-workflows.qmd b/site/guide/workflows/_abort-workflows.qmd index ad823844ed..ec1edefcfd 100644 --- a/site/guide/workflows/_abort-workflows.qmd +++ b/site/guide/workflows/_abort-workflows.qmd @@ -11,13 +11,13 @@ To cancel a run of a workflow: ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. @@ -27,7 +27,7 @@ To cancel a run of a workflow: #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. @@ -45,13 +45,13 @@ To cancel a run of a workflow: :::: {.content-hidden unless-format="revealjs"} To cancel a run of a workflow: -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. @@ -61,7 +61,7 @@ To cancel a run of a workflow: #### On artifacts -1. On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to abort to open that specific workflow's details. diff --git a/site/guide/workflows/_add-model-stages.qmd b/site/guide/workflows/_add-model-stages.qmd deleted file mode 100644 index aab302d79c..0000000000 --- a/site/guide/workflows/_add-model-stages.qmd +++ /dev/null @@ -1,15 +0,0 @@ - - -1. In the left sidebar, click **{{< fa gear >}} Settings**. - -1. Under {{< fa cube >}} Inventory, select **Model Stages**: - - - To add a stage, click **{{< fa plus >}} Add Model Stage**. - - To edit a stage, click on the stage itself. - -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 e010c5c9ae..5f51e45f9a 100644 --- a/site/guide/workflows/_add-new-workflows.qmd +++ b/site/guide/workflows/_add-new-workflows.qmd @@ -13,41 +13,41 @@ c. Click **{{< fa plus >}} Add Workflow**. d. Select the [workflow target]{.smallcaps} type to add: - - **Inventory Model** — Workflows that apply to models in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] - - **Artifact** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/model-validation/working-with-artifacts.qmd)] + - **Inventory Record** — Workflows that apply to records in your inventory.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] + - **Artifact** — Workflows that apply to logged artifacts.^[[Working with artifacts](/guide/validation/working-with-artifacts.qmd)] ::: {.panel-tabset} -#### Add Model Workflows +#### Add record workflows -i. Click **{{< fa plus >}} Add Model Workflow**. +i. Enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -ii. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. Select the **[record type]{.smallcaps}**^[[Manage record types](/guide/inventory/manage-inventory-record-types.qmd)] this workflow applies to. iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - **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 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 Inventory Record Registration** — Start this workflow when a record is registered in your inventory.[^on-registration] +- **On Field Change** — Start this workflow on a change to a specific record inventory field.[^on-field-change] To configure, select a field under **[inventory record field to monitor]{.smallcaps}**. - **Via Webhook** — Start this workflow when a webhook event is received. iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. v. Click **Save Draft** to save your blank workflow, and then [configure your workflow steps](/guide/workflows/configure-workflows.qmd#configure-workflow-steps). -#### Add Artifact Workflows +#### Add artifact workflows -i. Click **{{< fa plus >}} Add Artifact Workflow**. +i. Enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -ii. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - **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] +- **On Artifact Registration** — Start this workflow when a artifact is logged on a record.[^on-artifact-registration] - **Via Webhook** — Start this workflow when a webhook event is received. -iv. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/model-validation/manage-artifact-types.qmd)] this workflow applies to. +iv. Select the **[artifact type]{.smallcaps}**^[[Manage artifact types](/guide/validation/manage-artifact-types.qmd)] this workflow applies to. v. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. @@ -58,9 +58,9 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w -[^on-model-registration]: +[^on-registration]: - ::: {.callout title="Please note that only one workflow can be configured to initiate on model registration."} + ::: {.callout title="Please note that only one workflow can be configured to initiate on record registration."}
    [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd){.button} @@ -70,7 +70,7 @@ vi. Click **Save Draft** to save your blank workflow, and then [configure your w ::: {.callout title="Please note that only one workflow can be configured to initiate on registration for each type of artifact."}
    - [Add and manage artifacts](/guide/model-validation/add-manage-artifacts.qmd){.button} + [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd){.button} ::: @@ -92,36 +92,36 @@ c. Click **{{< fa plus >}} Add Workflow**. d. Select the [workflow target]{.smallcaps} type to add: - - **Inventory Model** — Workflows that apply to models in your inventory. + - **Inventory Record** — Workflows that apply to records in your inventory. - **Artifact** — Workflows that apply to logged artifacts. -#### Add Model Workflows +#### Add record workflows -i. Click **{{< fa plus >}} Add Model Workflow**. +i. Enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -ii. On the Add New Model Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. Select the [**[record type]{.smallcaps}**](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} this workflow applies to. iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - **Manually** — Start this workflow manually. -- **On Model Registration** — Start this workflow when a model is registered in your model inventory. -- **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}**. +- **On Inventory Record Registration** — Start this workflow when a record is registered in your inventory. +- **On Field Change** — Start this workflow on a change to a specific record inventory field. To configure, select a field under **[inventory record field to monitor]{.smallcaps}**. - **Via Webhook** — Start this workflow when a webhook event is received. iv. Under **[workflow expected duration]{.smallcaps}**, define the SLA for the workflow based on the start date in days, weeks, months, or years. v. Click **Save Draft** to save your blank workflow, and then configure your workflow steps. -#### Add Artifact Workflows +#### Add artifact workflows -i. Click **{{< fa plus >}} Add Artifact Workflow**. +i. Enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. -ii. On the Add New Artifact Workflow modal, enter in a **[title]{.smallcaps}** and a **[description]{.smallcaps}** the workflow. +ii. Select the [**[artifact type]{.smallcaps}**](/guide/validation/manage-artifact-types.qmd){target="_blank"} this workflow applies to. iii. Under **[workflow start]{.smallcaps}**, select when the workflow should be initiated: - **Manually** — Start this workflow manually. -- **On Artifact Registration** — Start this workflow when a artifact is logged on a model. +- **On Artifact Registration** — Start this workflow when a artifact is logged on a record. iv. Select the **[artifact type]{.smallcaps}** diff --git a/site/guide/workflows/_add-record-stages.qmd b/site/guide/workflows/_add-record-stages.qmd new file mode 100644 index 0000000000..6b10420484 --- /dev/null +++ b/site/guide/workflows/_add-record-stages.qmd @@ -0,0 +1,38 @@ + + +:::: {.content-visible unless-format="revealjs"} +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +1. Under {{< fa cube >}} Inventory, select **Inventory Record Stages**. + +1. Click on the inventory record type you want to add stages for.^[[Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd)] + +1. Click **{{< fa plus >}} Add 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. + +:::: + + +:::: {.content-hidden unless-format="revealjs"} +1. In the left sidebar, click **{{< fa gear >}} Settings**. + +1. Under {{< fa cube >}} Inventory, select **Inventory Record Stages**. + +1. Click on the [inventory record type](/guide/inventory/manage-inventory-record-types.qmd){target="_blank"} you want to add stages for. + +1. Click **{{< fa plus >}} Add 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/_conditional-requirements.qmd b/site/guide/workflows/_conditional-requirements.qmd index 6879e4a530..cfac7565aa 100644 --- a/site/guide/workflows/_conditional-requirements.qmd +++ b/site/guide/workflows/_conditional-requirements.qmd @@ -5,8 +5,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} Conditional requirements are required or optional for the following step types:^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] -### {{< fa cube >}} Model Stage Change [optional]{.smallercaps .pink} - +### {{< fa cube >}} Inventory Record Stage Change [optional]{.smallercaps .pink} + 1. Under **[when these conditions are met]{.smallcaps}**, set your `AND` and `OR` conditions. 2. Add a single independent rule or a linked condition group. These rules and groups can be nested if desired: @@ -28,7 +28,7 @@ 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 or artifact fields +#### Request record or artifact fields - Select any **[requested fields]{.smallcaps}**[^request-fields] to be entered by users during the action. @@ -48,8 +48,8 @@ Conditional requirements are required or optional for the following step types:^ 2. Then, under **[end action]{.smallcaps}**, select the type of deadline: - **After Time Interval** — Set the **[amount]{.smallcaps}** and **[unit]{.smallcaps}** of the deadline. - **At Specified Date** — Set the date and time the action should [wait until]{.smallcaps}. - - **At Specified Date on Model Field** — Select a date, date time, or calculated **[model field]{.smallcaps}** that defines the deadline. - - **Time Delta from Specified Date on Model Field** — Select a date, date time, or calculated **[model field]{.smallcaps}** to calculate a deadline from, then set a **[time delta direction]{.smallcaps}** and **[wait duration]{.smallcaps}**. + - **At Specified Date on Custom Field** — Select a date, date time, or calculated **[record field]{.smallcaps}** that defines the deadline. + - **Time Delta from Specified Date on Custom Field** — Select a date, date time, or calculated **[record field]{.smallcaps}** to calculate a deadline from, then set a **[time delta direction]{.smallcaps}** and **[wait duration]{.smallcaps}**. ::: @@ -58,7 +58,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa users >}} Approval [required]{.smallercaps .pink} -1. Under **[approval group]{.smallcaps}**, click **{{< fa plus >}} Add Individual Approver** to set an individual approver selected from **User Roles**,^[[Manage roles](/guide/configuration/manage-roles.qmd)] **Model Stakeholder Types**,^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **User** type model inventory fields:^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] +1. Under **[approval group]{.smallcaps}**, click **{{< fa plus >}} Add Individual Approver** to set an individual approver selected from **User Roles**,^[[Manage roles](/guide/configuration/manage-roles.qmd)] **Inventory Record Stakeholder Types**,^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **Inventory Record Fields — User**:^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] - Click **{{< fa plus >}} Add Rule** to add an individual rule. - Click **{{< fa square-plus >}} Add Group** to add a group of rules. @@ -77,7 +77,7 @@ Conditional requirements are required or optional for the following step types:^ ### {{< fa bullhorn >}} Broadcast [required]{.smallercaps .pink} -Select from either **Model Stakeholder Types**^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **User Roles**.^[[Manage roles](/guide/configuration/manage-roles.qmd)] +Select from either **Inventory Record Stakeholder Types**^[[Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)] or **User Roles**.^[[Manage roles](/guide/configuration/manage-roles.qmd)] ### {{< fa maximize >}} Condition Branch [required]{.smallercaps .pink} @@ -105,11 +105,11 @@ Set a time to **[wait until]{.smallcaps}** as defined by a specific timestamp. #### At Specified Date on Custom Field -Set the **[model field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-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. +Set the **[record field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] with a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. #### Time Delta from Specified Date on Custom Field -a. Set the **[model field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-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. +a. Set the **[record field]{.smallcaps}**^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types)] to a valid `Date` or `Date Time` type record field that defines the specific timestamp on a per record basis. b. Select a **[time delta direction]{.smallcaps}** relative to your selected field. @@ -159,14 +159,14 @@ To avoid storing credentials in plaintext, use `{{secret:name}}` syntax to refer [^request-fields]: - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) + - [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) :::: {.content-hidden unless-format="revealjs"} Configure conditional requirements for the following step types: -- {{< fa cube >}} Model Stage Change **[optional]{.smallercaps}** +- {{< fa cube >}} Inventory Record Stage Change **[optional]{.smallercaps}** - {{< fa arrow-pointer >}} User Action **[optional]{.smallercaps}** diff --git a/site/guide/workflows/_configure-model-stages.qmd b/site/guide/workflows/_configure-model-stages.qmd deleted file mode 100644 index 8f9c8aba6e..0000000000 --- a/site/guide/workflows/_configure-model-stages.qmd +++ /dev/null @@ -1,22 +0,0 @@ - - -:::: {.content-visible unless-format="revealjs"} -Configure the model stages available to the models in your model inventory. Model stages are manipulated via workflow transitions and are used to track the progress of models through your organization's model lifecycles. - -- Default stages are provided for you as suggestions. -- You can add, edit, remove, and define your own custom stages. - -::: {.callout} -`Archived` and `Deleted` are [Reserved]{.bubble} stages,^[[Archive and delete models](/guide/inventory/archive-delete-records.qmd)] meaning they cannot be modified or removed. -::: - -:::: - - - -:::: {.content-hidden unless-format="revealjs"} -Model stages are manipulated via workflow transitions and are used to track the progress of models through your organization's model lifecycles. - -:::: \ No newline at end of file diff --git a/site/guide/workflows/_configure-record-stages.qmd b/site/guide/workflows/_configure-record-stages.qmd new file mode 100644 index 0000000000..ba74c72718 --- /dev/null +++ b/site/guide/workflows/_configure-record-stages.qmd @@ -0,0 +1,22 @@ + + +:::: {.content-visible unless-format="revealjs"} +Configure the stages available to the records in your inventory. Record stages are manipulated via workflow transitions and are used to track the progress of records through your organization's record lifecycles. + +- Default stages are provided for you as suggestions. +- You can add, edit, remove, and define your own custom stages. + +::: {.callout} +`Archived` and `Deleted` are [Locked]{.bubble} stages,^[[Archive and delete records](/guide/inventory/archive-delete-records.qmd)] meaning they cannot be modified or removed. +::: + +:::: + + + +:::: {.content-hidden unless-format="revealjs"} +Record stages are manipulated via workflow transitions and are used to track the progress of records through your organization's record lifecycles. + +:::: \ No newline at end of file diff --git a/site/guide/workflows/_configure-workflow-steps.qmd b/site/guide/workflows/_configure-workflow-steps.qmd index f76ffbfeba..3b10015256 100644 --- a/site/guide/workflows/_configure-workflow-steps.qmd +++ b/site/guide/workflows/_configure-workflow-steps.qmd @@ -29,7 +29,7 @@ Refer to [Introduction to workflows](/guide/workflows/introduction-to-workflows. [^on-webhook]: 1. Click **{{< fa copy >}} Copy** to the right of URL to copy the webhook URL to your clipboard. This webhook URL is where you should send your `POST` request. - 2. Under [select target model for payload]{.smallcaps}, choose a model from [your inventory](/guide/inventory/working-with-the-inventory.qmd) to populate the target for the payload. + 2. Under [select target record for payload]{.smallcaps}, choose a record from [your inventory](/guide/inventory/working-with-the-inventory.qmd) to populate the target for the payload. 3. Click **{{< fa copy >}} Copy** to the right of Payload to copy the payload to include in your `POST` request to your clipboard. 4. Click **{{< fa copy >}}** to the right of `x-api-key` and `x-api-secret` and their values to copy them to your clipboard. 5. Send your `POST` request to the webhook URL and include these headers with your request to authenticate your call. diff --git a/site/guide/workflows/_initiate-workflows.qmd b/site/guide/workflows/_initiate-workflows.qmd index a2d898002b..7ecc88d7d8 100644 --- a/site/guide/workflows/_initiate-workflows.qmd +++ b/site/guide/workflows/_initiate-workflows.qmd @@ -11,13 +11,13 @@ To initiate workflows manually:[^initiate-workflows] ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your model, locate the Workflows section. +1. On the landing page of your record, locate the Workflows section. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -30,7 +30,7 @@ To initiate workflows manually:[^initiate-workflows] #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -60,13 +60,13 @@ To initiate workflows manually: ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the Workflows section. +1. On the landing page of your record, locate the Workflows section. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. @@ -79,7 +79,7 @@ To initiate workflows manually: #### On artifacts -1. On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section. 1. Click **{{< fa arrow-right-arrow-left >}} See All Workflows**. diff --git a/site/guide/workflows/_link-workflow-together.qmd b/site/guide/workflows/_link-workflow-together.qmd index 39476c5326..07f417b302 100644 --- a/site/guide/workflows/_link-workflow-together.qmd +++ b/site/guide/workflows/_link-workflow-together.qmd @@ -29,14 +29,14 @@ Hover over a workflow step to view an animation of the steps connecting to and f ##### Link approval steps -{{< fa users >}} Approval steps need to be subsequently linked to both a [Rejected]{.bubble .red .red-bg} and an [Approved]{.bubble .green .green-bg} {{< fa cube >}} Model Stage Change step:^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] +{{< fa users >}} Approval steps need to be subsequently linked to both a [Rejected]{.bubble .red .red-bg} and an [Approved]{.bubble .green .green-bg} {{< fa cube >}} Inventory Record Stage Change step:^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] i. First, configure an **{{< fa users >}} Approval** step. -ii. Then, drag two **{{< fa cube >}} Model Stage Change** steps onto the canvas: +ii. Then, drag two **{{< fa cube >}} Inventory Record Stage Change** steps onto the canvas: - - Assign a stage associated with rejection to one in the **[set model stage to]{.smallcaps}** field. - - Assign a stage associated with approval to the other in the **[set model stage to]{.smallcaps}** field. + - Assign a stage associated with rejection to one in the **[set inventory record stage to]{.smallcaps}** field. + - Assign a stage associated with approval to the other in the **[set inventory record stage to]{.smallcaps}** field. iii. Then, from the bottom of your **{{< fa users >}} Approval** step: diff --git a/site/guide/workflows/_reset-workflows.qmd b/site/guide/workflows/_reset-workflows.qmd index a2883770a6..8b37a9edf5 100644 --- a/site/guide/workflows/_reset-workflows.qmd +++ b/site/guide/workflows/_reset-workflows.qmd @@ -11,13 +11,13 @@ To reset a workflow to the beginning: ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. @@ -27,7 +27,7 @@ To reset a workflow to the beginning: #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. @@ -45,13 +45,13 @@ To reset a workflow to the beginning: :::: {.content-hidden unless-format="revealjs"} To reset a workflow to the beginning: -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. @@ -61,7 +61,7 @@ To reset a workflow to the beginning: #### On artifacts -1. On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. 1. Click on the name of the workflow you'd like to reset to open that specific workflow's details. diff --git a/site/guide/workflows/_review-active-workflows.qmd b/site/guide/workflows/_review-active-workflows.qmd index cf69b4121b..5617b67f7d 100644 --- a/site/guide/workflows/_review-active-workflows.qmd +++ b/site/guide/workflows/_review-active-workflows.qmd @@ -9,26 +9,26 @@ To review details for workflows currently active: ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of any active workflow to review that specific workflow's details. 1. Click on the tab you would like to review: - **Details** — Name and description (if present) of the workflow, the workflow's status and progress (if applicable), when it was created, and when it was started. - - **Activity** — History of updates to the workflow on that model, including notes submitted during transitions.[^notes] - - **Artifacts** — Artifacts for that model created within the duration of that workflow's runtime. + - **Activity** — History of updates to the workflow on that record, including notes submitted during transitions.[^notes] + - **Artifacts** — Artifacts for that record created within the duration of that workflow's runtime. - **Workflow**^[Hover over a workflow step to view an animation of the steps connecting to and from that step.] — Overview of the entire workflow. The current workflow step is highlighted on this view. #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. 1. Click on the name of any active workflow to review that specific workflow's details. @@ -55,21 +55,21 @@ To review details for workflows currently active: :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} -To review details for workflows currently active on models: +To review details for workflows currently active on records: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of any active workflow to review that specific workflow's details. 1. Click on the tab you would like to review: - **Details** — Name and description (if present) of the workflow, the workflow's status and progress (if applicable), when it was created, and when it was started. - - **Activity** — History of updates to the workflow on that model, including notes submitted during transitions. - - **Artifacts** — Artifacts for that model created within the duration of that workflow's runtime. + - **Activity** — History of updates to the workflow on that record, including notes submitted during transitions. + - **Artifacts** — Artifacts for that record created within the duration of that workflow's runtime. - **Workflow** — Overview of the entire workflow. The current workflow step is highlighted on this view. :::: @@ -78,26 +78,26 @@ To review details for workflows currently active on models: :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} To review details for workflows currently active: -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. Click on the name of any active workflow to review that specific workflow's details. 1. Click on the tab you would like to review: - **Details** — Name and description (if present) of the workflow, the workflow's status and progress (if applicable), when it was created, and when it was started. - - **Activity** — History of updates to the workflow on that model, including notes submitted during transitions. - - **Artifacts** — Artifacts for that model created within the duration of that workflow's runtime. + - **Activity** — History of updates to the workflow on that record, including notes submitted during transitions. + - **Artifacts** — Artifacts for that record created within the duration of that workflow's runtime. - **Workflow** — Overview of the entire workflow. The current workflow step is highlighted on this view. #### On artifacts -1. On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. 1. Click on the name of any active workflow to review that specific workflow's details. diff --git a/site/guide/workflows/_review-workflow-history.qmd b/site/guide/workflows/_review-workflow-history.qmd index 39b1c7d841..4fe3dbf903 100644 --- a/site/guide/workflows/_review-workflow-history.qmd +++ b/site/guide/workflows/_review-workflow-history.qmd @@ -7,13 +7,13 @@ Review timelines of workflows running or previously run: ::: {.panel-tabset} -#### On models +#### On records 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.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +2. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -3. On the landing page of your model, locate the Workflows section that shows a timeline of workflows associated with that model. +3. On the landing page of your record, locate the Workflows section that shows a timeline of workflows associated with that record. Use the buttons or keyboard shortcuts[^timeline-shortcuts] to control the timeline: @@ -23,7 +23,7 @@ Review timelines of workflows running or previously run: - **{{< fa calendar-days >}} Go to Today** — Focus on today - **{{< fa arrow-right >}}** — Move later to the right -If workflows are running or have previously run on your model, you can: +If workflows are running or have previously run on your record, you can: - Click on any listed workflow to review the details of that specific workflow. @@ -32,14 +32,14 @@ If workflows are running or have previously run on your model, you can: - Click **{{< fa arrow-right-arrow-left >}} See All Workflows** to see records of all workflows by status: - **Active** — Workflows currently running. - **Scheduled** — Workflows slated to run in the future. - - **Waiting** — Workflows in a {{< fa clock >}} Wait state.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd)] + - **Waiting** — Workflows in a {{< fa clock >}} Wait state.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd)] - **Finished** — Workflows that have reached an {{< fa circle-stop >}} End state.^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] - **Aborted** — Cancelled workflows.^[[Abort workflows](/guide/workflows/manage-workflows.qmd#abort-workflows)] - **Available** — Workflows available to be run manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] #### On artifacts -On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section that shows a timeline of workflows associated with that artifact. +On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the Workflows section that shows a timeline of workflows associated with that artifact. Use the buttons or keyboard shortcuts[^timeline-shortcuts] to control the timeline: @@ -58,7 +58,7 @@ If workflows are running or have previously run on your artifact, you can: - Click **{{< fa arrow-right-arrow-left >}} See All Workflows** to see records of all workflows by status: - **Active** — Workflows currently running. - **Scheduled** — Workflows slated to run in the future. - - **Waiting** — Workflows in a {{< fa clock >}} Wait state.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd)] + - **Waiting** — Workflows in a {{< fa clock >}} Wait state.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd)] - **Finished** — Workflows that have reached an {{< fa circle-stop >}} End state.^[[Workflow step types](/guide/workflows/workflow-step-types.qmd)] - **Aborted** — Cancelled workflows.^[[Abort workflows](/guide/workflows/manage-workflows.qmd#abort-workflows)] - **Available** — Workflows available to be run manually.^[[Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows)] @@ -79,7 +79,7 @@ If workflows are running or have previously run on your artifact, you can: [^filter-workflows-all]: - Filter by **Workflow Type**: - - Model + - Record - Artifact - Filter by **Workflow Status**: - Finished @@ -101,15 +101,15 @@ If workflows are running or have previously run on your artifact, you can: :::: {.content-hidden unless-format="revealjs"} Review timelines of workflows running or previously run: -#### On models +#### On records 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](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +2. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -3. On the landing page of your model, locate the Workflows section that shows a timeline of workflows associated with that model. +3. On the landing page of your record, locate the Workflows section that shows a timeline of workflows associated with that record. - If workflows are running or have previously run on your model, you can: + If workflows are running or have previously run on your record, you can: - Click on any listed workflow to review the details of that specific workflow. @@ -125,7 +125,7 @@ Review timelines of workflows running or previously run: #### On artifacts -On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section that shows a timeline of workflows associated with that artifact. +On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the Workflows section that shows a timeline of workflows associated with that artifact. If workflows are running or have previously run on your artifact, you can: diff --git a/site/guide/workflows/_set-up-workflows.qmd b/site/guide/workflows/_set-up-workflows.qmd index ff6eb6de2a..9da3d1a503 100644 --- a/site/guide/workflows/_set-up-workflows.qmd +++ b/site/guide/workflows/_set-up-workflows.qmd @@ -3,15 +3,15 @@ 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"} -Configure workflows to match your organizational needs for overseeing model development, validation, implementation, ongoing monitoring, auditing, or other risk management activities. +Configure workflows to match your organizational needs for overseeing development, validation, implementation, ongoing monitoring, auditing, or other risk management activities. :::: :::: {.content-hidden unless-format="revealjs"} -Configure workflows to match your organizational needs for overseeing model development, validation, implementation, ongoing monitoring, auditing, or other risk management activities. +Configure workflows to match your organizational needs for overseeing development, validation, implementation, ongoing monitoring, auditing, or other risk management activities. -- Models in your model inventory transition through your organization's custom model lifecycles via model stages, which are in turn manipulated via workflows. -- Workflows are comprised of workflow steps, and have their own workflow states discrete from model stages. +- Records in your inventory transition through your organization's custom record lifecycles via record stages, which are in turn manipulated via workflows. +- Workflows are comprised of workflow steps, and have their own workflow states discrete from record stages. - Some step types allow you to define conditional requirements, providing flexible customization. :::: \ No newline at end of file diff --git a/site/guide/workflows/_transition-workflow-examples.qmd b/site/guide/workflows/_transition-workflow-examples.qmd index b1be35ae83..a3fa355567 100644 --- a/site/guide/workflows/_transition-workflow-examples.qmd +++ b/site/guide/workflows/_transition-workflow-examples.qmd @@ -3,29 +3,29 @@ 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"} -While your model stages^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] and workflows states^[[Workflow states](/guide/workflows/workflow-states.qmd)] are custom to your organization, some examples are: +While your record stages^[[Manage record stages](/guide/workflows/manage-record-stages.qmd)] and workflows states^[[Workflow states](/guide/workflows/workflow-states.qmd)] are custom to your organization, some examples are: -- **To submit model documentation for validation** — Click **Ready for Validation** to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation. -- **To submit validation reports for review and approval** — Click **Ready for Review** to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit. -- **To request revisions to model documentation or validation reports** — Click **Request Revision**, fill in the mandatory notes to explain the changes that are required, and submit. -- **To have your model documentation and validation report approved** — Click **Ready for Approval**, fill in the mandatory notes, and submit. +- **To submit Development type documents for validation** — Click **Ready for Validation** to indicate that a developer has completed the initial documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation. +- **To submit validation reports for review and approval** — Click **Ready for Review** to indicate that you have completed your initial validation report, fill in the mandatory notes, and submit. +- **To request revisions to documentation or validation reports** — Click **Request Revision**, fill in the mandatory notes to explain the changes that are required, and submit. +- **To have your documentation and validation report approved** — Click **Ready for Approval**, fill in the mandatory notes, and submit. :::: :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} -While your model stages and workflows states are custom to your organization, some examples are: +While your record stages and workflows states are custom to your organization, some examples are: -- **To submit model documentation for validation** — Click **Ready for Validation** to indicate that a model developer has completed the initial model documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation. -- **To request revisions to model documentation** — Click **Request Revision**, fill in the mandatory notes to explain the changes that are required, and submit. -- **To have your model documentation approved** — Click **Ready for Approval**, fill in the mandatory notes, and submit. +- **To submit Development type documents for validation** — Click **Ready for Validation** to indicate that a developer has completed the initial documentation and is ready to have it validated. Add any notes that need to be included and then click Ready for Validation. +- **To request revisions to documentation** — Click **Request Revision**, fill in the mandatory notes to explain the changes that are required, and submit. +- **To have your documentation approved** — Click **Ready for Approval**, fill in the mandatory notes, and submit. :::: :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} -While your model stages and workflows states are custom to your organization, some examples are: +While your record stages and workflows states are custom to your organization, some examples are: -- **To submit validation reports for review and approval** — Click **Ready for Review** to indicate that you have completed your initial model validation report, fill in the mandatory notes, and submit. +- **To submit validation reports for review and approval** — Click **Ready for Review** to indicate that you have completed your initial validation report, fill in the mandatory notes, and submit. - **To request revisions to validation reports** — Click **Request Revision**, fill in the mandatory notes to explain the changes that are required, and submit. - **To have your validation report approved** — Click **Ready for Approval**, fill in the mandatory notes, and submit. diff --git a/site/guide/workflows/_transition-workflows.qmd b/site/guide/workflows/_transition-workflows.qmd index 507a58e618..a94ba254d3 100644 --- a/site/guide/workflows/_transition-workflows.qmd +++ b/site/guide/workflows/_transition-workflows.qmd @@ -6,20 +6,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> ::: {.callout-important title="Roles and action visibility"} Depending on the configuration of your workflows, you may or may not be able to move a workflow into another workflow state as actions can be gated to only users of certain roles. -When all the actions that can be performed by your role are completed for that model or artifact at that stage of the workflow, actions will disappear from your view. +When all the actions that can be performed by your role are completed for that record or artifact at that stage of the workflow, actions will disappear from your view. ::: To transition a workflow into next steps: ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. 1. If an action is available to your role, you'll see it listed under that workflow: @@ -31,7 +31,7 @@ To transition a workflow into next steps: #### On artifacts -1. On the details page of your artifact,^[[View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,^[[View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts)] locate the [active workflows]{.smallcaps} section. 1. If an action is available to your role, you'll see it listed under that workflow: @@ -47,20 +47,20 @@ To transition a workflow into next steps: [^submission-drafts]: - - Working copies are tracked under model activity: [View model activity](/guide/inventory/view-record-activity.qmd) + - Working copies are tracked under record activity: [View record activity](/guide/inventory/view-record-activity.qmd) - Working copies can be viewed, edited, and submitted by any other users with permissions to transition the workflow into its next state. - Fields values updated via working copies will reflect on the field itself. :::: :::: {.content-visible when-format="revealjs" when-meta="includes.developer"} -To transition a workflow into next steps on models: +To transition a workflow into next steps on records: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. 1. If an action is available to your role, you'll see it listed under that workflow: @@ -76,13 +76,13 @@ To transition a workflow into next steps on models: :::: {.content-visible when-format="revealjs" unless-meta="includes.developer"} To transition a workflow into next steps: -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. +1. Select a record or find your record [by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. 1. If an action is available to your role, you'll see it listed under that workflow: @@ -94,7 +94,7 @@ To transition a workflow into next steps: #### On artifacts -1. On the [details page of your artifact](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. +1. On the [details page of your artifact](/guide/validation/view-filter-artifacts.qmd#view-artifacts){target="_blank"}, locate the [active workflows]{.smallcaps} section. 1. If an action is available to your role, you'll see it listed under that workflow: diff --git a/site/guide/workflows/_workflow-states.qmd b/site/guide/workflows/_workflow-states.qmd index f20acfe891..aba2c05568 100644 --- a/site/guide/workflows/_workflow-states.qmd +++ b/site/guide/workflows/_workflow-states.qmd @@ -13,7 +13,7 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. Select the tab for the type of state to add: - - **Model Workflows** — Workflow states that apply to model workflows. + - **Record Workflows** — Workflow states that apply to record workflows. - **Artifact Workflows** — Workflow states that apply to artifact workflows. 1. Click on the workflow you'd like to modify workflow states for. @@ -32,7 +32,7 @@ Add workflow states by either while configuring a **{{< fa wifi >}} Workflow Sta 1. Select the tab for the type of state you want to edit: - - **Model Workflows** — Workflow states that apply to model workflows. + - **Record Workflows** — Workflow states that apply to record workflows. - **Artifact Workflows** — Workflow states that apply to artifact workflows. 1. Click on the workflow you'd like to edit the states for. @@ -57,7 +57,7 @@ If a state is or was previously in use on a workflow within a {{< fa wifi >}} W 1. Select the tab for the type of state you want to delete: - - **Model Workflows** — Workflow states that apply to model workflows. + - **Record Workflows** — Workflow states that apply to record workflows. - **Artifact Workflows** — Workflow states that apply to artifact workflows. 1. Click on the workflow you'd like to delete workflow states for. @@ -72,7 +72,7 @@ If a state is or was previously in use on a workflow within a {{< fa wifi >}} W :::: {.content-hidden unless-format="revealjs"} -Workflow states are statuses unique to a specific workflow, discrete from model stages. +Workflow states are statuses unique to a specific workflow, discrete from record stages. Add workflow states by either while configuring a **{{< fa wifi >}} Workflow State Change** step, or [via the **{{< fa gear >}} Settings** page](/guide/workflows/workflow-states.qmd){target="blank"}. diff --git a/site/guide/workflows/_workflow-step-types.qmd b/site/guide/workflows/_workflow-step-types.qmd index 9fa5825079..ce8371c606 100644 --- a/site/guide/workflows/_workflow-step-types.qmd +++ b/site/guide/workflows/_workflow-step-types.qmd @@ -4,17 +4,17 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} -### {{< fa cube >}} Model Stage Change - +### {{< fa cube >}} Inventory Record Stage Change + -- Transitions a model into another stage. -- Requires available model stages associated with the workflow.^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] +- Transitions a record into another stage. +- Requires available record stages associated with the workflow.^[[Manage record stages](/guide/workflows/manage-record-stages.qmd)] | Field | Description | |---:|---| -| [when these conditions are met]{.smallcaps} (optional) | Add conditional requirements to qualify for this step.^[ [Conditional requirements](/guide/workflows/conditional-requirements.qmd#model-stage-change)] | -| [set model stage to]{.smallcaps} | Select the model stage to transition to. | -: **{{< fa cube >}} Model Stage Change** step configuration {.hover tbl-colwidths="[40,60]"} +| [when these conditions are met]{.smallcaps} (optional) | Add conditional requirements to qualify for this step.^[ [Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#record-stage-change)] | +| [set inventory record stage to]{.smallcaps} | Select the record stage to transition to. | +: **{{< fa cube >}} Inventory Record Stage Change** step configuration {.hover tbl-colwidths="[40,60]"} ### {{< fa wifi >}} Workflow State Change @@ -34,9 +34,9 @@ Creates a button that performs an action on behalf of the user. | Field | Description | |---:|---| -| [display action button when]{.smallcaps} (optional) | Add conditional requirements for displaying this step.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#user-action)] | +| [display action button when]{.smallcaps} (optional) | Add conditional requirements for displaying this step.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#user-action)] | | [action button label]{.smallcaps} | Text that displays on your action button. | -| [requested fields]{.smallcaps} (optional) | Include model or artifact fields alongside your action.[^user-action] | +| [requested fields]{.smallcaps} (optional) | Include record 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]"} @@ -45,13 +45,13 @@ 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.[^approval-1] +- Select from either **User Roles**, **Inventory Record Stakeholder Types**, or either **User Role** or **User Type** inventory field.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#approval-required)] +- Must be connected to both a rejection and approval {{< fa cube >}} Inventory Record 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 or artifact fields shown to approvers for read-only review.[^approval-2] | +| [fields to review]{.smallcaps} (optional) | Select the record 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]"} @@ -59,11 +59,11 @@ Display a preconfigured message to users in the selected **[approval group]{.sma - Send email notifications to users in selected groups. -- Select from either **User Roles** or **Model Stakeholder Types**.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#broadcast-required)] +- Select from either **User Roles** or **Inventory Record Stakeholder Types**.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#broadcast-required)] | Field | Description | |---:|---| -| Select roles | Select the **Model Stakeholder Types** or **User Roles** to receive the email. | +| Select roles | Select the **Inventory Record Stakeholder Types** or **User Roles** to receive the email. | | [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]"} @@ -81,7 +81,7 @@ Workflows cannot be saved until condition branches are connected to other steps. To configure a condition branch: 1. On the Configure Condition Branch modal, click **{{< fa plus >}} Add Branch**. -2. Enter in the **[path name]{.smallcaps}** and designate the **[conditions]{.smallcaps}**^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#condition-branch-required)] that apply to this path. +2. Enter in the **[path name]{.smallcaps}** and designate the **[conditions]{.smallcaps}**^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#condition-branch-required)] that apply to this path. 3. Continue with steps 1 and 2 until your conditional branch logic is complete. To remove a path, click **{{< fa ellipsis-vertical >}}** and select **{{< fa trash-can >}} Remove Path**. @@ -92,7 +92,7 @@ To configure a condition branch: ### {{< fa clock >}} Wait -- Creates a time condition for displaying next available action.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#wait-required)] +- Creates a time condition for displaying next available action.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#wait-required)] - Used to enforce a time delay or a calendar date milestone. ::: {.callout title="Time stamp configuration is in the current user's timezone."} @@ -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 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. | +| After Time Interval | [wait duration]{.smallcaps} | Wait for a set amount of time. Applies to all records or artifacts under the workflow. | +| At Specified Date | [wait until]{.smallcaps} | Wait until a specific timestamp. Applies to all records 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 record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record 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 record or artifact field on a per record or per artifact basis. If the selected field is empty^[Make record 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 @@ -130,7 +130,7 @@ When a workflow reaches a webhook step, the workflow will pause. Listen for a `P #### 2. Configure and copy payload -1. Under [select target model for payload]{.smallcaps}, choose a model from your inventory^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] to populate the target for the payload. +1. Under [select target record for payload]{.smallcaps}, choose a record from your inventory^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd)] to populate the target for the payload. 2. Click **{{< fa copy >}} Copy** to the right of Payload to copy the payload to your clipboard. @@ -149,7 +149,7 @@ Send your `POST` request to the webhook URL and include these headers with your ### {{< fa cloud-arrow-up >}} HTTP Request -Sends a HTTP request with optional additional conditions.^[[Conditional requirements](/guide/workflows/conditional-requirements.qmd#http-request)] +Sends a HTTP request with optional additional conditions.^[[Conditional step requirements](/guide/workflows/conditional-step-requirements.qmd#http-request)] | Field | Description | |---:|---| @@ -178,11 +178,11 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem

    - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) + - [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd) [^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. + 1. Configure two **{{< fa cube >}} Inventory Record 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. @@ -190,17 +190,17 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem [^approval-2]: - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd) - - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd) + - [Manage artifact fields](/guide/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. + 1. Include optional details about the record or artifact the workflow is running on using the **{ } Insert Variable** drop-down. + 2. Click on the **Preview** tab and choose a record or artifact under **[select {inventory record/artifact} for preview]{.smallcaps}** to confirm how the notification will appear when rendered. [^wait]: - [Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd#inventory-field-types) - - [Manage artifact fields](/guide/model-validation/manage-artifact-fields.qmd#artifact-field-types) + - [Manage artifact fields](/guide/validation/manage-artifact-fields.qmd#artifact-field-types) [^request-types]: `PUT` and `POST` requests have additional configuration fields: @@ -225,8 +225,8 @@ Sends a HTTP request with optional additional conditions.^[[Conditional requirem :::: {.content-hidden unless-format="revealjs"} -#### {{< fa cube >}} Model Stage Change -Transitions a model into another stage. +#### {{< fa cube >}} Inventory Record Stage Change +Transitions a record into another stage. #### {{< fa wifi >}} Workflow State Change diff --git a/site/guide/workflows/conditional-requirements.qmd b/site/guide/workflows/conditional-step-requirements.qmd similarity index 90% rename from site/guide/workflows/conditional-requirements.qmd rename to site/guide/workflows/conditional-step-requirements.qmd index 26b1c2a8af..c86ad95d82 100644 --- a/site/guide/workflows/conditional-requirements.qmd +++ b/site/guide/workflows/conditional-step-requirements.qmd @@ -2,11 +2,13 @@ # 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: "Conditional requirements" +title: "Conditional step requirements" date: last-modified +aliases: + - conditional-requirements.html --- -Configure conditional requirements on certain workflow step types. testing why doesn't it work hmm +Configure conditional requirements on certain workflow step types. ::: {.attn} diff --git a/site/guide/workflows/configure-workflows.qmd b/site/guide/workflows/configure-workflows.qmd index 619c1cd768..30f1aef081 100644 --- a/site/guide/workflows/configure-workflows.qmd +++ b/site/guide/workflows/configure-workflows.qmd @@ -17,7 +17,7 @@ aliases: ## Prerequisites - [x] {{< var link.login >}} -- [x] Model stages must be fully configured.[^1] +- [x] Record stages must be fully configured.[^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] ::: @@ -75,10 +75,10 @@ Once you are satisfied with the setup of your workflow, publish the workflow for ## Edit existing workflows -::: {.callout title="Saving edits to a workflow already executed on models or artifacts will create a new version of the workflow."} +::: {.callout title="Saving edits to a workflow already executed on records or artifacts will create a new version of the workflow."} -- Workflows executed on models or artifacts will not be updated to the new version. To apply the latest version of a workflow, abort the existing version of the workflow and manually initiate the workflow again.[^6] -- Older versions of a workflow are read-only and cannot be edited or initiated on models or artifacts. +- Workflows executed on records or artifacts will not be updated to the new version. To apply the latest version of a workflow, abort the existing version of the workflow and manually initiate the workflow again.[^6] +- Older versions of a workflow are read-only and cannot be edited or initiated on records or artifacts. ::: @@ -94,13 +94,13 @@ You can edit a workflow in several ways: 3. Click on the workflow you'd like to modify to edit the configuration for that workflow.[^5] -#### Via workflows applied to models +#### Via workflows applied to records 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.[^7] +2. Select a record or find your record by applying a filter or searching for it.[^7] -3. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +3. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 4. Click on the name of the workflow you'd like to edit to open that specific workflow's details. @@ -126,7 +126,7 @@ c. Enter in your **[version notes]{.smallcaps}** to describe your changes. ### Delete workflow steps ::: {.callout-important title="Workflow step deletion is permanent."} -Deleting workflow steps on workflows active on models may result in malfunctioning workflows. +Deleting workflow steps on workflows active on records may result in malfunctioning workflows. ::: 1. Hover over the step you want to delete. @@ -150,7 +150,7 @@ Deleting workflow steps on workflows active on models may result in malfunctioni ## Delete existing workflows ::: {.callout-important title="Workflow deletion is permanent."} -- If a workflow is in use on a model, that model will not be impacted. +- If a workflow is in use on a record, that record will not be impacted. - Deletion will prevent any future runs of that workflow. ::: @@ -172,7 +172,7 @@ Deleting workflow steps on workflows active on models may result in malfunctioni -[^1]: [Manage model stages](manage-model-stages.qmd) +[^1]: [Manage record stages](manage-record-stages.qmd) [^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd) @@ -186,7 +186,7 @@ Deleting workflow steps on workflows active on models may result in malfunctioni [^7]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^8]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) +[^8]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts) [^9]: [Configure workflow steps](#configure-workflow-steps) diff --git a/site/guide/workflows/introduction-to-workflows.qmd b/site/guide/workflows/introduction-to-workflows.qmd index 8970915e10..a233b9b39e 100644 --- a/site/guide/workflows/introduction-to-workflows.qmd +++ b/site/guide/workflows/introduction-to-workflows.qmd @@ -12,13 +12,13 @@ listing: fields: [title, description] contents: - workflow-step-types.qmd - - conditional-requirements.qmd + - conditional-step-requirements.qmd - workflow-states.qmd --- -Models in your model inventory transition through your organization's custom model lifecycles via model stages, which are in turn manipulated via workflows. +Records in your inventory transition through your organization's custom lifecycles via record stages, which are in turn manipulated via workflows. -- Workflows are comprised of workflow steps,[^1] and have their own workflow states[^2] discrete from model stages. +- Workflows are comprised of workflow steps,[^1] and have their own workflow states[^2] discrete from record stages. - Some step types allow you to define conditional requirements,[^3] providing flexible customization. ## Workflow elements @@ -40,4 +40,4 @@ A workflow is comprised of an interplay of these elements: [^2]: [Workflow states](workflow-states.qmd) -[^3]: [Conditional requirements](conditional-requirements.qmd) \ No newline at end of file +[^3]: [Conditional step requirements](conditional-step-requirements.qmd) \ No newline at end of file diff --git a/site/guide/workflows/manage-model-stages.qmd b/site/guide/workflows/manage-record-stages.qmd similarity index 62% rename from site/guide/workflows/manage-model-stages.qmd rename to site/guide/workflows/manage-record-stages.qmd index c90ccfaa7f..ce49222348 100644 --- a/site/guide/workflows/manage-model-stages.qmd +++ b/site/guide/workflows/manage-record-stages.qmd @@ -2,53 +2,52 @@ # 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: "Manage model stages" +title: "Manage record stages" date: last-modified aliases: - customize-resource-statuses.html - /guide/customize-resource-statuses.html - customize-model-lifecycle-statuses.html + - manage-model-stages.html --- -{{< include /guide/workflows/_configure-model-stages.qmd >}} +{{< include /guide/workflows/_configure-record-stages.qmd >}} ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1] +- [x] You are a [{{< fa hand >}} Customer Admin]{.bubble} or assigned another role with sufficient permissions to perform the tasks in this guide.[^1] ::: -## Add model stages +## Add record stages -{{< include /guide/workflows/_add-model-stages.qmd >}} +{{< include /guide/workflows/_add-record-stages.qmd >}} -## Edit or delete stages +## Edit or delete record stages 1. In the left sidebar, click **{{< fa gear >}} Settings**. -2. Under {{< fa cube >}} Inventory, select **Model Stages**. +2. Under {{< fa cube >}} Inventory, select **Inventory Record Stages**. -3. Hover over the stage you'd like to modify. +3. Click on the inventory record type you want to modify stages for.[^2] -4. When the **{{< fa ellipsis-vertical >}}** appears, click on it: +4. Hover over the stage you'd like to modify. + +5. When the **{{< fa ellipsis-vertical >}}** appears, click on it: - Select **{{< fa pencil >}} Edit Details** to modify that stage. - Select **{{< fa trash-can >}} Delete Stage**. On the confirmation dialogue that appears, select **OK** to confirm deletion. ::: {.callout-important title="Deleting stages already in use will cause your workflows to no longer function correctly."} -Make sure that the stage you're deleting is not associated with any workflows or active models in your inventory before proceeding. +Make sure that the stage you're deleting is not associated with any workflows or active records in your inventory before proceeding. ::: -## What's next - -- [Workflows FAQ](/faq/faq-workflows.qmd) -- [Configure workflows](configure-workflows.qmd) - [^1]: [Manage permissions](/guide/configuration/manage-permissions.qmd) +[^2]: [Manage inventory record types](/guide/inventory/manage-inventory-record-types.qmd) \ No newline at end of file diff --git a/site/guide/workflows/manage-workflow-tasks.qmd b/site/guide/workflows/manage-workflow-tasks.qmd index 2bb9e20101..8be6552401 100644 --- a/site/guide/workflows/manage-workflow-tasks.qmd +++ b/site/guide/workflows/manage-workflow-tasks.qmd @@ -9,7 +9,7 @@ date: last-modified View and interact with outstanding workflow transition tasks assigned to your user roles for all workflows. :::{.callout} -Tasks will only appear in your inbox if the workflow step[^1] is set up to display the action button to your user role[^2] or model stakeholder type.[^3] +Tasks will only appear in your inbox if the workflow step[^1] is set up to display the action button to your user role[^2] or inventory record stakeholder type.[^3] ::: ::: {.attn} @@ -17,9 +17,9 @@ Tasks will only appear in your inbox if the workflow step[^1] is set up to displ ## Prerequisites - [x] {{< var link.login >}} -- [x] There are models registered in the model inventory.[^4] -- [x] Model stages have already been customized for use in workflows.[^5] -- [x] Workflows have already been set up for use with your models or artifacts.[^6] +- [x] There are records registered in the inventory.[^4] +- [x] Record stages have already been customized for use in workflows.[^5] +- [x] Workflows have already been set up for use with your records or artifacts.[^6] - [x] You are a assigned role with sufficient permissions to transition workflows into their next states.[^7] ::: @@ -30,7 +30,7 @@ Tasks will only appear in your inbox if the workflow step[^1] is set up to displ 2. Select the **Tasks** tab. -3. From the in-{{< var vm.platform >}} task list, view your incomplete tasks, access models or artifacts attached to tasks, and transition workflows into their next states: +3. From the in-{{< var vm.platform >}} task list, view your incomplete tasks, access records or artifacts attached to tasks, and transition workflows into their next states: ::: {.panel-tabset} @@ -38,9 +38,9 @@ Tasks will only appear in your inbox if the workflow step[^1] is set up to displ Tasks are listed with the following information: -- The name of the model or artifact the workflow is attached to +- The name of the record or artifact the workflow is attached to - The current workflow state of the workflow[^8] -- The name of the workflow attached to the model or artifact[^9] +- The name of the workflow attached to the record or artifact[^9] - The due date of the workflow, calculated from the workflow's expected duration - Action items associated with that task @@ -48,7 +48,7 @@ To show older tasks, scroll down to the bottom and click **Load More**. ### Access details -To view the details of a model or artifact attached to a workflow task, click the button displaying the name of the model or artifact. +To view the details of a record or artifact attached to a workflow task, click the button displaying the name of the record or artifact. ### Transition workflows @@ -72,7 +72,7 @@ Once completed, tasks will be removed from your view. [^4]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^5]: [Manage model stages](manage-model-stages.qmd) +[^5]: [Manage record stages](manage-record-stages.qmd) [^6]: [Configure workflows](configure-workflows.qmd) diff --git a/site/guide/workflows/manage-workflows.qmd b/site/guide/workflows/manage-workflows.qmd index e5c8d8f2a1..f1c91bd77b 100644 --- a/site/guide/workflows/manage-workflows.qmd +++ b/site/guide/workflows/manage-workflows.qmd @@ -8,16 +8,17 @@ aliases: - /guide/model-workflows/manage-model-workflows.html --- -Review workflows associated with your models or artifacts, and initiate or abort workflows configured for your organization on your models or artifacts. +Review workflows associated with your records or artifacts, and initiate or abort workflows configured for your organization on your records or artifacts. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] -- [x] Workflows have already been set up for use with your models.[^2] -- [x] You are a assigned role with sufficient permissions to view and run workflows on models.[^3] +- [x] For record workflows, the record you want to manage workflows for registered in the inventory.[^1] +- [x] For artifact workflows, the artifact you want to manage workflows for is logged on a record.[^2] +- [x] Workflows have already been set up for use with your records or artifacts.[^3] +- [x] You are a assigned role with sufficient permissions to view and run workflows on records or artifacts.[^4] ::: @@ -37,17 +38,17 @@ Review workflows associated with your models or artifacts, and initiate or abort ### Resume workflows -To manually resume a workflow in a {{< fa clock >}} Wait state:[^4] +To manually resume a workflow in a {{< fa clock >}} Wait state:[^5] ::: {.panel-tabset} -#### On models +#### On records 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model or find your model by applying a filter or searching for it.[^5] +1. Select a record or find your record by applying a filter or searching for it.[^6] -1. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +1. On the landing page of your record, locate the [active workflows]{.smallcaps} section. 1. For the workflow you'd like to manually advance, click **{{< fa arrow-right-arrow-left >}} Resume Workflow** to open up the workflow's step overview. @@ -55,7 +56,7 @@ To manually resume a workflow in a {{< fa clock >}} Wait state:[^4] #### On artifacts -1. On the details page of your artifact,[^6] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,[^7] locate the [active workflows]{.smallcaps} section. 1. For the workflow you'd like to manually advance, click **{{< fa arrow-right-arrow-left >}} Resume Workflow** to open up the workflow's step overview. @@ -72,11 +73,11 @@ Applying the latest version of a workflow will reset the workflow to the beginni ::: -If you have updated a workflow's configuration and want to apply the newest version of the workflow to your models or artifacts:[^7] +If you have updated a workflow's configuration and want to apply the newest version of the workflow to your records or artifacts:[^8] -1. Abort the existing execution of the workflow.[^8] +1. Abort the existing execution of the workflow.[^9] -2. Manually initiate the workflow again.[^9] +2. Manually initiate the workflow again.[^10] ### Edit workflow end dates @@ -84,13 +85,13 @@ To adjust the expected end date for a workflow: ::: {.panel-tabset} -#### On models +#### On records 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] +2. Select a record or find your record by applying a filter or searching for it.[^11] -3. On the landing page of your model, locate the [active workflows]{.smallcaps} section. +3. On the landing page of your record, 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. @@ -102,7 +103,7 @@ To adjust the expected end date for a workflow: #### On artifacts -1. On the details page of your artifact,[^11] locate the [active workflows]{.smallcaps} section. +1. On the details page of your artifact,[^12] 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. @@ -123,22 +124,24 @@ To adjust the expected end date for a workflow: [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Configure workflows](configure-workflows.qmd) +[^2]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd) -[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd) +[^3]: [Configure workflows](configure-workflows.qmd) -[^4]: [Conditional requirements](conditional-requirements.qmd#wait) +[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd) -[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^5]: [Conditional step requirements](conditional-step-requirements.qmd#wait) -[^6]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) +[^6]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) -[^7]: [Configure workflows](configure-workflows.qmd#edit-existing-workflows) +[^7]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts) -[^8]: [Abort workflows](/guide/workflows/manage-workflows.qmd#abort-workflows) +[^8]: [Configure workflows](configure-workflows.qmd#edit-existing-workflows) -[^9]: [Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows) +[^9]: [Abort workflows](/guide/workflows/manage-workflows.qmd#abort-workflows) -[^10]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) +[^10]: [Initiate workflows](/guide/workflows/manage-workflows.qmd#initiate-workflows) -[^11]: [View and filter artifacts](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts) \ No newline at end of file +[^11]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records) + +[^12]: [View and filter artifacts](/guide/validation/view-filter-artifacts.qmd#view-artifacts) \ No newline at end of file diff --git a/site/guide/workflows/setting-up-workflows.qmd b/site/guide/workflows/setting-up-workflows.qmd index bbc793e85b..60ab40641a 100644 --- a/site/guide/workflows/setting-up-workflows.qmd +++ b/site/guide/workflows/setting-up-workflows.qmd @@ -11,7 +11,7 @@ listing: sort: false fields: [title, description] contents: - - manage-model-stages.qmd + - manage-record-stages.qmd - configure-workflows.qmd - workflow-configuration-examples.qmd aliases: @@ -48,7 +48,7 @@ Click **{{< fa filter >}} Filter** to filter for workflows using different [work - **Status** — Whether the workflow is a `Draft` workflow or an `Active` workflow. - **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` + - **Workflow Target** — The type of workflow: `Artifact`, `Inventory Record`
    diff --git a/site/guide/workflows/transition-workflows.qmd b/site/guide/workflows/transition-workflows.qmd index 74d4a94c26..896152cddf 100644 --- a/site/guide/workflows/transition-workflows.qmd +++ b/site/guide/workflows/transition-workflows.qmd @@ -4,20 +4,20 @@ # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial title: "Transition workflows" date: last-modified -aliases: +aliases: - /guide/model-workflows/transition-model-workflows.html --- -Transition a model's or artifact's workflow into its next state, or reset a workflow on a model or artifact. +Transition a record's or artifact's workflow into its next state, or reset a workflow on a record or artifact. ::: {.attn} ## Prerequisites - [x] {{< var link.login >}} -- [x] The model is registered in the model inventory.[^1] -- [x] Model stages have already been customized for use in workflows.[^2] -- [x] Workflows have already been set up for use with your models.[^3] +- [x] The record you want to transition workflows for is registered in the inventory.[^1] +- [x] Record stages have already been customized for use in workflows.[^2] +- [x] Workflows have already been set up for use with your records or artifacts.[^3] - [x] You are a assigned role with sufficient permissions to transition the workflow into its next state.[^4] ::: @@ -35,7 +35,7 @@ Transition a model's or artifact's workflow into its next state, or reset a work [^1]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd) -[^2]: [Manage model stages](manage-model-stages.qmd) +[^2]: [Manage record stages](manage-record-stages.qmd) [^3]: [Configure workflows](configure-workflows.qmd) diff --git a/site/guide/workflows/workflow-configuration-examples.qmd b/site/guide/workflows/workflow-configuration-examples.qmd index 212ac3841d..0a3b41f12e 100644 --- a/site/guide/workflows/workflow-configuration-examples.qmd +++ b/site/guide/workflows/workflow-configuration-examples.qmd @@ -6,19 +6,19 @@ title: "Workflow configuration examples" date: last-modified --- -Learn from example workflow configurations to help you tailor workflows to fit your organization's requirements for managing model risk throughout your entire model lifecycles. +Learn from example workflow configurations to help you tailor workflows to fit your organization's requirements for managing risk throughout your entire risk management lifecycles. ## Example workflows Workflows can be as simple or as complex as required, with multiple and discrete workflows supported for unique triggers and scenarios. -For example, to cover activities in their model lifecycle up to model deployment, an organization has the following model workflows configured: +For example, to cover activities in their model lifecycle up to model deployment, an organization has the following inventory record workflows configured: ::: {.panel-tabset} -### On model registration +### On registration -This workflow initiates upon model registration[^1] — when models are added to the **{{< fa cubes >}} Inventory**, and covers model development activities, including documentation of the model. +This workflow initiates upon record registration[^1] — when model record types are added to the **{{< fa cubes >}} Inventory**, and covers model development activities, including documentation of the model. - This particular organization pairs their developers into teams of two, where one develops and initially documents the model, and the other peer reviews and approves the model for official validation, requesting revisions if the documentation is incomplete. - They meticulously transition the model through the stages[^2] of their development cycle with this workflow, as well as transition the workflow into linked states.[^3] @@ -27,9 +27,9 @@ This workflow initiates upon model registration[^1] — when models are added to ![Example model development cycle workflow](example_model-registration-workflow.png){fig-alt="A screenshot showing an example model development cycle workflow" .screenshot group="model-registration"} ::: -### On model validation +### On validation -This workflow is initiated manually[^4] — in this case via {{< fa arrow-right-arrow-left >}} Run Workflow step in the previous *On model registration* workflow. +This workflow is initiated manually[^4] — in this case via {{< fa arrow-right-arrow-left >}} Run Workflow step in the previous *On registration* workflow. - In this workflow, the model stage[^5] remains as [In Initial Validation]{.bubble} throughout, while the state of the workflow[^6] transitions to reflect the status of validation. - The option to develop potential challenger models is at the discretion of the validator, or they can choose to approve the champion model without submitting additional challengers. @@ -39,7 +39,7 @@ This workflow is initiated manually[^4] — in this case via {{< fa arrow-right- ![Example model validation cycle workflow](example_model-validation-workflow.png){fig-alt="A screenshot showing an example model validation cycle workflow" .screenshot group="model-validation"} ::: -### On model deployment +### On deployment This workflow is initiated when a field is populated — in this case, when the model is slated for deployment by entering value into the [deployment scheduled]{.smallcaps} date time field.[^8] @@ -61,8 +61,8 @@ For more information, refer to [Integrations examples](/guide/integrations/integ Detail views of the demo workflow step types[^11] used in the example workflows: -#### {{< fa cube >}} Model Stage Change - +#### {{< fa cube >}} Inventory Record Stage Change + In this example, the model transitions into a stage[^12] called [In Documentation]{.bubble}: @@ -71,13 +71,13 @@ In this example, the model transitions into a stage[^12] called [In Documentatio ::: {.w-60-ns} ![Example {{< fa cube >}} Model Stage Change - configuration modal](configure_model-stage-change.png){fig-alt="A screenshot showing an example Model Stage Change configuration modal" .screenshot group="stage-change"} + configuration modal](configure_model-stage-change.png){fig-alt="A screenshot showing an example Inventory Record Stage Change configuration modal" .screenshot group="stage-change"} ::: ::: {.w-40-ns} -![Example {{< fa cube >}} Model Stage Change - step](example_model-stage-change.png){fig-alt="A screenshot showing an example Model Stage Change step" .screenshot group="stage-change"} +![Example {{< fa cube >}} Inventory Record Stage Change + step](example_model-stage-change.png){fig-alt="A screenshot showing an example Inventory Record Stage Change step" .screenshot group="stage-change"} ::: @@ -138,7 +138,7 @@ In this example, the user is presented with an action button labelled **{{< fa a #### {{< fa users >}} Approval -In this example, the [peer reviewers]{.smallcaps} model stakeholders[^15] assigned to the model are presented with an approval message and a `Data Sources` field to review: +In this example, the [peer reviewers]{.smallcaps} inventory record stakeholders[^15] assigned to the model are presented with an approval message and a `Data Sources` field to review: :::: {.flex .flex-wrap .justify-around} @@ -182,7 +182,7 @@ In this example, the [Customer Admin]{.bubble} user role[^16] is sent an email n #### {{< fa maximize >}} Condition Branch -In this example, models where the field [genai model]{.smallcaps} is set to true undergo a special [legal review]{.smallcaps} model stakeholder[^17] approval process:[^18] +In this example, models where the field [genai model]{.smallcaps} is set to true undergo a special [legal review]{.smallcaps} inventory record stakeholder[^17] approval process:[^18] :::: {.flex .flex-wrap .justify-around} @@ -222,7 +222,7 @@ In this example, the next step on the workflow waits until the timestamp indicat #### {{< fa arrow-right-arrow-left >}} Run Workflow -In this example, the current workflow initiates another workflow called `On model validation`: +In this example, the current workflow initiates another workflow called `On validation`: :::: {.flex .flex-wrap .justify-around} @@ -245,7 +245,7 @@ In this example, the current workflow initiates another workflow called `On mode :::: {.flex .flex-wrap .justify-around} ::: {.w-60-ns} -In this example, the workflow is designated to stop after running an additional workflow called `On model validation`: +In this example, the workflow is designated to stop after running an additional workflow called `On validation`: ::: @@ -265,13 +265,13 @@ In this example, the workflow is designated to stop after running an additional **Workflow steps used:** - [{{< fa arrow-pointer >}} User Action](#user-action) - - [{{< fa cube >}} Model Stage Change](#model-stage-change) + - [{{< fa cube >}} Inventory Record Stage Change](#record-stage-change) - [{{< fa wifi >}} Workflow State Change](#workflow-state-change) - [{{< fa users >}} Approval](#approval) - [{{< fa arrow-right-arrow-left >}} Run Workflow](#run-workflow) - [{{< fa circle-stop >}} End](#end) -[^2]: [Manage model stages](manage-model-stages.qmd) +[^2]: [Manage record stages](manage-record-stages.qmd) [^3]: [Workflow states](workflow-states.qmd) @@ -280,36 +280,36 @@ In this example, the workflow is designated to stop after running an additional **Workflow steps used:** - [{{< fa arrow-pointer >}} User Action](#user-action) - - [{{< fa cube >}} Model Stage Change](#model-stage-change) + - [{{< fa cube >}} Inventory Record Stage Change](#record-stage-change) - [{{< fa wifi >}} Workflow State Change](#workflow-state-change) - [{{< fa maximize >}} Condition Branch](#condition-branch) - [{{< fa users >}} Approval](#approval) - [{{< fa circle-stop >}} End](#end) -[^5]: [Manage model stages](manage-model-stages.qmd) +[^5]: [Manage record stages](manage-record-stages.qmd) [^6]: [Workflow states](workflow-states.qmd) -[^7]: [Conditional requirements](conditional-requirements.qmd) +[^7]: [Conditional step requirements](conditional-step-requirements.qmd) [^8]: ![Adding a workflow that is initiated when a model has a scheduled deployment date](example_model-deployment.png){fig-alt="A screenshot showing the modal for adding a workflow that is initiated when a model has a scheduled deployment date" .screenshot group="model-deployment"} **Workflow steps used:** - [{{< fa arrow-pointer >}} User Action](#user-action) - - [{{< fa cube >}} Model Stage Change](#model-stage-change) + - [{{< fa cube >}} Inventory Record Stage Change](#record-stage-change) - [{{< fa wifi >}} Workflow State Change](#workflow-state-change) - [{{< fa bullhorn >}} Broadcast](#broadcast) - [{{< fa clock >}} Wait](#wait) - [{{< fa circle-stop >}} End](#end) -[^9]: [Manage model stages](manage-model-stages.qmd) +[^9]: [Manage record stages](manage-record-stages.qmd) [^10]: [Workflow states](workflow-states.qmd) [^11]: [Workflow step types](workflow-step-types.qmd) -[^12]: [Manage model stages](manage-model-stages.qmd) +[^12]: [Manage record stages](manage-record-stages.qmd) [^13]: [Workflow states](workflow-states.qmd) diff --git a/site/guide/workflows/workflow-states.qmd b/site/guide/workflows/workflow-states.qmd index e213aec0e1..539bab5c89 100644 --- a/site/guide/workflows/workflow-states.qmd +++ b/site/guide/workflows/workflow-states.qmd @@ -9,7 +9,7 @@ date: last-modified Workflow states are statuses unique to a specific workflow. ::: {.callout} -Workflow states are discrete from model stages.^[[Manage model stages](/guide/workflows/manage-model-stages.qmd)] +Workflow states are discrete from record stages.^[[Manage record stages](/guide/workflows/manage-record-stages.qmd)] ::: ::: {.attn} diff --git a/site/guide/workflows/working-with-workflows.qmd b/site/guide/workflows/working-with-workflows.qmd index 0d5674a9fd..8174e9e960 100644 --- a/site/guide/workflows/working-with-workflows.qmd +++ b/site/guide/workflows/working-with-workflows.qmd @@ -20,7 +20,7 @@ aliases: - /guide/model-workflows/working-with-model-workflows.html --- -Once customized, use workflows to transition your models into their appropriate next stages throughout your model lifecycles. +Once customized, use workflows to transition your records into their appropriate next stages throughout your risk management lifecycles. :::{#workflows} ::: \ No newline at end of file diff --git a/site/releases/2023/2023-oct-25/highlights.qmd b/site/releases/2023/2023-oct-25/highlights.qmd index 2103272349..029a1c34df 100644 --- a/site/releases/2023/2023-oct-25/highlights.qmd +++ b/site/releases/2023/2023-oct-25/highlights.qmd @@ -73,13 +73,13 @@ You can now remove blocks of text or test-related content from model documentati - This new feature gives you more control over your documentation and enables you to remove content that is no longer needed. - To remove text blocks and test-driven blocks from model documentation, you first select the block you want to remove and click {{< fa trash-can >}}, either in the text-block's toolbar or in the test-driven's block single-button toolbar. -[Remove content blocks](/guide/model-documentation/work-with-content-blocks.qmd#remove-content-blocks){.button .button-green} +[Remove content blocks](/guide/documentation/work-with-content-blocks.qmd#remove-content-blocks){.button .button-green} ::: ::: {.w-50-ns} -![Removing a test-driven block](/guide/model-documentation/remove-test-driven-block.gif){fig-alt="A gif showcasing the process of removing a test-driven block" .screenshot} +![Removing a test-driven block](/guide/documentation/remove-test-driven-block.gif){fig-alt="A gif showcasing the process of removing a test-driven block" .screenshot} ::: diff --git a/site/releases/2023/release-notes-2023-jul-24.qmd b/site/releases/2023/release-notes-2023-jul-24.qmd index 4789effe05..a47cc470f4 100644 --- a/site/releases/2023/release-notes-2023-jul-24.qmd +++ b/site/releases/2023/release-notes-2023-jul-24.qmd @@ -44,7 +44,7 @@ When collaborating on model documentation in the {{< var vm.platform >}} with ot ::: ::: {.w-30-ns} -[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd){.button .button-green} +[Collaborate with others](/guide/documentation/collaborate-with-others.qmd){.button .button-green} ::: @@ -66,7 +66,7 @@ You can now add new sections to existing model documentation, providing addition ::: ::: {.w-30-ns} -[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd){.button .button-green} +[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd){.button .button-green} ::: @@ -111,7 +111,7 @@ We've now enhanced the flexibility of documenting models by allowing you to swap ::: {.w-50-ns .tc} [Install and initialize the {{< var validmind.developer >}}](/developer/model-documentation/install-and-initialize-validmind-library.qmd){.button .button-green} -[Working with model findings](/guide/model-validation/working-with-artifacts.qmd){.button .button-green} +[Working with model findings](/guide/validation/working-with-artifacts.qmd){.button .button-green} ::: diff --git a/site/releases/2024/2024-dec-06/release-notes.qmd b/site/releases/2024/2024-dec-06/release-notes.qmd index 9bb5c34842..5ec54b7efd 100644 --- a/site/releases/2024/2024-dec-06/release-notes.qmd +++ b/site/releases/2024/2024-dec-06/release-notes.qmd @@ -599,7 +599,7 @@ You can now annotate attachments uploaded to both models or model findings, allo ::: {.w-40-ns .tc} [Edit inventory fields](/guide/inventory/edit-inventory-fields.qmd#manage-supporting-documentation){.button} -[Add and manage model findings](/guide/model-validation/add-manage-artifacts.qmd#manage-supporting-documentation){.button} +[Add and manage model findings](/guide/validation/add-manage-artifacts.qmd#manage-supporting-documentation){.button} ::: @@ -707,7 +707,7 @@ If more than one set of test results has been logged with the {{< var validmind. ::: ::: {.w-30-ns .tc} -[Work with test results](/guide/model-documentation/work-with-test-results.qmd#filter-historical-test-results){.button} +[Work with test results](/guide/documentation/work-with-test-results.qmd#filter-historical-test-results){.button} ::: @@ -731,7 +731,7 @@ When working with validation reports, linking developer evidence is now associat ::: ::: {.w-30-ns .tc} -[Assess compliance](/guide/model-validation/assess-compliance.qmd#link-developer-evidence){.button} +[Assess compliance](/guide/validation/assess-compliance.qmd#link-developer-evidence){.button} ::: @@ -965,7 +965,7 @@ We've expanded our reference guide on working with content blocks, including upd ::: ::: {.w-30-ns .tc} -[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd){.button} +[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd){.button} ::: @@ -988,7 +988,7 @@ Our reference material on model findings has been expanded to include key concep ::: ::: {.w-30-ns .tc} -[Working with model findings](/guide/model-validation/working-with-artifacts.qmd){.button} +[Working with model findings](/guide/validation/working-with-artifacts.qmd){.button} ::: @@ -1072,7 +1072,7 @@ Model stages have been renamed in the {{< var validmind.platform >}} and documen ::: ::: {.w-40-ns .tr} -[Manage model stages](/guide/workflows/manage-model-stages.qmd){.button} +[Manage record stages](/guide/workflows/manage-record-stages.qmd){.button} ::: @@ -1118,7 +1118,7 @@ Labels: documentation ::: ::: {.w-25-ns} -[Track issue resolution](/guide/model-validation/add-manage-artifacts#track-artifact-resolution){.button} +[Track issue resolution](/guide/validation/add-manage-artifacts#track-artifact-resolution){.button} ::: diff --git a/site/releases/2024/2024-dec-24/release-notes.qmd b/site/releases/2024/2024-dec-24/release-notes.qmd index 5ad15d679e..a9bd930fd3 100644 --- a/site/releases/2024/2024-dec-24/release-notes.qmd +++ b/site/releases/2024/2024-dec-24/release-notes.qmd @@ -72,7 +72,7 @@ Along with customizing what you see, you can now save preconfigured views on the ::: ::: {.w-40-ns .tc} -[View and filter model findings](/guide/model-validation/customize-artifact-layouts.qmd){.button .button-green} +[View and filter model findings](/guide/validation/customize-artifact-layouts.qmd){.button .button-green} ::: @@ -238,7 +238,7 @@ We've improved the way revision history displays within content blocks, allowing ::: ::: {.w-30-ns .tc} -[Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#revision-history){.button} +[Collaborate with others](/guide/documentation/collaborate-with-others.qmd#revision-history){.button} ::: @@ -290,7 +290,7 @@ Labels: bug - Now, deleting a finding will show a confirmation warning and subsequently remove it from any linked reports. ::: {.tc} -[Add and manage model findings](/guide/model-validation/add-manage-artifacts.qmd#delete-artifacts){.button} +[Add and manage model findings](/guide/validation/add-manage-artifacts.qmd#delete-artifacts){.button} ::: diff --git a/site/releases/2024/2024-feb-14/highlights.qmd b/site/releases/2024/2024-feb-14/highlights.qmd index b8978df412..251aa2817f 100644 --- a/site/releases/2024/2024-feb-14/highlights.qmd +++ b/site/releases/2024/2024-feb-14/highlights.qmd @@ -301,7 +301,7 @@ We implemented a toggle feature in the **{{< fa wifi >}} Model Activity** and Re ::: ::: {.w-30-ns .tc} -[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd){.button} +[Work with content blocks](/guide/documentation/work-with-content-blocks.qmd){.button} ::: @@ -342,7 +342,7 @@ We implemented a toggle feature in the **{{< fa wifi >}} Model Activity** and Re ::: {.w-40-ns} -[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd){.button} +[Working with model documentation](/guide/documentation/working-with-documentation.qmd){.button} ::: diff --git a/site/releases/2024/2024-jan-18/highlights.qmd b/site/releases/2024/2024-jan-18/highlights.qmd index aa314decb4..a95046768f 100644 --- a/site/releases/2024/2024-jan-18/highlights.qmd +++ b/site/releases/2024/2024-jan-18/highlights.qmd @@ -196,7 +196,7 @@ You use these new template management features to: ::: {.w-20-ns} -[Commenting](/guide/model-documentation/collaborate-with-others.qmd#commenting){.button} +[Commenting](/guide/documentation/collaborate-with-others.qmd#commenting){.button} ::: @@ -277,7 +277,7 @@ Additionally, we updated the business unit selector component to be a simple dro ::: {.w-30-ns} -[Document Overview](/guide/model-documentation/working-with-model-documentation.qmd#document-overview){.button} +[Document Overview](/guide/documentation/working-with-documentation.qmd#document-overview){.button} ::: diff --git a/site/releases/2024/2024-mar-27/highlights.qmd b/site/releases/2024/2024-mar-27/highlights.qmd index 44f299f5ea..c1ab680729 100644 --- a/site/releases/2024/2024-mar-27/highlights.qmd +++ b/site/releases/2024/2024-mar-27/highlights.qmd @@ -30,7 +30,7 @@ Test result metadata includes: - User attribution to tell you who updated the test results - Relevant inputs associated with the test results -[View test result metadata](/guide/model-documentation/work-with-test-results.qmd#view-test-result-metadata){.button .button-green} +[View test result metadata](/guide/documentation/work-with-test-results.qmd#view-test-result-metadata){.button .button-green} ::: @@ -76,7 +76,7 @@ To facilitate working with findings across all models undergoing validation in y - Assignee - Due date -[View and filter model findings](/guide/model-validation/view-filter-artifacts.qmd){.button .button-green} +[View and filter model findings](/guide/validation/view-filter-artifacts.qmd){.button .button-green} ::: @@ -143,7 +143,7 @@ The same customization is available on the **{{< fa triangle-exclamation >}} Fin ::: ::: {.w-30-ns} -[View model findings](/guide/model-validation/view-filter-artifacts.qmd#view-artifacts){.button .button-green} +[View model findings](/guide/validation/view-filter-artifacts.qmd#view-artifacts){.button .button-green} ::: @@ -337,7 +337,7 @@ Documentation projects have been removed from the {{< var validmind.platform >}} ::: ::: {.w-40-ns .tc} -[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd){.button} +[Working with model documentation](/guide/documentation/working-with-documentation.qmd){.button} ::: @@ -350,7 +350,7 @@ Documentation projects have been removed from the {{< var validmind.platform >}} ::: ::: {.w-40-ns .tc} -[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd){.button} +[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd){.button} ::: @@ -422,9 +422,9 @@ The user guide sections for working with model documentation and preparing valid ::: ::: {.w-40-ns .tc} -[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd){.button} +[Working with model documentation](/guide/documentation/working-with-documentation.qmd){.button} -[Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd){.button} +[Preparing validation reports](/guide/validation/preparing-validation-reports.qmd){.button} ::: diff --git a/site/releases/2024/2024-may-22/release-notes.qmd b/site/releases/2024/2024-may-22/release-notes.qmd index 5d56b6a6e3..aeea16fdec 100644 --- a/site/releases/2024/2024-may-22/release-notes.qmd +++ b/site/releases/2024/2024-may-22/release-notes.qmd @@ -171,7 +171,7 @@ Our new **Document Overview** is designed to help you find the information you n ::: {.w-30-ns .tc} -[Document Overview](/guide/model-documentation/working-with-model-documentation.qmd#document-overview){.button .button-green} +[Document Overview](/guide/documentation/working-with-documentation.qmd#document-overview){.button .button-green} ::: @@ -214,7 +214,7 @@ We created a new **Documentation** outline page which replaces the existing mode ::: ::: {.w-40-ns .tc} -[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd){.button .button-green} +[Working with model documentation](/guide/documentation/working-with-documentation.qmd){.button .button-green} ::: @@ -656,13 +656,13 @@ You can now associate model findings with sections within your model documentati ::: ::: {.w-30-ns .tc} -[Add model findings](/guide/model-validation/add-manage-artifacts.qmd#add-artifacts){.button} +[Add model findings](/guide/validation/add-manage-artifacts.qmd#add-artifacts){.button} ::: :::: -![Adding a finding to a documentation section](/guide/model-validation/add-section-finding.gif){fig-alt="An animated gif demonstrating how to add a finding to a documentation section" .screenshot width=90%} +![Adding a finding to a documentation section](/guide/validation/add-section-finding.gif){fig-alt="An animated gif demonstrating how to add a finding to a documentation section" .screenshot width=90%} ::: {.tc} -[Learn more ...](/guide/model-documentation/check-documents-for-compliance.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/check-documents-for-compliance.qmd){.button target="_blank"} ::: ::: ::: {.column width="70%" .bl .pl4 .f3} -{{< include /guide/model-documentation/_document-checker.qmd >}} +{{< include /guide/documentation/_document-checker.qmd >}} ::: :::: \ No newline at end of file diff --git a/site/training/common-slides/_document-overview.qmd b/site/training/common-slides/_document-overview.qmd index f8599ef2d3..a89903f202 100644 --- a/site/training/common-slides/_document-overview.qmd +++ b/site/training/common-slides/_document-overview.qmd @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> **Document Overview** ::: {.tc} -[Learn more...](/guide/model-validation/review-model-documentation.qmd){.button target="_blank"} +[Learn more...](/guide/validation/review-documentation.qmd){.button target="_blank"} :::
    @@ -19,9 +19,9 @@ Try it **live** on the next page. {{< fa hand-point-right >}} ::: {.column width="70%" .bl .pl4 .f3} -{{< include /guide/model-documentation/_document-overview.qmd >}} +{{< include /guide/documentation/_document-overview.qmd >}} -{{< include /guide/model-documentation/_locate-document-overview.qmd >}} +{{< include /guide/documentation/_locate-document-overview.qmd >}} ::: :::: \ No newline at end of file diff --git a/site/training/common-slides/_submit-for-approval.qmd b/site/training/common-slides/_submit-for-approval.qmd index fbc2f44bf0..80e4472566 100644 --- a/site/training/common-slides/_submit-for-approval.qmd +++ b/site/training/common-slides/_submit-for-approval.qmd @@ -9,8 +9,8 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> **Submit for approval** ::: -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 and the workflow you'd like to transition. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the landing page of your record, locate the [active workflows]{.smallcaps} section and the workflow you'd like to transition. 3. If an action is available to your role, you'll see it listed under that workflow: - Click **{{< fa arrow-right >}}** to open up the transition panel for your selected action. This arrow will be followed by the action name. - Enter your **[notes]{.smallcaps}** and any other additional inventory fields then click **Submit**. diff --git a/site/training/common-slides/_work-with-workflows.qmd b/site/training/common-slides/_work-with-workflows.qmd index c6b636b9a1..b0d506a751 100644 --- a/site/training/common-slides/_work-with-workflows.qmd +++ b/site/training/common-slides/_work-with-workflows.qmd @@ -13,22 +13,22 @@ Work with workflows ::: ::: {.tc} -[Learn more ...](/guide/model-documentation/submit-for-approval.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/submit-documents.qmd){.button target="_blank"} :::
    Try it **live** on the next page. {{< fa hand-point-right >}} ::: {.f5 .pl3 .mt4 .pr3 .embed} -**Depending on the configuration of your workflows, you may or may not be able to move a model into another workflow state as actions can be gated to only users of certain roles.** +**Depending on the configuration of your workflows, you may or may not be able to move a record into another workflow state as actions can be gated to only users of certain roles.** -When all the actions that can be performed by your role are completed for that model at that stage of the workflow, actions will disappear from your view. +When all the actions that can be performed by your role are completed for that record at that stage of the workflow, actions will disappear from your view. ::: ::: ::: {.column width="70%" .bl .pl4 .f4} -{{< include /guide/model-documentation/_submit-for-approval.qmd >}} +{{< include /guide/documentation/_submit-for-approval.qmd >}} ::: {.panel-tabset} ### Verify workflows diff --git a/site/training/developer-fundamentals/finalizing-model-documentation.qmd b/site/training/developer-fundamentals/finalizing-model-documentation.qmd index 4ccc095fdf..7f5723f1e8 100644 --- a/site/training/developer-fundamentals/finalizing-model-documentation.qmd +++ b/site/training/developer-fundamentals/finalizing-model-documentation.qmd @@ -118,7 +118,7 @@ Review test results ::: {.tc} -[Learn more ...](/guide/model-documentation/work-with-test-results.qmd#view-test-result-metadata){.button target="_blank"} +[Learn more ...](/guide/documentation/work-with-test-results.qmd#view-test-result-metadata){.button target="_blank"} ::: @@ -128,7 +128,7 @@ Review test results ::: {.column width="70%" .bl .pl4 .f4} -{{< include /guide/model-documentation/_test-result-metadata.qmd >}} +{{< include /guide/documentation/_test-result-metadata.qmd >}} #### View test result metadata @@ -136,11 +136,11 @@ From the {{< var validmind.platform >}}: 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -2. Select the name of your model you registered for this course to open up the model details page. +2. Select the name of your record you registered for this course to open up the record details page. -3. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +3. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. -{{< include /guide/model-documentation/_view-test-result-metadata.qmd >}} +{{< include /guide/documentation/_view-test-result-metadata.qmd >}} ::: @@ -150,11 +150,11 @@ From the {{< var validmind.platform >}}: :::: {.slideover--b .auto-collapse-10} ::: {.tc} -**Review model documentation** +**Review documented test results** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. Click into any section of the documentation to review the test results logged via the {{< var validmind.developer >}}.
    For example: - **2.3 Correlations and Interactions** - **3.2 Model Evaluation** @@ -174,7 +174,7 @@ Make qualitative edits ::: ::: {.tc} -[Learn more ...](/guide/model-documentation/work-with-content-blocks.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/work-with-content-blocks.qmd){.button target="_blank"} ::: @@ -187,9 +187,9 @@ Make qualitative edits ### Add content blocks -{{< include /guide/model-documentation/_add-content-blocks.qmd >}} +{{< include /guide/documentation/_add-content-blocks.qmd >}} -{{< include /guide/model-documentation/content_blocks/_generate-with-ai.qmd >}} +{{< include /guide/documentation/content_blocks/_generate-with-ai.qmd >}} ### Edit test result descriptions You can also use the content editing toolbar to revise the description of test results to explain the changes made to the raw data and the reasons behind them. @@ -215,8 +215,8 @@ For example: **Add & edit content blocks** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. Click into any section of the documentation to add and edit a content block. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -244,7 +244,7 @@ Use the {{< var vm.checker >}} ::: {.column width="70%" .bl .pl4 .f4} -{{< include /guide/model-documentation/_check-model-documents.qmd >}} +{{< include /guide/documentation/_check-documents.qmd >}} ::: @@ -254,11 +254,11 @@ Use the {{< var vm.checker >}} :::: {.slideover--b .auto-collapse-10} ::: {.tc} -**Check your model documentation** +**Check your documentation** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. Locate the {{< var vm.checker >}} box on the right and click **{{< fa check >}} Check Document**. 4. Select a **[regulation]{.smallcaps}** and an associated **[assessment]{.smallcaps}** from the drop-down menus to to check your document against. 5. Scroll to the bottom and click **Check Document**. @@ -283,7 +283,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. Comment threads ::: {.tc} -[Learn more ...](/guide/model-documentation/collaborate-with-others.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/collaborate-with-others.qmd){.button target="_blank"} :::
    Try it **live** on the next page. {{< fa hand-point-right >}} @@ -293,11 +293,11 @@ Comment threads ::: {.f5 .nt2} ::: -{{< include /guide/model-documentation/_comment-activity.qmd >}} +{{< include /guide/documentation/_comment-activity.qmd >}} ::: {.panel-tabset} -{{< include /guide/model-documentation/_commenting.qmd >}} +{{< include /guide/documentation/_commenting.qmd >}} ::: @@ -309,11 +309,11 @@ Comment threads :::: {.slideover--b .auto-collapse-10} ::: {.tc} -**Comment on model documentation** +**Comment on documentation** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. **In the content block you added earlier**: Post a comment, reply to it, and then resolve the thread. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/developer-fundamentals/learning-to-run-tests.qmd b/site/training/developer-fundamentals/learning-to-run-tests.qmd index 98dff980fb..55426a2661 100644 --- a/site/training/developer-fundamentals/learning-to-run-tests.qmd +++ b/site/training/developer-fundamentals/learning-to-run-tests.qmd @@ -291,9 +291,9 @@ Work with test results ::: ::: {.column width="70%" .bl .pl4 .f4} -#### Add individual test results to model documentation +#### Add individual test results to documentation -{{< include /guide/model-documentation/_add-test-results.qmd >}} +{{< include /guide/documentation/_add-test-results.qmd >}} ::: :::: @@ -305,8 +305,8 @@ Work with test results **Insert a test-driven block** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. Locate the Data Preparation section and click on **2.3 Correlations and Interactions** to expand that section. 4. Hover under the Pearson Correlation Matrix content block until a horizontal line with a **{{< fa plus >}}** button appears, indicating that you can insert a new block. 5. Click **{{< fa plus >}}** and then select **Test-Driven Block** under [from library]{.smallcaps}: diff --git a/site/training/developer-fundamentals/using-validmind-for-model-development.qmd b/site/training/developer-fundamentals/using-validmind-for-model-development.qmd index c68ea3f71e..dda1c92849 100644 --- a/site/training/developer-fundamentals/using-validmind-for-model-development.qmd +++ b/site/training/developer-fundamentals/using-validmind-for-model-development.qmd @@ -240,8 +240,8 @@ When you're done, return to this page and click [{{< fa chevron-right >}}]() to Once you've called `preview_template()`: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your model you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. 3. Note how the structure of the Document Overview reflects the previewed template. When you're done, click [{{< fa chevron-right >}}]() to continue. diff --git a/site/training/program/training-faq.qmd b/site/training/program/training-faq.qmd index f8509eda3e..033b2d631b 100644 --- a/site/training/program/training-faq.qmd +++ b/site/training/program/training-faq.qmd @@ -195,7 +195,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/developer-fundamentals/finalizing-model-documentation.html#/submit-documentation-for-approval){.button-small} [{{< fa book-open >}} docs](/guide/model-documentation/submit-for-approval.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/developer-fundamentals/finalizing-model-documentation.html#/submit-documentation-for-approval){.button-small} [{{< fa book-open >}} docs](/guide/documentation/submit-documents.qmd){.button-small} ::: :::: @@ -235,7 +235,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/validator-fundamentals/finalizing-validation-reports.html#/refine-validation-report){.button-small} [{{< fa book-open >}} docs](/guide/model-validation/preparing-validation-reports.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/validator-fundamentals/finalizing-validation-reports.html#/refine-validation-report){.button-small} [{{< fa book-open >}} docs](/guide/validation/preparing-validation-reports.qmd){.button-small} ::: :::: @@ -247,7 +247,7 @@ Here's what we have been asked about {{< var vm.product >}} during training sess ::: ::: {.w-40-ns .nb3 .pl2} -[{{< fa graduation-cap >}} training](/training/validator-fundamentals/finalizing-validation-reports.html#/submit-report-for-approval){.button-small} [{{< fa book-open >}} docs](/guide/model-documentation/submit-for-approval.qmd){.button-small} +[{{< fa graduation-cap >}} training](/training/validator-fundamentals/finalizing-validation-reports.html#/submit-report-for-approval){.button-small} [{{< fa book-open >}} docs](/guide/documentation/submit-documents.qmd){.button-small} ::: :::: diff --git a/site/training/training-templates/course-slides.qmd b/site/training/training-templates/course-slides.qmd index 12d8a7e460..7115456efc 100644 --- a/site/training/training-templates/course-slides.qmd +++ b/site/training/training-templates/course-slides.qmd @@ -233,7 +233,7 @@ Here you would embed some single-source instructions using Quarto's includes fun #### This is what an `h4` looks like - ![Here's what a `.screenshot` looks like](/guide/model-documentation/add-content-block.gif){.screenshot} + ![Here's what a `.screenshot` looks like](/guide/documentation/add-content-block.gif){.screenshot} Some filler text to demonstrate the scrollable feature: @@ -269,13 +269,13 @@ You can also embed several sets of instructions into the same two-column layout, ::: {.f5 .nt2} ::: -For example, the following links to our [_commenting.qmd](/guide/model-documentation/_commenting.qmd){target="_blank"} single-source include file. +For example, the following links to our [_commenting.qmd](/guide/documentation/_commenting.qmd){target="_blank"} single-source include file. All you need to do is make sure that the headers within `.panel-tabset` are set to `h3` (`###`). ::: {.panel-tabset} -{{< include /guide/model-documentation/_commenting.qmd >}} +{{< include /guide/documentation/_commenting.qmd >}} ::: diff --git a/site/training/validator-fundamentals/developing-challenger-models.qmd b/site/training/validator-fundamentals/developing-challenger-models.qmd index a871339984..8ffa13ebbb 100644 --- a/site/training/validator-fundamentals/developing-challenger-models.qmd +++ b/site/training/validator-fundamentals/developing-challenger-models.qmd @@ -346,7 +346,7 @@ As we can observe from the output in our notebook, our champion model doesn't pa #### Create an artifact via a validation report -{{< include /guide/model-validation/_link-artifacts-to-reports.qmd >}} +{{< include /guide/validation/_link-artifacts-to-reports.qmd >}} ::: :::: diff --git a/site/training/validator-fundamentals/finalizing-validation-reports.qmd b/site/training/validator-fundamentals/finalizing-validation-reports.qmd index c3a514ca25..76b9ff22f9 100644 --- a/site/training/validator-fundamentals/finalizing-validation-reports.qmd +++ b/site/training/validator-fundamentals/finalizing-validation-reports.qmd @@ -131,7 +131,7 @@ Make qualitative edits ::: ::: {.tc} -[Learn more ...](/guide/model-documentation/work-with-content-blocks.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/work-with-content-blocks.qmd){.button target="_blank"} ::: @@ -152,11 +152,11 @@ Make qualitative edits 4. Hover your mouse over the space where you want your new block to go until a horizontal line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block: - ![Adding a content block in the UI](/guide/model-documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} + ![Adding a content block in the UI](/guide/documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI" .screenshot} -After adding the block to your validation report, generate a content draft with AI using the [content editing toolbar](/guide/model-documentation/work-with-content-blocks.qmd#content-editing-toolbar){target="_blank"}: +After adding the block to your validation report, generate a content draft with AI using the [content editing toolbar](/guide/documentation/work-with-content-blocks.qmd#content-editing-toolbar){target="_blank"}: -{{< include /guide/model-documentation/content_blocks/_generate-with-ai.qmd >}} +{{< include /guide/documentation/content_blocks/_generate-with-ai.qmd >}} ### Edit test result descriptions You can also use the content editing toolbar to revise the description of test results to explain the changes made to the raw data and the reasons behind them. @@ -185,8 +185,8 @@ For example: **Add & edit content blocks** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Validation** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Validation** under {{< fa file >}} Documents. 3. Click on **1. Executive Summary** to add and edit a content block. 4. Click on **2.2.1. Data Quality** to edit the description for the linked Class Imbalance Assessment test results. @@ -205,7 +205,7 @@ Assess model compliance ::: ::: {.tc} -[Learn more ...](/guide/model-validation/assess-compliance.qmd#provide-compliance-assessments){.button target="_blank"} +[Learn more ...](/guide/validation/assess-compliance.qmd#provide-compliance-assessments){.button target="_blank"} ::: @@ -232,7 +232,7 @@ Assess model compliance ### Provide compliance assessments -{{< include /guide/model-validation/_provide-compliance-assessments.qmd >}} +{{< include /guide/validation/_provide-compliance-assessments.qmd >}} ::: @@ -275,7 +275,7 @@ Use the {{< var vm.checker >}} ::: {.column width="70%" .bl .pl4 .f4} -{{< include /guide/model-documentation/_check-model-documents.qmd >}} +{{< include /guide/documentation/_check-documents.qmd >}} ::: @@ -312,7 +312,7 @@ Add more artifacts ::: ::: {.tc} -[Learn more ...](/guide/model-validation/add-manage-artifacts.qmd){.button target="_blank"} +[Learn more ...](/guide/validation/add-manage-artifacts.qmd){.button target="_blank"} ::: @@ -326,7 +326,7 @@ Try it **live** on the next pages. {{< fa hand-point-right >}} Along with adding artifacts directly via validation reports, you can also add artifacts during your review of model documentation: -{{< include /guide/model-validation/_add-artifacts-on-documentation.qmd >}} +{{< include /guide/validation/_add-artifacts-on-documentation.qmd >}} ::: :::: @@ -374,7 +374,7 @@ Track issue resolution ::: ::: {.tc} -[Learn more ...](/guide/model-validation/add-manage-artifacts.qmd#track-issue-resolution){.button target="_blank"} +[Learn more ...](/guide/validation/add-manage-artifacts.qmd#track-issue-resolution){.button target="_blank"} :::
    Try it **live** on the next pages. {{< fa hand-point-right >}} @@ -387,13 +387,13 @@ As you prepare your report, review open or past due artifacts, close resolved on ### Update an artifact -{{< include /guide/model-validation/_track-artifact-resolution.qmd >}} +{{< include /guide/validation/_track-artifact-resolution.qmd >}} ### View all artifacts Along with model-specific artifacts, you can also view and filter a list of artifacts across all models within the {{< var validmind.platform >}}: -{{< include /guide/model-validation/_view-all-artifacts.qmd >}} +{{< include /guide/validation/_view-all-artifacts.qmd >}} ::: @@ -446,7 +446,7 @@ When you're done, click [{{< fa chevron-right >}}]() to continue. Comment threads ::: {.tc} -[Learn more ...](/guide/model-documentation/collaborate-with-others.qmd){.button target="_blank"} +[Learn more ...](/guide/documentation/collaborate-with-others.qmd){.button target="_blank"} :::
    Try it **live** on the next page. {{< fa hand-point-right >}} @@ -456,13 +456,13 @@ Comment threads ::: {.f5 .nt2} ::: -{{< include /guide/model-documentation/_comment-activity.qmd >}} +{{< include /guide/documentation/_comment-activity.qmd >}} Have a question about the model? Collaborate with your developer right in the model documentation: ::: {.panel-tabset} -{{< include /guide/model-documentation/_commenting.qmd >}} +{{< include /guide/documentation/_commenting.qmd >}} ::: @@ -477,8 +477,8 @@ Have a question about the model? Collaborate with your developer right in the mo **Comment on a text block** ::: -1. Select the name of your model you registered for this course to open up the model details page. -2. On the left sidebar that appears for your model, click **Validation** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. On the left sidebar that appears for your record, click **Validation** under {{< fa file >}} Documents. 3. **In the content block you added earlier**: Post a comment, reply to it, and then resolve the thread. When you're done, click [{{< fa chevron-right >}}]() to continue. @@ -545,6 +545,6 @@ There is more that {{< var vm.product >}} can do to help you validate models, fr ::: ::: {.tc} -[All model validation guides](/guide/guides.qmd#model-validation){.button target="_blank"} +[All model validation guides](/guide/guides.qmd#validation){.button target="_blank"} ::: \ No newline at end of file diff --git a/site/training/validator-fundamentals/running-data-quality-tests.qmd b/site/training/validator-fundamentals/running-data-quality-tests.qmd index b0fd4711d2..7db2c28985 100644 --- a/site/training/validator-fundamentals/running-data-quality-tests.qmd +++ b/site/training/validator-fundamentals/running-data-quality-tests.qmd @@ -305,7 +305,7 @@ Add test results to reporting ::: {.column width="70%" .bl .pl4 .f4} #### Link validator evidence -{{< include /guide/model-validation/_link-validator-evidence.qmd >}} +{{< include /guide/validation/_link-validator-evidence.qmd >}} ::: diff --git a/site/training/validator-fundamentals/using-validmind-for-model-validation.qmd b/site/training/validator-fundamentals/using-validmind-for-model-validation.qmd index e0163bcb81..778d9310ea 100644 --- a/site/training/validator-fundamentals/using-validmind-for-model-validation.qmd +++ b/site/training/validator-fundamentals/using-validmind-for-model-validation.qmd @@ -293,17 +293,17 @@ When you're done exploring, click [{{< fa chevron-right >}}]() to continue. ## {background-iframe="https://app.prod.validmind.ai/model-inventory" background-interactive="true" data-preload="yes"} :::: {.slideover--r .auto-collapse-10} -**Explore sample model documentation** +**Explore sample documentation** -Typically, a champion model is submitted to you for validation with completed model documentation. +Typically, a champion model is submitted to you for validation with completed documentation. -Here, review the empty sample model documentation for the model you registered earlier to familiarize you with what the structure of documentation could look like when presented to you for review: +Here, review the empty sample documentation for the record you registered earlier to familiarize you with what the structure of documentation could look like when presented to you for review: -1. Select the name of your model you registered for this course to open up the model details page. -2. In the left sidebar that appears for your model, click **Development** under {{< fa file >}} Documents. +1. Select the name of your record you registered for this course to open up the record details page. +2. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents. ::: {.embed} -The structure of the model documentation reflects the documentation template applied to the model, just like the validation report template. +The structure of the documentation reflects the documentation template applied to the record, just like the validation report template. ::: diff --git a/site/training/what-is-validmind/what-is-validmind.qmd b/site/training/what-is-validmind/what-is-validmind.qmd index 6cccc4681c..e2d558ca25 100644 --- a/site/training/what-is-validmind/what-is-validmind.qmd +++ b/site/training/what-is-validmind/what-is-validmind.qmd @@ -536,7 +536,7 @@ The [{{< var validmind.developer >}}]{style="background-color: #eaf9fb; padding: 3. Add your own tests, add new sections, or create custom templates. 4. Save time with reusable content blocks in the online editor. -[[{{< fa circle-info >}}  On Documentation]{.button .button-light-green .shadow-5-ns}](/guide/model-documentation/working-with-model-documentation.qmd){target="_blank"}   [[{{< fa circle-info >}}  On Templates]{.button .button-light-green .shadow-5-ns}](/guide/templates/working-with-document-templates.qmd){target="_blank"} +[[{{< fa circle-info >}}  On Documentation]{.button .button-light-green .shadow-5-ns}](/guide/documentation/working-with-documentation.qmd){target="_blank"}   [[{{< fa circle-info >}}  On Templates]{.button .button-light-green .shadow-5-ns}](/guide/templates/working-with-document-templates.qmd){target="_blank"} ::: @@ -632,7 +632,7 @@ Use the same [{{< var validmind.developer >}}]{style="background-color: #eaf9fb; ::: {.slideover--b .auto-collapse} ::: {.tc} -[[{{< fa circle-info >}} How do I prepare validation reports?]{.button .button-light-green .shadow-5-ns}](/guide/model-validation/preparing-validation-reports.qmd){target="_blank"} +[[{{< fa circle-info >}} How do I prepare validation reports?]{.button .button-light-green .shadow-5-ns}](/guide/validation/preparing-validation-reports.qmd){target="_blank"} ::: @@ -872,7 +872,7 @@ Use {{< var vm.product >}}'s {{< var vm.checker >}} to: ::: {.slideover--b .auto-collapse} ::: {.tc .nt4} -[[{{< fa circle-info >}} How do I use the {{< var vm.checker >}}?]{.button .button-light-green .shadow-5-ns}](/guide/model-documentation/check-documents-for-compliance.qmd){target="_blank"} +[[{{< fa circle-info >}} How do I use the {{< var vm.checker >}}?]{.button .button-light-green .shadow-5-ns}](/guide/documentation/check-documents-for-compliance.qmd){target="_blank"} ::: :::