Merge main into staging

site/_quarto.yml

@@ -240,7 +240,12 @@ website:
           - guide/model-documentation/work-with-content-blocks.qmd
           - guide/model-documentation/collaborate-with-others.qmd
           - guide/model-documentation/submit-for-approval.qmd
-        - guide/model-validation/work-with-model-findings.qmd
+        - file: guide/model-validation/working-with-model-findings.qmd
+          contents:
+          - text: "View and filter findings"
+            file: guide/model-validation/view-filter-model-findings.qmd
+          - text: "Add and update findings"
+            file: guide/model-validation/add-update-model-findings.qmd
         - guide/model-validation/view-reports.qmd
         - guide/model-documentation/export-documentation.qmd
         - text: "---"

site/guide/guides.qmd

@@ -60,7 +60,7 @@ listing:
     contents: 
     - model-validation/manage-validation-guidelines.qmd
     - model-validation/preparing-validation-reports.qmd
-    - model-validation/work-with-model-findings.qmd
+    - model-validation/working-with-model-findings.qmd
     - model-validation/view-reports.qmd
     - model-documentation/export-documentation.qmd
     type: grid

site/guide/model-documentation/_model-documentation-overview.qmd

@@ -2,7 +2,7 @@
 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 findings^[[Work with model findings](/guide/model-validation/work-with-model-findings.qmd)]
+- The number of model findings^[[Working with model findings](/guide/model-validation/working-with-model-findings.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 documentation activity](/guide/model-documentation/view-documentation-activity.qmd)]
 

site/guide/model-documentation/_view-documentation-activity-overview.qmd

@@ -5,7 +5,7 @@
 - Model status transitions^[[Working with model workflows](/guide/model-workflows/working-with-model-workflows.qmd)]
 - Updates to model documentation, validation reports,^[[Working with model documentation](working-with-model-documentation.qmd)] or ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
 - Test results added to your model^[[ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)]
-- Findings added, updated, or removed^[[Work with model findings](/guide/model-validation/work-with-model-findings.qmd)]
+- Findings added, updated, or removed^[[Working with model findings](/guide/model-validation/working-with-model-findings.qmd)]
 - Comment creation and replies^[[Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting)]
 
 ::::

site/guide/model-documentation/collaborate-with-others.qmd

@@ -81,7 +81,7 @@ Use the real-time collaboration features to track changes, add comments, and acc
 ## What's next
 
 * [Preparing validation reports](/guide/model-validation/preparing-validation-reports.qmd)
-* [Work with model findings](/guide/model-validation/work-with-model-findings.qmd)
+* [Working with model findings](/guide/model-validation/working-with-model-findings.qmd)
 
 
 <!-- FOOTNOTES -->

site/guide/model-documentation/view-documentation-activity.qmd

@@ -15,8 +15,7 @@ This topic matters for model developers, model validators, and auditors.
 
 - [x] {{< var link.login >}}
 - [x] The model you are documenting is registered in the model inventory.[^1]
-- [x] Model documentation has already been created for this project.[^2]
-- [x] A model developer has started generating documentation, either using the {{< var vm.developer >}}[^3] or via the online UI editor.
+- [x] A model developer has started generating documentation, either using the {{< var vm.developer >}}[^2] or via the online UI editor.
 
 :::
 
@@ -36,24 +35,24 @@ Default view; shows all activity.
 
 #### Comments
 
-Shows only comments created or replied to; shows all comments by default.[^4]
+Shows only comments created or replied to; shows all comments by default.[^3]
 
 Toggle mentions
 : - Untoggle [**show all comments**]{.smallcaps} to see only comments you're mentioned in.
 - Toggle [**show only mentions**]{.smallcaps} to show all comments again.
 
 #### Status updates
 
-Shows model status transitions.[^5]
+Shows model status transitions.[^4]
 
 #### Project updates
 
 Shows project level updates:
 
-- Inventory fields updated on the model[^6]
-- Updates to model documentation, validation reports,[^7] or ongoing monitoring reports[^8]
-- Test results added to your model[^9]
-- Findings added, updated, or removed[^10]
+- Inventory fields updated on the model[^5]
+- Updates to model documentation, validation reports,[^6] or ongoing monitoring reports[^7]
+- Test results added to your model[^8]
+- Findings added, updated, or removed[^9]
 
 
 ## What's next
@@ -66,22 +65,20 @@ Shows project level updates:
 
 [^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
 
-[^2]: [Working with model documentation](working-with-model-documentation.qmd)
+[^2]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)
 
-[^3]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)
+[^3]: [Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting)
 
-[^4]: [Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting)
+[^4]: [Working with model workflows](/guide/model-workflows/working-with-model-workflows.qmd)
 
-[^5]: [Working with model workflows](/guide/model-workflows/working-with-model-workflows.qmd)
+[^5]: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)
 
-[^6]: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)
+[^6]: [Working with model documentation](working-with-model-documentation.qmd)
 
-[^7]: [Working with model documentation](working-with-model-documentation.qmd)
+[^7]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
 
-[^8]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
+[^8]: [ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)
 
-[^9]: [ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)
-
-[^10]: [Work with model findings](/guide/model-validation/work-with-model-findings.qmd)
+[^9]: [Working with model findings](/guide/model-validation/working-with-model-findings.qmd)
 
 

site/guide/model-documentation/view-documentation-guidelines.qmd

@@ -11,7 +11,7 @@ View the guidelines for model documentation associated with a template to ensure
 
 - [x] {{< var link.login >}}
 - [x] The model you are documenting is registered in the model inventory.[^1]
-- [x] Model documentation has already been created for this project.[^2]
+- [x] Model documentation has already been created for this model.[^2]
 - [x] A model developer has started generating documentation, either using the {{< var validmind.developer >}}[^3] or via the online editor in the {{< var validmind.platform >}}.
 - [x] You are a `Developer` or assigned another role with sufficient permissions to perform the tasks in this guide.[^4]
 

site/guide/model-validation/_add-model-findings.qmd

@@ -0,0 +1,22 @@
+:::: {.content-visible unless-format="revealjs"}
+1. In the left sidebar, click **Model Inventory**.
+
+1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]
+
+1. In the left sidebar that appears for your model, click **Documentation**. 
+
+    You can now either log a finding on this overview page, or via a specific documentation section. Both methods will allow you to associate a finding with a documentation section. 
+
+::::
+
+:::: {.content-hidden unless-format="revealjs"}
+1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
+
+1. In the left sidebar that appears for your model, click **Documentation**. 
+
+    You can now either log a finding on this overview page, or via a specific documentation section. Both methods will allow you to associate a finding with a documentation section. 
+
+::::
+
+
+

site/guide/model-validation/_assess-compliance-assess.qmd

@@ -20,7 +20,7 @@
 
    ![](/guide/model-validation/assess-compliance.png){width=60% fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to finding"}
 
-1. On the **Link Finding to Report** page that opens, select from the list of available findings, or create a new finding.^[[Create new finding](/guide/model-validation/work-with-model-findings.qmd#add-project-findings)] 
+1. On the **Link Finding to Report** page that opens, select from the list of available findings, or create a new finding.^[[Create new finding](/guide/model-validation/add-update-model-findings.qmd)] 
 
 1. Under **Risk Assessment Notes**, add any relevant notes that explain your assessment further. 
 
@@ -51,7 +51,7 @@ A compliance summary gets shown for each subsection under **2. Validation** and
 
    ![](/guide/model-validation/assess-compliance.png){width=60% fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to finding"}
 
-1. On the **Link Finding to Report** page that opens, select from the list of available findings, or [create a new finding](/guide/model-validation/work-with-model-findings.qmd#add-project-findings). 
+1. On the **Link Finding to Report** page that opens, select from the list of available findings, or [create a new finding](/guide/model-validation/add-update-model-findings.qmd). 
 
 1. Under **Risk Assessment Notes**, add any relevant notes that explain your assessment further. 
 

site/guide/model-validation/_assess-compliance-link-finding.qmd

@@ -13,7 +13,7 @@
 
    ![](/guide/model-validation/link-finding.png){width=60% fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to finding"}
 
-1. On the **Link Finding to Report** page that opens, select from the list of available findings, or create a new finding.^[[Create new finding](/guide/model-validation/work-with-model-findings.qmd#add-project-findings)] 
+1. On the **Link Finding to Report** page that opens, select from the list of available findings, or create a new finding.^[[Create new finding](/guide/model-validation/add-update-model-findings.qmd)] 
 
 1. Click **Update Linked Findings**.
 
@@ -34,7 +34,7 @@ The newly linked-to finding now gets shown under **Findings**.
 
    ![](/guide/model-validation/link-finding.png){width=60% fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to finding"}
 
-1. On the **Link Finding to Report** page that opens, select from the list of available findings, or [create a new finding](/guide/model-validation/work-with-model-findings.qmd#add-project-findings). 
+1. On the **Link Finding to Report** page that opens, select from the list of available findings, or [create a new finding](/guide/model-validation/add-update-model-findings.qmd). 
 
 1. Click **Update Linked Findings**.
 

site/guide/model-validation/add-update-model-findings.qmd

@@ -0,0 +1,138 @@
+---
+title: "Add and update model findings"
+date: last-modified
+---
+
+Add findings within the {{< var validmind.platform >}} at the model or documentation section level, and update your findings to include proposed remediation plans and supporting documentation.
+
+::: {.prereq}
+
+## Prerequisites
+
+- [x] {{< var link.login >}}
+- [x] The model is already registered in the model inventory.[^1]
+- [x] Model documentation is completed or in progress for your model.[^2]
+- [x] You are a `Validator` or assigned another role with sufficient permissions to perform the tasks in this guide.[^3] 
+
+:::
+
+## Add model findings
+
+{{< include _add-model-findings.qmd >}}
+
+#### Add finding via overview
+
+To log a finding from the documentation overview: 
+
+1. On your model's **Documentation** page, click **{{< fa plus >}} Add Finding**.
+
+2. On the **Add Model Finding** page that opens, provide information for: 
+
+   - Title
+   - Risk area
+   - Owner
+   - Severity
+   - Due date
+   - Documentation section
+   - Description
+
+3. When you are done, click **Save** to submit the finding. 
+
+   Once created, you can then add supporting documentation to your finding.[^4]
+
+#### Add finding via section
+
+While working within a section of your documentation, you can easily log a finding associated with that section without leaving the page:
+
+1. Click on **ValidMind Insights™** to expand the insight panel.
+
+2. For the section you want to add a Finding for, click **{{< fa triangle-exclamation >}}  Add Finding** beneath the Documentation Guidelines.
+
+3. On the **Add Model Finding** page that opens,  provide information for: 
+
+   - Title
+   - Risk area
+   - Owner
+   - Severity
+   - Due date
+   - Documentation section
+   - Description
+
+   The documentation section will be auto-populated with the section you are working from — you are able to select another section if desired.
+
+   ![](add-section-finding.gif){width=80% fig-alt="An animated gif demonstrating how to add a finding with the ValidMind Insights™ panel"}
+
+4. When you are done, click **Save** to submit the finding. 
+
+   Once created, you can then add supporting documentation to your finding.[^5]
+
+## Update model findings
+
+As findings get resolved or require other changes during the model validation process, you can update them:
+
+1. Locate the finding you want to update.[^6]
+
+2. Click on a field to make changes. You can make updates to:
+
+   - Title
+   - Description
+   - Proposed remediation plan
+   - Supporting documentation[^7]
+   - Status
+   - Severity
+   - Risk area
+   - Due date
+   - Assignee
+   - Documentation section
+
+   You can also add comments to a finding. 
+
+Most updates are applied immediately but you must click **Save** to make changes to the finding title, description, proposed remediation plan, and attachments effective. 
+
+### Manage supporting documentation
+
+After a finding is created, you're able to add supporting documentation to it. 
+
+#### Add attachment to finding
+
+::: {.callout}
+Uploaded files must be less than 50 MB in size.
+:::
+
+1. On the findings detail page, click on the **[attachments]{.smallcaps}** header.
+
+2. Click **{{< fa circle-plus >}} Add Attachment** to select a file.
+
+3. Click **Save** to submit the upload.
+
+#### Remove attachment from finding
+
+1. On the findings detail page, click on the **[attachments]{.smallcaps}** header.
+
+2. Locate the file you want to remove.
+
+   - Click **{{< fa trash-can>}}** to remove the file. 
+   - After you confirm, the attachment will be removed from the list.
+
+3. Click **Save** to apply the deletion. 
+
+   After you save, the attachment will be removed permanently.
+
+![](delete-finding-attachment.gif){width=80% fig-alt="An animated gif demonstrating how to delete an attachment from a finding"}
+
+
+<!-- FOOTNOTES -->
+
+[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
+
+[^2]: [Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)
+
+[^3]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
+
+[^4]: [Manage supporting documentation](#manage-supporting-documentation)
+
+[^5]: [Manage supporting documentation](#manage-supporting-documentation)
+
+[^6]: [View and filter model findings](view-filter-model-findings.qmd)
+
+[^7]: [Manage supporting documentation](#manage-supporting-documentation)

site/guide/model-validation/assess-compliance.qmd

@@ -31,7 +31,7 @@ To provide an unbiased starting point that enables more efficient discussions be
 ## What's next
 
 - [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)
-- [Work with model findings](work-with-model-findings.qmd)
+- [Working with model findings](working-with-model-findings.qmd)
 - [Assign section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd)
 - [View documentation activity](/guide/model-documentation/view-documentation-activity.qmd)
 

site/guide/model-validation/manage-validation-guidelines.qmd

@@ -99,10 +99,9 @@ By default, the `Customer Admin` role has all these permissions.[^4]
 
 ## What's next
 
-<!---* [Create project findings](create-project-findings.qmd)--->
 - [Preparing validation reports](preparing-validation-reports.qmd)
 - [Assess compliance](assess-compliance.qmd)
-- [Work with model findings](work-with-model-findings.qmd)
+- [Working with model findings](working-with-model-findings.qmd)
 
 <!-- FOOTNOTES -->
 

site/guide/model-validation/review-model-documentation.qmd

@@ -46,7 +46,7 @@ Click on **{{< fa eye >}} See all Activity** to be taken to the **Model Activity
 
 ## What's next
 - [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)
-- [Work with model findings](work-with-model-findings.qmd)
+- [Working with model findings](working-with-model-findings.qmd)
 - [Assign section statuses](/guide/model-documentation/assign-documentation-section-statuses.qmd)
 - [View documentation activity](/guide/model-documentation/view-documentation-activity.qmd)