Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/faq/faq-testing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Check out our introductory series — [**{{< var vm.product >}} for validation**

[^12]: [Manage record stakeholder types](/guide/configuration/manage-record-stakeholder-types.qmd)

[^13]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-validator-evidence)
[^13]: [Assess compliance](/guide/validation/assess-compliance.qmd#map-evidence)

[^14]: [Can we configure, customize, or add our own tests?](#can-we-configure-customize-or-add-our-own-tests)

Expand Down
12 changes: 6 additions & 6 deletions site/get-started/validator/quickstart-validator.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ After you successfully run the notebook, return to the {{< var validmind.platfor

- Your validation report is broken down into sections, defined by your report templates.[^3]
- The report includes risk assessment summaries at the overall and per-section level, overviews of your compliance assessments provided within your validation report.[^4]
- Each sub-section allows you to attach test results as evidence,[^5] as well as log artifacts based on your evaluation of datasets or records.[^6]
- Each sub-section (or guideline) allows you to attach test results as evidence,[^5] as well as log artifacts based on your evaluation of datasets or records.[^6]

:::: {.flex .flex-wrap .justify-around}

Expand All @@ -138,13 +138,13 @@ After you successfully run the notebook, return to the {{< var validmind.platfor

#### Add evidence to your report

Expand any section of the validation report to attach your test results and drafts of test result summaries generated by the {{< var validmind.developer >}} as evidence by clicking on **{{< fa link >}} Link Evidence to Report**.
Expand any section of the validation report to attach your test results and drafts of test result summaries generated by the {{< var validmind.developer >}} as evidence by clicking **Evidence** on any guideline to expand the evidence panel.

For example:

1. Locate the 2.2.1. Data Quality section and click on **Class Imbalance Assessment**.
1. Within your validation report, click on **Class Imbalance Assessment**.

2. Under the Class Imbalance Assessment sub-section, locate Validator Evidence then click **{{< fa link >}} Link Evidence to Report**.
2. Under the Class Imbalance Assessment guideline click **{{< fa link >}} Link Evidence**, then select **Validator Evidence** as the [evidence type]{.smallcaps}.

3. Select the Class Imbalance test results we logged: **ValidMind Data Validation Class Imbalance**

Expand Down Expand Up @@ -173,9 +173,9 @@ Now that you've grasped the basics of using {{< var vm.product >}} for validatio

[^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd)

[^4]: [Assess compliance](/guide/validation/assess-compliance.qmd#provide-compliance-assessments)
[^4]: [Assess compliance](/guide/validation/assess-compliance.qmd#assign-compliance-assessments)

[^5]: [Assess compliance](/guide/validation/assess-compliance.qmd#link-validator-evidence)
[^5]: [Assess compliance](/guide/validation/assess-compliance.qmd#map-evidence)

[^6]: [Add and manage artifacts](/guide/validation/add-manage-artifacts.qmd#add-artifacts-on-validation-reports)

Binary file modified site/guide/documentation/content-editing-toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 34 additions & 31 deletions site/guide/documentation/work-with-content-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ The content editing toolbar is a rich text editor that enables you to:
- Format your text, including adding hyperlinks and code blocks
- Reference related record and artifact field values with variables[^2]
- Insert LaTex formulas[^3]
- Reference other sections of the document[^4]
- Attach images via upload or URL

You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^4]
You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^5]

::: {.callout title="Stuck on where to start?"}
Use {{< var vm.product >}} to assist you with generating content via AI!^[[Generate content drafts with AI](#generate-content)]
Expand All @@ -58,9 +59,9 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener
## Prerequisites

- [x] {{< var link.login >}}
- [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]
- [x] There are records registered in the inventory.[^6]
- [x] Documents exist and are completed or are in progress for your record.[^7]
- [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.[^8]

:::

Expand All @@ -79,26 +80,26 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener

#### [from library]{.smallcaps}
Text Block
: Inserts a text block from a template in your block library:[^8]
: Inserts a text block from a template in your block library:[^9]
a. Select the reusable blocks you want to add.
b. Click **Insert # Text Block(s) to Document**.

Test-Driven[^9]
Test-Driven[^10]
: Adds a new section with logged test results.

Metric Over Time[^10]
Metric Over Time[^11]
: Adds a new section with logged metric over time results.

:::

7. After adding the block to your document, click on the text to make changes or add comments.[^11]
7. After adding the block to your document, click on the text to make changes or add comments.[^12]

### Reference field values

While editing a simple text block within documents, you can reference values in the form of variables from:

::: {.callout}
- To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^12]
- To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^13]
- 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.

:::
Expand All @@ -118,8 +119,8 @@ While editing a simple text block within documents, you can insert math equation
While editing a simple text block within documents, you can have {{< var vm.product >}} assist you with generating content drafts.

::: {.callout title="How can generate content drafts with AI?"}
- To use the generate content drafts with AI feature, your organization must not have tracked changes enabled by default.[^13]
- Generating content drafts works best after you've logged tests with the {{< var validmind.developer >}},[^14] as existing test descriptions and results provide more context for the {{< var vm.product >}} AI Content Builder to draw upon.
- To use the generate content drafts with AI feature, your organization must not have tracked changes enabled by default.[^14]
- Generating content drafts works best after you've logged tests with the {{< var validmind.developer >}},[^15] as existing test descriptions and results provide more context for the {{< var vm.product >}} AI Content Builder to draw upon.

:::

Expand All @@ -128,7 +129,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 >}} 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[^16] just like other updates to your documents.

<br>

Expand Down Expand Up @@ -176,7 +177,7 @@ While editing a simple text block within documents, you can directly reference o

:::

Hyperlinks will also take you to the referenced section in PDF document exports.[^16]
Hyperlinks will also take you to the referenced section in PDF document exports.[^17]

## Remove content blocks

Expand All @@ -186,11 +187,11 @@ 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 record or find your record by applying a filter or searching for it.[^17]
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 record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^18]
3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^19]

4. Click on the document file you want to remove a block from.[^19]
4. Click on the document file you want to remove a block from.[^20]

5. Click on a section header to expand that section and remove content.

Expand All @@ -209,34 +210,36 @@ Test-driven or metric over time blocks can be re-added later on but **text block

[^3]: [Insert mathematical formulas](#insert-mathematical-formulas)

[^4]: [Collaborate with others](collaborate-with-others.qmd)
[^4]: [Reference document sections](#reference-document-sections)

[^5]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)
[^5]: [Collaborate with others](collaborate-with-others.qmd)

[^6]: [Working with documents](/guide/templates/working-with-documents.qmd)
[^6]: [Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)

[^7]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
[^7]: [Working with documents](/guide/templates/working-with-documents.qmd)

[^8]: [Manage text block library](/guide/templates/manage-text-block-library.qmd)
[^8]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^9]: [Work with test results](/guide/documentation/work-with-test-results.qmd)
[^9]: [Manage text block library](/guide/templates/manage-text-block-library.qmd)

[^10]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd)
[^10]: [Work with test results](/guide/documentation/work-with-test-results.qmd)

[^11]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd)
[^11]: [Work with metrics over time](/guide/monitoring/work-with-metrics-over-time.qmd)

[^12]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults)
[^12]: [Collaborate with others](/guide/documentation/collaborate-with-others.qmd)

[^13]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults)

[^14]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)
[^14]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults)

[^15]: [View model activity](/guide/inventory/view-record-activity.qmd)
[^15]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^16]: [Export documents](/guide/reporting/export-documents.qmd)
[^16]: [View model activity](/guide/inventory/view-record-activity.qmd)

[^17]: [Working with the model inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-models)
[^17]: [Export documents](/guide/reporting/export-documents.qmd)

[^18]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd)
[^18]: [Working with the model inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-models)

[^19]: [Working with documents](/guide/templates/working-with-documents.qmd)
[^19]: [Work with document versions](/guide/documentation/work-with-document-versions.qmd)

[^20]: [Working with documents](/guide/templates/working-with-documents.qmd)
18 changes: 6 additions & 12 deletions site/guide/validation/_add-artifacts-on-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,26 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

1. On the modal that opens, provide information for your artifact.

1. When you are done, click **Save** to submit the artifact.
1. When you are done, click **Add {Artifact Type}** where `{Artifact Type}` is the artifact type you want to add 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.
a. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents.

<!-- Either log an artifact on this overview page, or via a specific documentation section. Both methods will allow you to associate an artifact with a documentation section. -->

1. On your record's documentation page, click **{{< fa plus >}} Add Artifact**.
b. 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:
c. 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.
d. On the modal that opens, provide information for your artifact.

1. When you are done, click **Save** to submit the artifact.
e. When you are done, click **Add {Artifact Type}** where `{Artifact Type}` is the artifact type you want to add 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"}.

Expand Down
Loading