Merge main into staging

site/_quarto.yml

@@ -244,8 +244,8 @@ website:
           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
+          - text: "Add and manage findings"
+            file: guide/model-validation/add-manage-model-findings.qmd
         - guide/model-validation/view-reports.qmd
         - guide/model-documentation/export-documentation.qmd
         - text: "---"

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/add-update-model-findings.qmd)] 
+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-manage-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/add-update-model-findings.qmd). 
+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-manage-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/add-update-model-findings.qmd)] 
+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-manage-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/add-update-model-findings.qmd). 
+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-manage-model-findings.qmd). 
 
 1. Click **Update Linked Findings**.
 

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

@@ -0,0 +1,158 @@
+---
+title: "Add and manage model findings"
+date: last-modified
+---
+
+Add findings within the {{< var validmind.platform >}} at the model or documentation section level, update your findings to include proposed remediation plans and supporting documentation, or delete findings that no longer need to be tracked.
+
+::: {.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"}
+
+## Delete model findings
+
+::: {.callout-important title="Finding deletion is permanent."}
+While finding deletion will be logged under your Model Activity,[^8] deleted findings cannot be retrieved.
+:::
+
+If you logged a finding in error or otherwise no longer need to track that finding, you can delete it: 
+
+1. Locate the finding you want to delete.[^9]
+
+2. On the finding's detail page, click **{{< fa trash-can>}} Delete Finding** in the right sidebar.
+
+   Once you confirm, the finding will be permanently deleted. 
+
+   ![](delete-model-finding.gif){width=80% fig-alt="An animated gif demonstrating how to delete 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)
+
+[^8]: [View documentation activity](/guide/model-documentation/view-documentation-activity.qmd)
+
+[^9]: [View and filter model findings](view-filter-model-findings.qmd)

site/guide/model-validation/view-filter-model-findings.qmd

@@ -123,8 +123,8 @@ Filters can be removed by clicking on the {{< fa xmark >}} next to them on the m
 
 [^4]: [Filter model findings](#filter-model-findings)
 
-[^5]: [Manage supporting documentation](add-update-model-findings.qmd#manage-supporting-documentation)
+[^5]: [Manage supporting documentation](add-manage-model-findings.qmd#manage-supporting-documentation)
 
 [^6]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
 
-[^7]: [Manage supporting documentation](add-update-model-findings.qmd#manage-supporting-documentation)
+[^7]: [Manage supporting documentation](add-manage-model-findings.qmd#manage-supporting-documentation)

site/guide/model-validation/working-with-model-findings.qmd

@@ -10,7 +10,7 @@ listing:
     fields: [title, description]
     contents:
       - view-filter-model-findings.qmd
-      - add-update-model-findings.qmd
+      - add-manage-model-findings.qmd
 filters:
   - tachyons
 ---