validmind
diff --git a/‎site/Makefile
Lines changed: 10 additions & 0 deletions b/‎site/Makefile
Lines changed: 10 additions & 0 deletions
diff --git a/‎site/guide/model-documentation/_customize-documentation-templates-simplified.qmd
Lines changed: 2 additions & 0 deletions b/‎site/guide/model-documentation/_customize-documentation-templates-simplified.qmd
Lines changed: 2 additions & 0 deletions
diff --git a/‎site/guide/model-documentation/_view-documentation-activity-overview.qmd
Lines changed: 21 additions & 0 deletions b/‎site/guide/model-documentation/_view-documentation-activity-overview.qmd
Lines changed: 21 additions & 0 deletions
diff --git a/‎site/guide/model-documentation/_view-documentation-activity-steps.qmd
Lines changed: 20 additions & 0 deletions b/‎site/guide/model-documentation/_view-documentation-activity-steps.qmd
Lines changed: 20 additions & 0 deletions
diff --git a/‎site/guide/model-documentation/view-documentation-activity.qmd
Lines changed: 84 additions & 0 deletions b/‎site/guide/model-documentation/view-documentation-activity.qmd
Lines changed: 84 additions & 0 deletions
diff --git a/‎site/guide/model-validation/_work-with-model-findings-add-findings.qmd
Lines changed: 22 additions & 0 deletions b/‎site/guide/model-validation/_work-with-model-findings-add-findings.qmd
Lines changed: 22 additions & 0 deletions
diff --git a/‎site/guide/model-validation/add-update-model-findings.qmd
Lines changed: 138 additions & 0 deletions b/‎site/guide/model-validation/add-update-model-findings.qmd
Lines changed: 138 additions & 0 deletions
@@ -120,6 +120,16 @@ deploy-staging:
 		quarto render --profile staging && aws s3 sync ./_site s3://docs-ci-cd-staging/site/ --delete && aws cloudfront create-invalidation --distribution-id E2FB73KGY63MV6 --paths "/*" --no-cli-pager > /dev/null; \
 	fi
 
+# Deployment to https://docs.validmind.ai/
+# TO DO Fix Cloudfront distribution ID
+deploy-staging:
+	@if [ "`git rev-parse --abbrev-ref HEAD`" != "nrichers/sc-6277/deploy-staging-docs-site-workflow" ]; then \
+		echo "You're not on the staging branch, no action taken."; \
+	else \
+		echo "\nDeploying staging site ..."; \
+		quarto render && aws s3 sync ./_site s3://docs-ci-cd-staging/site/ --delete && aws cloudfront create-invalidation --distribution-id E2FB73KGY63MV6 --paths "/*" --no-cli-pager > /dev/null; \
+	fi
+
 # Generate release notes
 release-notes:
 	@python ../release-scripts/generate_release_objects.py
@@ -88,4 +88,6 @@
 
 ::::
 
+::::
+
 Once saved, your new template version becomes available for use.
@@ -0,0 +1,21 @@
+ The **Model Activity** page shows a record of all activities, including actions performed by users in your organization and updates generated via the {{< var vm.developer >}} such as:
+
+:::: {.content-visible unless-format="revealjs"} 
+- Inventory fields updated on the model^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)]
+- 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^[[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)]
+
+::::
+
+:::: {.content-hidden unless-format="revealjs"}
+- Inventory fields updated on the model
+- Model or documentation status transitions
+- Updates to model documentation, validation reports, or ongoing monitoring reports
+- Test results added to your model
+- Findings added, updated, or removed
+- Comment creation and replies
+
+::::
@@ -0,0 +1,20 @@
+To view model activity:
+
+:::: {.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 expanded sidebar that appears for your model, click **Model Activity**.
+
+::::
+
+:::: {.content-hidden 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](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models).
+
+1. In the expanded sidebar that appears for your model, click **Model Activity**.
+::::
+
+
@@ -0,0 +1,84 @@
+---
+title: "View documentation activity"
+date: last-modified
+---
+
+Use the audit trail functionality in the {{< var validmind.platform >}} to track or audit all the information events associated with a specific model.
+
+::: {.prereq}
+
+## Prerequisites
+
+<!-- ::: {.callout}
+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] A model developer has started generating documentation, either using the {{< var vm.developer >}}[^2] or via the online UI editor.
+
+:::
+
+## Model Activity
+
+{{< include _view-documentation-activity-overview.qmd >}}
+
+{{< include _view-documentation-activity-steps.qmd >}}
+
+### Filter activity
+
+Use the top tabs to narrow down model activity.
+
+#### All
+
+Default view; shows all activity.
+
+#### Comments
+
+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.[^4]
+
+#### Project updates
+
+Shows project level updates:
+
+- 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
+
+- [Working with model documentation](working-with-model-documentation.qmd)
+- [Collaborate on documentation](collaborate-with-others.qmd)
+
+
+<!-- FOOTNOTES -->
+
+[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
+
+[^2]: [{{< var validmind.developer >}}](/developer/get-started-developer-framework.qmd)
+
+[^3]: [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]: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)
+
+[^6]: [Working with model documentation](working-with-model-documentation.qmd)
+
+[^7]: [Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)
+
+[^8]: [ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)
+
+[^9]: [Working with model findings](/guide/model-validation/working-with-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. 
+
+::::
+
+
+
@@ -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)
-Original file line number
+Diff line change
 ::::
 +::::
++
 Once saved, your new template version becomes available for use.