From 4f44b05ee8df92fdd4ae372029ce2047c9de9b9b Mon Sep 17 00:00:00 2001 From: Aarthy Adityan Date: Fri, 19 Apr 2024 18:14:35 -0400 Subject: [PATCH] Update doc and image links --- CONTRIBUTING.md | 2 +- README.md | 12 ++++++------ testgen/common/docker_service.py | 2 +- testgen/ui/views/connections.py | 2 +- testgen/ui/views/profiling_anomalies.py | 2 +- testgen/ui/views/test_results.py | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 321940e..f25e46e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ You can submit a proposal for a new feature by creating a [GitHub Issue](https:/ ## Join our Community -Join our Slack community for discussions with other Data Observability users. +Join our [Slack community](https://data-observability.slack.com) for discussions with other Data Observability users. ## Code Submission diff --git a/README.md b/README.md index ffaedc8..647e27b 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ DataKitchen's DataOps TestGen is a data verification tool that profiles your dat ## Installation ### Using dk-installer (recommended) -Install with a single command using [`dk-installer`](https://github.com/DataKitchen/dk-installer/?tab=readme-ov-file#dataops-testgen). +Install with a single command using [`dk-installer`](https://github.com/DataKitchen/data-observability-installer/?tab=readme-ov-file#install-the-testgen-application). ``` -python dk-installer tg +python3 dk-installer.py tg install ``` ### Using docker compose @@ -19,7 +19,7 @@ You can also install using the provided [`docker-compose.yml`](deploy/docker-com Make a local copy of the compose file. ```bash -curl -o docker-compose.yml 'https://raw.githubusercontent.com/DataKitchen/testgen/main/deploy/docker-compose.yml' +curl -o docker-compose.yml 'https://raw.githubusercontent.com/DataKitchen/dataops-testgen/main/deploy/docker-compose.yml' ``` If you are interested in integrating TestGen with DataKitchen Observability platform, edit the compose file and set values for the environment variables `OBSERVABILITY_API_URL` and `OBSERVABILITY_API_KEY`. @@ -52,15 +52,15 @@ After verifying that Testgen is running, follow [the steps for the quick start]( Testgen includes a basic data set for you to play around. ### Using dk-installer (recommended) -Once Testgen is running, you can use [`dk-installer`](https://github.com/DataKitchen/dk-installer/?tab=readme-ov-file#dataops-testgen) to generate the demo data: +Once Testgen is running, you can use [`dk-installer`](https://github.com/DataKitchen/data-observability-installer/?tab=readme-ov-file#run-the-testgen-demo-setup) to generate the demo data: ```bash -python dk-installer tg run-demo +python3 dk-installer.py tg run-demo ``` And, if you are integrating Testgen with the DataKitchen Observability platform, you will need to pass the `--export` flag: ```bash -python dk-installer tg run-demo --export +python3 dk-installer.py tg run-demo --export ``` ### Using docker compose diff --git a/testgen/common/docker_service.py b/testgen/common/docker_service.py index 49eacd9..4a53145 100644 --- a/testgen/common/docker_service.py +++ b/testgen/common/docker_service.py @@ -32,7 +32,7 @@ def check_for_new_docker_release() -> str: logger.warning("Unable to check for latest release", exc_info=True, stack_info=True) -def get_docker_tags(url: str = "https://hub.docker.com/v2/repositories/datakitchen/testgen/tags/"): +def get_docker_tags(url: str = "https://hub.docker.com/v2/repositories/datakitchen/dataops-testgen/tags/"): params = {"page_size": 25, "page": 1, "ordering": "last_updated"} response = requests.get(url, params=params, timeout=3) diff --git a/testgen/ui/views/connections.py b/testgen/ui/views/connections.py index 298dc5a..0ed8f94 100644 --- a/testgen/ui/views/connections.py +++ b/testgen/ui/views/connections.py @@ -24,7 +24,7 @@ class ConnectionsPage(Page): def render(self) -> None: fm.render_page_header( "Connection", - "https://docs.datakitchen.io/article/dataops-testgen-help/create-a-connection", + "https://docs.datakitchen.io/article/dataops-testgen-help/connect-your-database", lst_breadcrumbs=[ {"label": "Overview", "path": "overview"}, {"label": "Connection", "path": None}, diff --git a/testgen/ui/views/profiling_anomalies.py b/testgen/ui/views/profiling_anomalies.py index 6b44a54..d8a4e0c 100644 --- a/testgen/ui/views/profiling_anomalies.py +++ b/testgen/ui/views/profiling_anomalies.py @@ -182,7 +182,7 @@ def render(self) -> None: # Help Links st.markdown( - "[Help on Anomalies](https://docs.datakitchen.io/articles/#!dataops-testgen-help/profile-anomalies)" + "[Help on Anomalies](https://docs.datakitchen.io/article/dataops-testgen-help/profile-anomalies)" ) # with st.sidebar: diff --git a/testgen/ui/views/test_results.py b/testgen/ui/views/test_results.py index f68fa6f..05c9537 100644 --- a/testgen/ui/views/test_results.py +++ b/testgen/ui/views/test_results.py @@ -129,7 +129,7 @@ def render(self) -> None: # Help Links st.markdown( - "[Help on Test Types](https://docs.datakitchen.io/articles/#!dataops-testgen-help/testgen-test-types)" + "[Help on Test Types](https://docs.datakitchen.io/article/dataops-testgen-help/testgen-test-types)" ) # with st.sidebar: