Skip to content

Commit

Permalink
Update docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Dat Nguyen committed Apr 10, 2023
1 parent 8047b72 commit edd6f90
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The purpose of the dq tool is to make simple storing test results and visualisat
![dwh](https://img.shields.io/badge/DWH-BigQuery-green?logo=google&logoColor=white)

**Installation**:

- Add to `packages.yml` file:
```yml
packages:
Expand All @@ -31,7 +32,7 @@ The purpose of the dq tool is to make simple storing test results and visualisat
- Add on-run-start hook:
```yml
on-run-start:
- '{{ dq_tools.create_table_dq_issue_log() }}'
- '{{ dq_tools.create_dq_issue_log() }}'
```

- Add on-run-end hook:
Expand All @@ -51,14 +52,15 @@ The idea behind the layer is that each layer can be changed, extended or replace

## Data Quality KPIs
There are 6 main KPIs will be produced as below:

- Accuracy
- Consistency
- Completeness
- Timeliness
- Validity
- Uniqueness

![DataQualityKPIs](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/DataQualityKPIs.png)
![DataQualityKPIs](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/DataQualityKPIs.png)

NOTE: It is possible that we can have custom KPI(s) as you go but it is NOT recommended as the existing modelling design will stick to the above 6 ones only.
```yaml
Expand Down Expand Up @@ -101,10 +103,10 @@ models:

- STEP 3 - run the dbt test and check:
Test results in the dq issue log table:
![TestResultLog](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/TestResultLog.png)
![TestResultLog](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/TestResultLog.png)

Data quality KPIs in looker:
![LookerDashboard](https://github.com/infinitelambda/dq-tools/blob/main/assets/images/LookerDashboard.png)
![LookerDashboard](https://raw.githubusercontent.com/infinitelambda/dq-tools/main/assets/images/LookerDashboard.png)


## Installation Instructions
Expand Down Expand Up @@ -434,4 +436,6 @@ models:
```

## Contributing
If you've ever wanted to contribute to this tool, and a great cause, feel free to create your [Pull Request](https://github.com/infinitelambda/dq-tools/pulls), or submit a new issue via [Bug Report](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=bug_report.md&title=[BUG]%20Describe%20it%20shortly) / [Feature Request](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=feature_request.md&title=[FEATURE]%20Describe%20it%20shortly) 💖
If you've ever wanted to contribute to this tool, and a great cause, feel free to create your [Pull Request](https://github.com/infinitelambda/dq-tools/pulls), or submit a new issue via [Bug Report](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=bug_report.md&title=[BUG]%20Describe%20it%20shortly) / [Feature Request](https://github.com/infinitelambda/dq-tools/issues/new?assignees=&labels=&template=feature_request.md&title=[FEATURE]%20Describe%20it%20shortly) 💖

For more details, please help to check [Contributing](https://infinitelambda.github.io/dq-tools/nav/development/contributing-guide.html) documentation!
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Data Quality Tool
site_name: Data Quality Tools
site_url: https://infinitelambda.github.io/dq-tools/
site_author: Infinite Lambda
site_description: Offical documentation of `dq-tools` dbt package
Expand Down Expand Up @@ -64,8 +64,8 @@ plugins:
on_post_build: "docs.hooks:copy_dbt_docs"

nav:
- ✨dq-tools: index.md
- 👉dbt docs: dbt-docs/index.html # managed by hooks.copy_dbt_docs
- dq-tools: index.md
- 👉 dbt docs: dbt-docs/index.html # managed by hooks.copy_dbt_docs
- Development:
- nav/development/contributing-guide.md
- nav/development/release-notes.md
Expand Down

0 comments on commit edd6f90

Please sign in to comment.