Skip to content

Commit

Permalink
Add link to HTML report rather than embeddeding
Browse files Browse the repository at this point in the history
  • Loading branch information
@pflooky
pflooky committed Aug 25, 2023
1 parent b378381 commit ac05838
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 24 deletions.
22 changes: 11 additions & 11 deletions docs/setup/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ seen [here](../sample/docker/data/custom/application.conf).

Flags are used to control which processes are executed when you run Data Caterer.

| Config | Default | Paid | Description |
|--------------------------------|---------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `enableGenerateData` | true | N | Enable/disable data generation |
| `enableCount` | true | N | Count the number of records generated. Can be disabled to improve performance |
| `enableFailOnError` | true | N | Whilst saving generated data, if there is an error, it will stop any further data from being generated |
| `enableSaveSinkMetadata` | true | N | Enable/disable HTML reports summarising data generated, metadata of data generated (if `enableSinkMetadata` is enabled) and validation results (if `enableValidation` is enabled) |
| `enableSinkMetadata` | true | N | Run data profiling for the generated data. Shown in HTML reports if `enableSaveSinkMetadata` is enabled |
| `enableValidation` | false | N | Run validations as described in plan. Results can be viewed from logs or from HTML report if `enableSaveSinkMetadata` is enabled |
| `enableGeneratePlanAndTasks` | false | Y | Enable/disable plan and task auto generation based off data source connections |
| `enableRecordTracking` | false | Y | Enable/disable which data records have been generated for any data source |
| `enableDeleteGeneratedRecords` | false | Y | Delete all generated records based off record tracking (if `enableRecordTracking` has been set to true) |
| Config | Default | Paid | Description |
|--------------------------------|---------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `enableGenerateData` | true | N | Enable/disable data generation |
| `enableCount` | true | N | Count the number of records generated. Can be disabled to improve performance |
| `enableFailOnError` | true | N | Whilst saving generated data, if there is an error, it will stop any further data from being generated |
| `enableSaveSinkMetadata` | true | N | Enable/disable HTML reports summarising data generated, metadata of data generated (if `enableSinkMetadata` is enabled) and validation results (if `enableValidation` is enabled). Sample [here](generator/report.md) |
| `enableSinkMetadata` | true | N | Run data profiling for the generated data. Shown in HTML reports if `enableSaveSinkMetadata` is enabled |
| `enableValidation` | false | N | Run validations as described in plan. Results can be viewed from logs or from HTML report if `enableSaveSinkMetadata` is enabled. Sample [here](validation/validation.md) |
| `enableGeneratePlanAndTasks` | false | Y | Enable/disable plan and task auto generation based off data source connections |
| `enableRecordTracking` | false | Y | Enable/disable which data records have been generated for any data source |
| `enableDeleteGeneratedRecords` | false | Y | Delete all generated records based off record tracking (if `enableRecordTracking` has been set to true) |

## Folders

Expand Down
4 changes: 1 addition & 3 deletions docs/setup/generator/report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ data was generated, where it was generated, validation results and any associate

## Sample

Once run, it will produce a report like the below:

<iframe src="https://pflooky.github.io/data-caterer-docs/site/sample/docker/data/report/html/index.html"></iframe>
Once run, it will produce a report like [this](../../sample/docker/data/report/html/index.html).
4 changes: 1 addition & 3 deletions docs/setup/validation/validation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,4 @@ dataSources:
errorThreshold: 200
```
Once run, it will produce a report like the below:
<iframe src="https://pflooky.github.io/data-caterer-docs/site/sample/docker/data/report/html/validations.html"></iframe>
Once run, it will produce a report like [this](../../sample/docker/data/report/html/validations.html).
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
Expand Down
2 changes: 1 addition & 1 deletion site/search/search_index.json
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions site/setup/configuration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@ <h2 id="flags">Flags</h2>
<td><code>enableSaveSinkMetadata</code></td>
<td>true</td>
<td>N</td>
<td>Enable/disable HTML reports summarising data generated, metadata of data generated (if <code>enableSinkMetadata</code> is enabled) and validation results (if <code>enableValidation</code> is enabled)</td>
<td>Enable/disable HTML reports summarising data generated, metadata of data generated (if <code>enableSinkMetadata</code> is enabled) and validation results (if <code>enableValidation</code> is enabled). Sample <a href="../generator/report/">here</a></td>
</tr>
<tr>
<td><code>enableSinkMetadata</code></td>
Expand All @@ -751,7 +751,7 @@ <h2 id="flags">Flags</h2>
<td><code>enableValidation</code></td>
<td>false</td>
<td>N</td>
<td>Run validations as described in plan. Results can be viewed from logs or from HTML report if <code>enableSaveSinkMetadata</code> is enabled</td>
<td>Run validations as described in plan. Results can be viewed from logs or from HTML report if <code>enableSaveSinkMetadata</code> is enabled. Sample <a href="../validation/validation/">here</a></td>
</tr>
<tr>
<td><code>enableGeneratePlanAndTasks</code></td>
Expand Down
3 changes: 1 addition & 2 deletions site/setup/generator/report/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -685,8 +685,7 @@ <h1 id="report">Report</h1>
<p>Data Caterer can be configured to produce a report of the data generated to help users understand what was run, how much
data was generated, where it was generated, validation results and any associated metadata. </p>
<h2 id="sample">Sample</h2>
<p>Once run, it will produce a report like the below:</p>
<iframe src="https://pflooky.github.io/data-caterer-docs/site/sample/docker/data/report/html/index.html"></iframe>
<p>Once run, it will produce a report like <a href="../../../sample/docker/data/report/html/">this</a>.</p>



Expand Down
3 changes: 1 addition & 2 deletions site/setup/validation/validation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -702,8 +702,7 @@ <h2 id="sample">Sample</h2>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">expr</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;regexp_like(name,</span><span class="nv"> </span><span class="s">&#39;Peter</span><span class="nv"> </span><span class="s">.*&#39;)&quot;</span>
<span class="w"> </span><span class="nt">errorThreshold</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">200</span>
</code></pre></div>
<p>Once run, it will produce a report like the below:</p>
<iframe src="https://pflooky.github.io/data-caterer-docs/site/sample/docker/data/report/html/validations.html"></iframe>
<p>Once run, it will produce a report like <a href="../../../sample/docker/data/report/html/validations.html">this</a>.</p>



Expand Down
Binary file modified site/sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit ac05838

Please sign in to comment.