fix(docs): update help links on all pages

aarthy-dk · aarthy-dk · commit 74f6a218735d · 2026-02-16T01:16:34.000-05:00
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # DataOps Data Quality TestGen
-![apache 2.0 license Badge](https://img.shields.io/badge/License%20-%20Apache%202.0%20-%20blue) ![PRs Badge](https://img.shields.io/badge/PRs%20-%20Welcome%20-%20green) [![Latest Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fdatakitchen%2Fdataops-testgen%2Ftags%2F&query=results%5B0%5D.name&label=latest%20version&color=06A04A)](https://hub.docker.com/r/datakitchen/dataops-testgen) [![Docker Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fdatakitchen%2Fdataops-testgen%2F&query=pull_count&style=flat&label=docker%20pulls&color=06A04A)](https://hub.docker.com/r/datakitchen/dataops-testgen) [![Documentation](https://img.shields.io/badge/docs-On%20datakitchen.io-06A04A?style=flat)](https://docs.datakitchen.io/articles/#!dataops-testgen-help/dataops-testgen-help) [![Static Badge](https://img.shields.io/badge/Slack-Join%20Discussion-blue?style=flat&logo=slack)](https://data-observability-slack.datakitchen.io/join)
+![apache 2.0 license Badge](https://img.shields.io/badge/License%20-%20Apache%202.0%20-%20blue) ![PRs Badge](https://img.shields.io/badge/PRs%20-%20Welcome%20-%20green) [![Latest Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fdatakitchen%2Fdataops-testgen%2Ftags%2F&query=results%5B0%5D.name&label=latest%20version&color=06A04A)](https://hub.docker.com/r/datakitchen/dataops-testgen) [![Docker Pulls](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fdatakitchen%2Fdataops-testgen%2F&query=pull_count&style=flat&label=docker%20pulls&color=06A04A)](https://hub.docker.com/r/datakitchen/dataops-testgen) [![Documentation](https://img.shields.io/badge/docs-On%20datakitchen.io-06A04A?style=flat)](https://docs.datakitchen.io/articles/dataops-testgen-help/dataops-testgen-help) [![Static Badge](https://img.shields.io/badge/Slack-Join%20Discussion-blue?style=flat&logo=slack)](https://data-observability-slack.datakitchen.io/join)
 
 *<p style="text-align: center;">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.</p>*
 
@@ -110,7 +110,7 @@ Within the virtual environment, install the TestGen package with pip.
 pip install dataops-testgen
 ```
 
-Verify that the [_testgen_ command line](https://docs.datakitchen.io/articles/#!dataops-testgen-help/testgen-commands-and-details) works.
+Verify that the [_testgen_ command line](https://docs.datakitchen.io/articles/dataops-testgen-help/testgen-commands-and-details) works.
 ```shell
 testgen --help
 ```
@@ -187,7 +187,7 @@ python3 dk-installer.py tg delete-demo
 
 ### Upgrade to latest version
 
-New releases of TestGen are announced on the `#releases` channel on [Data Observability Slack](https://data-observability-slack.datakitchen.io/join), and release notes can be found on the [DataKitchen documentation portal](https://docs.datakitchen.io/articles/#!dataops-testgen-help/testgen-release-notes/a/h1_1691719522). Use the following command to upgrade to the latest released version.
+New releases of TestGen are announced on the `#releases` channel on [Data Observability Slack](https://data-observability-slack.datakitchen.io/join), and release notes can be found on the [DataKitchen documentation portal](https://docs.datakitchen.io/articles/dataops-testgen-help/testgen-release-notes/a/h1_1691719522). Use the following command to upgrade to the latest released version.
 
  ```shell
  python3 dk-installer.py tg upgrade
@@ -203,7 +203,7 @@ python3 dk-installer.py tg delete
 
 ### Access the _testgen_ CLI
 
-The [_testgen_ command line](https://docs.datakitchen.io/articles/#!dataops-testgen-help/testgen-commands-and-details) can be accessed within the running container.
+The [_testgen_ command line](https://docs.datakitchen.io/articles/dataops-testgen-help/testgen-commands-and-details) can be accessed within the running container.
 
 ```shell
 docker compose exec engine bash
@@ -232,7 +232,7 @@ We recommend you start by going through the [Data Observability Overview Demo](h
 For support requests, [join the Data Observability Slack](https://data-observability-slack.datakitchen.io/join) 👋 and post on the `#support` channel.
 
 ### Connect to your database
-Follow [these instructions](https://docs.datakitchen.io/articles/#!dataops-testgen-help/connect-your-database) to improve the quality of data in your database.
+Follow [these instructions](https://docs.datakitchen.io/articles/dataops-testgen-help/connect-your-database) to improve the quality of data in your database.
 
 ### Community
 Talk and learn with other data practitioners who are building with DataKitchen. Share knowledge, get help, and contribute to our open-source project.
diff --git a/pyproject.toml b/pyproject.toml
@@ -99,8 +99,8 @@ tg-patch-streamlit = "testgen.ui.scripts.patch_streamlit:patch"
 [project.urls]
 "Source Code" = "https://github.com/DataKitchen/dataops-testgen"
 "Bug Tracker" = "https://github.com/DataKitchen/dataops-testgen/issues"
-"Documentation" = "https://docs.datakitchen.io/articles/#!dataops-testgen-help/dataops-testgen-help"
-"Release Notes" = "https://docs.datakitchen.io/articles/#!dataops-testgen-help/testgen-release-notes"
+"Documentation" = "https://docs.datakitchen.io/articles/dataops-testgen-help/dataops-testgen-help"
+"Release Notes" = "https://docs.datakitchen.io/articles/dataops-testgen-help/testgen-release-notes"
 "Slack" = "https://data-observability-slack.datakitchen.io/join"
 "Homepage" = "https://example.com"
 
diff --git a/testgen/common/notifications/notifications.py b/testgen/common/notifications/notifications.py
@@ -393,7 +393,7 @@ def get_body_template(self) -> str:
         </tr>
         <tr class="footer">
           <td>
-            <a href="https://docs.datakitchen.io/articles/#!dataops-testgen-help/introduction-to-dataops-testgen"
+            <a href="https://docs.datakitchen.io/articles/dataops-testgen-help/introduction-to-dataops-testgen"
                target="_blank">TestGen Help</a>
           </td>
           <td align="right">
diff --git a/testgen/ui/components/frontend/js/components/help_menu.js b/testgen/ui/components/frontend/js/components/help_menu.js
@@ -23,7 +23,7 @@ import { Icon } from './icon.js';
 
 const { a, div, span } = van.tags;
 
-const baseHelpUrl = 'https://docs.datakitchen.io/articles/#!dataops-testgen-help/';
+const baseHelpUrl = 'https://docs.datakitchen.io/articles/dataops-testgen-help/';
 const releaseNotesTopic = 'testgen-release-notes';
 const upgradeTopic = 'upgrade-testgen';
 
diff --git a/testgen/ui/components/widgets/page.py b/testgen/ui/components/widgets/page.py
@@ -9,7 +9,7 @@
 from testgen.ui.session import session
 from testgen.ui.views.dialogs.application_logs_dialog import application_logs_dialog
 
-UPGRADE_URL = "https://docs.datakitchen.io/articles/#!dataops-testgen-help/upgrade-testgen"
+UPGRADE_URL = "https://docs.datakitchen.io/articles/dataops-testgen-help/upgrade-testgen"
 
 
 def page_header(
diff --git a/testgen/ui/static/js/components/help_menu.js b/testgen/ui/static/js/components/help_menu.js
@@ -23,7 +23,7 @@ import { Icon } from './icon.js';
 
 const { a, div, span } = van.tags;
 
-const baseHelpUrl = 'https://docs.datakitchen.io/articles/#!dataops-testgen-help/';
+const baseHelpUrl = 'https://docs.datakitchen.io/articles/dataops-testgen-help/';
 const releaseNotesTopic = 'testgen-release-notes';
 const upgradeTopic = 'upgrade-testgen';
 
diff --git a/testgen/ui/views/connections.py b/testgen/ui/views/connections.py
@@ -65,7 +65,7 @@ class ConnectionsPage(Page):
     def render(self, project_code: str, **_kwargs) -> None:
         testgen.page_header(
             PAGE_TITLE,
-            "connect-your-database",
+            "manage-connections",
         )
 
         connections = Connection.select_where(Connection.project_code == project_code)
diff --git a/testgen/ui/views/data_catalog.py b/testgen/ui/views/data_catalog.py
@@ -57,6 +57,7 @@ class DataCatalogPage(Page):
     def render(self, project_code: str, table_group_id: str | None = None, selected: str | None = None, **_kwargs) -> None:
         testgen.page_header(
             PAGE_TITLE,
+            "data-catalog",
         )
 
         _, loading_column = st.columns([.4, .6])
diff --git a/testgen/ui/views/hygiene_issues.py b/testgen/ui/views/hygiene_issues.py
@@ -64,7 +64,7 @@ def render(
 
         testgen.page_header(
             "Hygiene Issues",
-            "view-hygiene-issues",
+            "data-hygiene-issues",
             breadcrumbs=[
                 { "label": "Profiling Runs", "path": "profiling-runs", "params": { "project_code": run.project_code } },
                 { "label": f"{run.table_groups_name} | {run_date}" },
@@ -336,10 +336,6 @@ def open_download_dialog(data: pd.DataFrame | None = None) -> None:
         with score_column:
             render_score(run.project_code, run_id)
 
-        # Help Links
-        st.markdown(
-            "[Help on Hygiene Issues](https://docs.datakitchen.io/article/dataops-testgen-help/data-hygiene-issues)"
-        )
 
 @st.fragment
 @with_database_session
diff --git a/testgen/ui/views/monitors_dashboard.py b/testgen/ui/views/monitors_dashboard.py
@@ -71,7 +71,7 @@ def render(
     ) -> None:
         testgen.page_header(
             PAGE_TITLE,
-            "monitors-dashboard",
+            "monitor-tables",
         )
 
         project_summary = Project.get_summary(project_code)
diff --git a/testgen/ui/views/profiling_results.py b/testgen/ui/views/profiling_results.py
@@ -49,7 +49,7 @@ def render(self, run_id: str, table_name: str | None = None, column_name: str |
 
         testgen.page_header(
             "Data Profiling Results",
-            "view-data-profiling-results",
+            "investigate-profiling-results",
             breadcrumbs=[
                 { "label": "Profiling Runs", "path": "profiling-runs", "params": { "project_code": run.project_code } },
                 { "label": f"{run.table_groups_name} | {run_date}" },
diff --git a/testgen/ui/views/profiling_runs.py b/testgen/ui/views/profiling_runs.py
@@ -49,7 +49,7 @@ class DataProfilingPage(Page):
     def render(self, project_code: str, table_group_id: str | None = None, **_kwargs) -> None:
         testgen.page_header(
             PAGE_TITLE,
-            "investigate-profiling",
+            "data-profiling",
         )
 
         with st.spinner("Loading data ..."):
diff --git a/testgen/ui/views/project_dashboard.py b/testgen/ui/views/project_dashboard.py
@@ -30,6 +30,7 @@ class ProjectDashboardPage(Page):
     def render(self, project_code: str, **_kwargs):
         testgen.page_header(
             PAGE_TITLE,
+            "project-dashboard",
         )
 
         with st.spinner("Loading data ..."):
diff --git a/testgen/ui/views/project_settings.py b/testgen/ui/views/project_settings.py
@@ -38,7 +38,7 @@ def render(self, project_code: str | None = None, **_kwargs) -> None:
 
         testgen.page_header(
             PAGE_TITLE,
-            "tg-project-settings",
+            "manage-projects",
         )
 
         testgen.whitespace(1)
diff --git a/testgen/ui/views/quality_dashboard.py b/testgen/ui/views/quality_dashboard.py
@@ -28,7 +28,7 @@ class QualityDashboardPage(Page):
     def render(self, *, project_code: str, **_kwargs) -> None:
         project_summary = Project.get_summary(project_code)
 
-        testgen.page_header(PAGE_TITLE)
+        testgen.page_header(PAGE_TITLE, "quality-scores")
         testgen.testgen_component(
             "quality_dashboard",
             props={
diff --git a/testgen/ui/views/score_details.py b/testgen/ui/views/score_details.py
@@ -67,6 +67,7 @@ def render(
 
         testgen.page_header(
             "Score Details",
+            "view-score-details",
             breadcrumbs=[
                 {"path": "quality-dashboard", "label": "Quality Dashboard", "params": {"project_code": score_definition.project_code}},
                 {"label": score_definition.name},
diff --git a/testgen/ui/views/score_explorer.py b/testgen/ui/views/score_explorer.py
@@ -77,7 +77,7 @@ def render(
             page_title = "Edit Scorecard"
             last_breadcrumb = original_score_definition.name
 
-        testgen.page_header(page_title, breadcrumbs=[
+        testgen.page_header(page_title, "explore-and-create-scorecards", breadcrumbs=[
             {"path": "quality-dashboard", "label": "Quality Dashboard", "params": {"project_code": project_code}},
             {"label": last_breadcrumb},
         ])
diff --git a/testgen/ui/views/table_groups.py b/testgen/ui/views/table_groups.py
@@ -49,7 +49,7 @@ def render(
         table_group_name: str | None = None,
         **_kwargs,
     ) -> None:
-        testgen.page_header(PAGE_TITLE, "create-a-table-group")
+        testgen.page_header(PAGE_TITLE, "manage-table-groups")
 
         user_can_edit = session.auth.user_has_permission("edit")
         project_summary = Project.get_summary(project_code)
diff --git a/testgen/ui/views/test_definitions.py b/testgen/ui/views/test_definitions.py
@@ -68,7 +68,7 @@ def render(
 
         testgen.page_header(
             "Test Definitions",
-            "testgen-test-types",
+            "test-definitions",
             breadcrumbs=[
                 { "label": "Test Suites", "path": "test-suites", "params": { "project_code": project_code } },
                 { "label": test_suite.test_suite },
diff --git a/testgen/ui/views/test_results.py b/testgen/ui/views/test_results.py
@@ -78,7 +78,7 @@ def render(
 
         testgen.page_header(
             "Test Results",
-            "view-testgen-test-results",
+            "investigate-test-results",
             breadcrumbs=[
                 { "label": "Test Runs", "path": "test-runs", "params": { "project_code": run.project_code } },
                 { "label": f"{run.test_suite} | {run_date}" },
@@ -312,9 +312,6 @@ def open_download_dialog(data: pd.DataFrame | None = None) -> None:
                 multi_select,
             )
 
-        # Help Links
-        st.markdown("[Help on Test Types](https://docs.datakitchen.io/article/dataops-testgen-help/testgen-test-types)")
-
 
 @st.fragment
 @with_database_session
diff --git a/testgen/ui/views/test_runs.py b/testgen/ui/views/test_runs.py
@@ -51,7 +51,7 @@ class TestRunsPage(Page):
     def render(self, project_code: str, table_group_id: str | None = None, test_suite_id: str | None = None, **_kwargs) -> None:
         testgen.page_header(
             PAGE_TITLE,
-            "test-results",
+            "data-quality-testing",
         )
 
         with st.spinner("Loading data ..."):
diff --git a/testgen/ui/views/test_suites.py b/testgen/ui/views/test_suites.py
@@ -40,7 +40,7 @@ class TestSuitesPage(Page):
     def render(self, project_code: str, table_group_id: str | None = None, **_kwargs) -> None:
         testgen.page_header(
             PAGE_TITLE,
-            "create-a-test-suite",
+            "manage-test-suites",
         )
 
         table_groups = TableGroup.select_minimal_where(TableGroup.project_code == project_code)

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ class ConnectionsPage(Page):`
`65`	`65`	`def render(self, project_code: str, **_kwargs) -> None:`
`66`	`66`	`testgen.page_header(`
`67`	`67`	`PAGE_TITLE,`
`68`		`- "connect-your-database",`
	`68`	`+ "manage-connections",`
`69`	`69`	`)`
`70`	`70`
`71`	`71`	`connections = Connection.select_where(Connection.project_code == project_code)`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@ class DataCatalogPage(Page):`
`57`	`57`	`def render(self, project_code: str, table_group_id: str \| None = None, selected: str \| None = None, **_kwargs) -> None:`
`58`	`58`	`testgen.page_header(`
`59`	`59`	`PAGE_TITLE,`
	`60`	`+ "data-catalog",`
`60`	`61`	`)`
`61`	`62`
`62`	`63`	`_, loading_column = st.columns([.4, .6])`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ def render(`
`71`	`71`	`) -> None:`
`72`	`72`	`testgen.page_header(`
`73`	`73`	`PAGE_TITLE,`
`74`		`- "monitors-dashboard",`
	`74`	`+ "monitor-tables",`
`75`	`75`	`)`
`76`	`76`
`77`	`77`	`project_summary = Project.get_summary(project_code)`