Skip to content

Commit

Permalink
Add in roadmap item for validations to check for column names
Browse files Browse the repository at this point in the history
  • Loading branch information
pflooky committed Nov 30, 2023
1 parent 998bfab commit 672e739
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 64 deletions.
3 changes: 3 additions & 0 deletions docs/sponsor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ maintaining, documenting and updating it. I hope that it will help with develope
by saving time and effort, allowing you to focus on what is important. If you fall under this boat, please consider
sponsorship to allow me to further maintain and upgrade the solution. Any contributions are much appreciated.

Those who are wanting to use this project for open source applications, [please contact me](#contact) as I would be
happy to contribute.

This is inspired by the [mkdocs-material project](https://github.com/squidfunk/mkdocs-material) that
[follows the same model](https://squidfunk.github.io/mkdocs-material/insiders/).

Expand Down
5 changes: 2 additions & 3 deletions docs/use-case/blog/shift-left-data-quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ quality at the forefront of the development process.

``` mermaid
graph LR
subgraph badQualityData[<b>Manually generated data, data quality always passes</b>]
subgraph badQualityData[<b>Manually generated data, limited data scenarios</b>]
local[<b>Local</b>\nManual test, unit test]
dev[<b>Dev</b>\nManual test, integration test]
stg[<b>Staging</b>\nSanity checks]
Expand All @@ -34,7 +34,7 @@ graph LR

``` mermaid
graph LR
subgraph qualityData[<b>Reliable data for testing anywhere</b>]
subgraph qualityData[<b>Reliable data for testing anywhere<br>Common testing tool</b>]
direction LR
local[<b>Local</b>\nManual test, unit test]
dev[<b>Dev</b>\nManual test, integration test]
Expand Down Expand Up @@ -81,7 +81,6 @@ complex data flows, validate data sources, and ensure data quality before it rea
6. **Improved Collaboration:**
- Facilitate collaboration between developers, testers, and data professionals by providing a common platform for
early data validation.
- No need to rely on seeking domain expertise or external teams for data testing.

## Realizing the Vision of Proactive Data Quality

Expand Down
36 changes: 18 additions & 18 deletions docs/use-case/roadmap.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion site/search/search_index.json

Large diffs are not rendered by default.

76 changes: 38 additions & 38 deletions site/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,192 +2,192 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://data.catering/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/about/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/sponsor/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/use-case/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/get-started/docker/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/legal/privacy-policy/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/legal/terms-of-service/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/advanced/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/configuration/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/connection/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/deployment/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/design/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/foreign-key/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/validation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/generator/count/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/generator/data-generator/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/generator/report/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/cassandra/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/http/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/kafka/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/marquez-metadata-source/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/open-metadata-source/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/data-source/solace/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/auto-generate-connection/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/batch-and-event/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/data-validation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/delete-generated-data/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/first-data-generation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/guide/scenario/records-per-column/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/validation/basic-validation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/validation/group-by-validation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/setup/validation/upstream-data-source-validation/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/use-case/business-value/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/use-case/comparison/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/use-case/roadmap/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://data.catering/use-case/blog/shift-left-data-quality/</loc>
<lastmod>2023-11-29</lastmod>
<lastmod>2023-11-30</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified site/sitemap.xml.gz
Binary file not shown.
2 changes: 2 additions & 0 deletions site/sponsor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2050,6 +2050,8 @@ <h1 id="sponsor">Sponsor</h1>
maintaining, documenting and updating it. I hope that it will help with developers and companies with their testing
by saving time and effort, allowing you to focus on what is important. If you fall under this boat, please consider
sponsorship to allow me to further maintain and upgrade the solution. Any contributions are much appreciated.</p>
<p>Those who are wanting to use this project for open source applications, <a href="#contact">please contact me</a> as I would be
happy to contribute.</p>
<p>This is inspired by the <a href="https://github.com/squidfunk/mkdocs-material">mkdocs-material project</a> that
<a href="https://squidfunk.github.io/mkdocs-material/insiders/">follows the same model</a>.</p>
<h2 id="features">Features</h2>
Expand Down
5 changes: 2 additions & 3 deletions site/use-case/blog/shift-left-data-quality/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2150,7 +2150,7 @@ <h2 id="empowering-proactive-data-management">Empowering Proactive Data Manageme
quality at the forefront of the development process.</p>
<h3 id="today">Today</h3>
<pre class="mermaid"><code>graph LR
subgraph badQualityData[&lt;b&gt;Manually generated data, data quality always passes&lt;/b&gt;]
subgraph badQualityData[&lt;b&gt;Manually generated data, limited data scenarios&lt;/b&gt;]
local[&lt;b&gt;Local&lt;/b&gt;\nManual test, unit test]
dev[&lt;b&gt;Dev&lt;/b&gt;\nManual test, integration test]
stg[&lt;b&gt;Staging&lt;/b&gt;\nSanity checks]
Expand All @@ -2168,7 +2168,7 @@ <h3 id="today">Today</h3>
stg --&gt; prod</code></pre>
<h3 id="with-data-caterer">With Data Caterer</h3>
<pre class="mermaid"><code>graph LR
subgraph qualityData[&lt;b&gt;Reliable data for testing anywhere&lt;/b&gt;]
subgraph qualityData[&lt;b&gt;Reliable data for testing anywhere&lt;br&gt;Common testing tool&lt;/b&gt;]
direction LR
local[&lt;b&gt;Local&lt;/b&gt;\nManual test, unit test]
dev[&lt;b&gt;Dev&lt;/b&gt;\nManual test, integration test]
Expand Down Expand Up @@ -2219,7 +2219,6 @@ <h2 id="key-advantages-of-shifting-data-quality-left-with-data-caterer">Key Adva
<li><strong>Improved Collaboration:</strong><ul>
<li>Facilitate collaboration between developers, testers, and data professionals by providing a common platform for
early data validation.</li>
<li>No need to rely on seeking domain expertise or external teams for data testing.</li>
</ul>
</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion site/use-case/roadmap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2058,7 +2058,7 @@ <h1 id="roadmap">Roadmap</h1>
<tr>
<td>Validation types</td>
<td>Ability to define simple/complex data validations</td>
<td>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/basic-validation/">Basic validations</a><br>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/group-by-validation/">Aggregates</a> (sum of amount per account is &gt; 500)<br>- Ordering (transactions are ordered by date)<br>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/upstream-data-source-validation/">Relationship</a> (at least one account entry in history table per account in accounts table)<br>- Data profile (how close the generated data profile is compared to the expected data profile)</td>
<td>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/basic-validation/">Basic validations</a><br>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/group-by-validation/">Aggregates</a> (sum of amount per account is &gt; 500)<br>- Ordering (transactions are ordered by date)<br>- <img alt="" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/2705.svg" title=":white_check_mark:" /> <a href="../../setup/validation/upstream-data-source-validation/">Relationship</a> (at least one account entry in history table per account in accounts table)<br>- Data profile (how close the generated data profile is compared to the expected data profile)<br>- Column name (check column count, column names, ordering)</td>
</tr>
<tr>
<td>Data generation record count</td>
Expand Down

0 comments on commit 672e739

Please sign in to comment.