You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Updated evidence & artifact linking on validation reports (#1343)
* WIP
* Edit: Map and assess evidence
* WIP: Assess compliance
* save
* Assess compliance: Link evidence to reports
* Rename: Provide compliance assessments > Assign compliance assessments
* Edit: Link artifacts to reports
* save
* save
* oops, edited the notebooks not in the source, reverting
* Shuffling Validator 4 training around
* autogenerate single-source setup
* edit
* save
* Refine validation report
* save
* save
* Edit: Running data quality tests
* Edit: Map and assess evidence > Map evidence to guidelines
* Edit: Map and assess evidence > Assess evidence for compliance
* save
* save
* save
* Edit: Add and manage artifacts
* proofread
* more proofreading
* proofreading Validator Fundamentals
* proofread
* ...
* Pulling in updated notebooks
* tweak
* edits
* edit
* oops
* Fixing typo
* Finetune
Copy file name to clipboardExpand all lines: site/get-started/validator/quickstart-validator.qmd
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -118,7 +118,7 @@ After you successfully run the notebook, return to the {{< var validmind.platfor
118
118
119
119
- Your validation report is broken down into sections, defined by your report templates.[^3]
120
120
- The report includes risk assessment summaries at the overall and per-section level, overviews of your compliance assessments provided within your validation report.[^4]
121
-
- 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]
121
+
- 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]
122
122
123
123
:::: {.flex .flex-wrap .justify-around}
124
124
@@ -138,13 +138,13 @@ After you successfully run the notebook, return to the {{< var validmind.platfor
138
138
139
139
#### Add evidence to your report
140
140
141
-
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**.
141
+
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.
142
142
143
143
For example:
144
144
145
-
1.Locate the 2.2.1. Data Quality section and click on **Class Imbalance Assessment**.
145
+
1.Within your validation report, click on **Class Imbalance Assessment**.
146
146
147
-
2. Under the Class Imbalance Assessment sub-section, locate Validator Evidence then click **{{< fa link >}} Link Evidence to Report**.
147
+
2. Under the Class Imbalance Assessment guideline click **{{< fa link >}} Link Evidence**, then select **Validator Evidence** as the [evidence type]{.smallcaps}.
148
148
149
149
3. Select the Class Imbalance test results we logged: **ValidMind Data Validation Class Imbalance**
150
150
@@ -173,9 +173,9 @@ Now that you've grasped the basics of using {{< var vm.product >}} for validatio
173
173
174
174
[^3]: [Working with document templates](/guide/templates/working-with-document-templates.qmd)
Copy file name to clipboardExpand all lines: site/guide/documentation/work-with-content-blocks.qmd
+34-31Lines changed: 34 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -45,9 +45,10 @@ The content editing toolbar is a rich text editor that enables you to:
45
45
- Format your text, including adding hyperlinks and code blocks
46
46
- Reference related record and artifact field values with variables[^2]
47
47
- Insert LaTex formulas[^3]
48
+
- Reference other sections of the document[^4]
48
49
- Attach images via upload or URL
49
50
50
-
You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^4]
51
+
You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^5]
51
52
52
53
::: {.callout title="Stuck on where to start?"}
53
54
Use {{< var vm.product >}} to assist you with generating content via AI!^[[Generate content drafts with AI](#generate-content)]
@@ -58,9 +59,9 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener
58
59
## Prerequisites
59
60
60
61
-[x] {{< var link.login >}}
61
-
-[x] There are records registered in the inventory.[^5]
62
-
-[x] Documents exist and are completed or are in progress for your record.[^6]
63
-
-[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]
62
+
-[x] There are records registered in the inventory.[^6]
63
+
-[x] Documents exist and are completed or are in progress for your record.[^7]
64
+
-[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]
64
65
65
66
:::
66
67
@@ -79,26 +80,26 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener
79
80
80
81
#### [from library]{.smallcaps}
81
82
Text Block
82
-
: Inserts a text block from a template in your block library:[^8]
83
+
: Inserts a text block from a template in your block library:[^9]
83
84
a. Select the reusable blocks you want to add.
84
85
b. Click **Insert # Text Block(s) to Document**.
85
86
86
-
Test-Driven[^9]
87
+
Test-Driven[^10]
87
88
: Adds a new section with logged test results.
88
89
89
-
Metric Over Time[^10]
90
+
Metric Over Time[^11]
90
91
: Adds a new section with logged metric over time results.
91
92
92
93
:::
93
94
94
-
7. After adding the block to your document, click on the text to make changes or add comments.[^11]
95
+
7. After adding the block to your document, click on the text to make changes or add comments.[^12]
95
96
96
97
### Reference field values
97
98
98
99
While editing a simple text block within documents, you can reference values in the form of variables from:
99
100
100
101
::: {.callout}
101
-
- To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^12]
102
+
- To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^13]
102
103
- 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.
103
104
104
105
:::
@@ -118,8 +119,8 @@ While editing a simple text block within documents, you can insert math equation
118
119
While editing a simple text block within documents, you can have {{< var vm.product >}} assist you with generating content drafts.
119
120
120
121
::: {.callout title="How can generate content drafts with AI?"}
121
-
- To use the generate content drafts with AI feature, your organization must not have tracked changes enabled by default.[^13]
122
-
- 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.
122
+
- To use the generate content drafts with AI feature, your organization must not have tracked changes enabled by default.[^14]
123
+
- 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.
123
124
124
125
:::
125
126
@@ -128,7 +129,7 @@ To generate content drafts:
128
129
129
130
{{< include content_blocks/_generate-with-ai.qmd >}}
130
131
131
-
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.
132
+
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.
132
133
133
134
<br>
134
135
@@ -176,7 +177,7 @@ While editing a simple text block within documents, you can directly reference o
176
177
177
178
:::
178
179
179
-
Hyperlinks will also take you to the referenced section in PDF document exports.[^16]
180
+
Hyperlinks will also take you to the referenced section in PDF document exports.[^17]
180
181
181
182
## Remove content blocks
182
183
@@ -186,11 +187,11 @@ Test-driven or metric over time blocks can be re-added later on but **text block
186
187
187
188
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
188
189
189
-
2. Select a record or find your record by applying a filter or searching for it.[^17]
190
+
2. Select a record or find your record by applying a filter or searching for it.[^18]
190
191
191
-
3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^18]
192
+
3. In the left sidebar that appears for your record, click **{{< fa file >}} Documents** and select the **Latest** tab.[^19]
192
193
193
-
4. Click on the document file you want to remove a block from.[^19]
194
+
4. Click on the document file you want to remove a block from.[^20]
194
195
195
196
5. Click on a section header to expand that section and remove content.
196
197
@@ -209,34 +210,36 @@ Test-driven or metric over time blocks can be re-added later on but **text block
Copy file name to clipboardExpand all lines: site/guide/validation/_add-artifacts-on-documentation.qmd
+6-12Lines changed: 6 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -23,32 +23,26 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
23
23
24
24
1. On the modal that opens, provide information for your artifact.
25
25
26
-
1. When you are done, click **Save** to submit the artifact.
26
+
1. When you are done, click **Add {Artifact Type}** where `{Artifact Type}` is the artifact type you want to add to submit the artifact.
27
27
28
28
Once created, you can then add supporting documentation to your artifact.^[[Manage attachments on artifacts](/guide/validation/add-manage-artifacts.qmd#manage-attachments)]
29
29
30
30
::::
31
31
32
32
:::: {.content-hidden unless-format="revealjs"}
33
-
1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
34
-
35
-
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"}.
36
-
37
-
1. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents.
33
+
a. In the left sidebar that appears for your record, click **Development** under {{< fa file >}} Documents.
38
34
39
-
<!-- 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. -->
40
-
41
-
1. On your record's documentation page, click **{{< fa plus >}} Add Artifact**.
35
+
b. On your record's documentation page, click **{{< fa plus >}} Add Artifact**.
42
36
43
-
1. Select the [artifact type](/guide/validation/manage-artifact-types.qmd){target="_blank"} you want to add:
37
+
c. Select the [artifact type](/guide/validation/manage-artifact-types.qmd){target="_blank"} you want to add:
44
38
45
39
- Validation Issue
46
40
- Policy Exception
47
41
- Limitation
48
42
49
-
1. On the modal that opens, provide information for your artifact.
43
+
d. On the modal that opens, provide information for your artifact.
50
44
51
-
1. When you are done, click **Save** to submit the artifact.
45
+
e. When you are done, click **Add {Artifact Type}**where `{Artifact Type}` is the artifact type you want to add to submit the artifact.
52
46
53
47
Once created, you can then [add supporting documentation to your artifact](/guide/validation/add-manage-artifacts.qmd#manage-attachments){target="_blank"}.
0 commit comments