diff --git a/README.md b/README.md index badf1a5..1ee30e6 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,14 @@ *

DataOps Data Quality TestGen, or "TestGen" for short, can help you find data issues so you can alert your users and notify your suppliers. It does this by delivering simple, fast data quality test generation and execution by data profiling, new dataset screening and hygiene review, algorithmic generation of data quality validation tests, ongoing production testing of new data refreshes, and continuous anomaly monitoring of datasets. TestGen is part of DataKitchen's Open Source Data Observability.

* +## Documentation + +[DataOps TestGen Overview](https://datakitchen.io/dataops-testgen-product/) + +[DataOps TestGen Documentation](https://docs.datakitchen.io/articles/dataops-testgen-help/dataops-testgen-help) + +[DataOps TestGen Case Study](https://datakitchen.io/datakitchens-data-quality-testgen-found-18-quality-issues-in-a-few-minutes-including-install-time-on-data-boston-gov-building-permit-data/) + ## Features What does DataKitchen's DataOps Data Quality TestGen do? It helps you understand and find data issues in new data. @@ -28,8 +36,8 @@ The [dk-installer](https://github.com/DataKitchen/data-observability-installer/? | Software | Tested Versions | Command to check version | |-------------------------|-------------------------|-------------------------------| -| [Python](https://www.python.org/downloads/)
- Most Linux and macOS systems have Python pre-installed.
- On Windows machines, you will need to download and install it. | 3.9, 3.10, 3.11, 3.12 | `python3 --version` | -| [Docker](https://docs.docker.com/get-docker/)
[Docker Compose](https://docs.docker.com/compose/install/) | 25.0.3, 26.1.1,
2.24.6, 2.27.0, 2.28.1 | `docker -v`
`docker compose version` | +| [Python](https://www.python.org/downloads/)
- Most Linux and macOS systems have Python pre-installed.
- On Windows machines, you will need to download and install it.
Why Python? To run the installer. | 3.9, 3.10, 3.11, 3.12 | `python3 --version` | +| [Docker](https://docs.docker.com/get-docker/)
[Docker Compose](https://docs.docker.com/compose/install/)
Why Docker? Docker lets you try TestGen without affecting your local software environment. All the dependencies TestGen needs are isolated in its own container, so installation is easy and insulated. | 25.0.3, 26.1.1,
2.24.6, 2.27.0, 2.28.1 | `docker -v`
`docker compose version` | ### Download the installer @@ -67,10 +75,6 @@ python3 dk-installer.py tg run-demo In the TestGen UI, you will see that new data profiling and test results have been generated. -## Product Documentation - -[DataOps Data Quality TestGen](https://docs.datakitchen.io/articles/dataops-testgen-help/dataops-testgen-help) - ## Useful Commands The [dk-installer](https://github.com/DataKitchen/data-observability-installer/?tab=readme-ov-file#install-the-testgen-application) and [docker compose CLI](https://docs.docker.com/compose/reference/) can be used to operate the installed TestGen application. All commands must be run in the same folder that contains the `dk-installer.py` and `docker-compose.yml` files used by the installation.