Skip to content

QUA-1149: Update catalog operation#1076

Open
RafaelOsiro wants to merge 7 commits intomainfrom
qua-1149-update-catalog-operation
Open

QUA-1149: Update catalog operation#1076
RafaelOsiro wants to merge 7 commits intomainfrom
qua-1149-update-catalog-operation

Conversation

@RafaelOsiro
Copy link
Contributor

@RafaelOsiro RafaelOsiro commented Mar 20, 2026

Overview

This PR performs a comprehensive reorganization of the Qualytics User Guide documentation structure. The main goals are:

  1. rename "Catalog Operation" to "Sync Operation" to match the updated product terminology,
  2. restructure all asset folders to mirror the content folder hierarchy defined in mkdocs.yml,
  3. rename the checks/ content section to data-quality-checks/,
  4. rename the HTTP action page to Workflow and add n8n integration documentation, and
  5. ensure all renamed/moved pages have redirect entries so that users arriving from external links do not encounter 404 errors.

The asset folder convention adopted across the entire repository is:
docs/{content-section}/{page-name}.md → docs/assets/{content-section}/{page-name}/image.png

All image filenames were standardized by removing -light and -dark suffixes (previously used for theme variants) and by replacing generic numbered names (e.g., http-1.png, http-2.png) with descriptive names that reflect the actual content of each screenshot (e.g., webhook-settings-panel.png, http-action-fields.png).

Key Changes

  • Rename Catalog Operation → Sync Operation: The product renamed the "Catalog" operation to "Sync". This PR updates all 47 affected files — including every datastore setup page (add-datastores/*.md), anomaly documentation (anomalies/anomalies.md, anomalies/anomaly-detection.md), source datastore pages (source-datastore/profile.md, source-datastore/scan.md), glossary, onboarding, CLI overview, explore pages, container settings, flows pages, and the mkdocs.yml navigation. The content file source-datastore/catalog.md was renamed to source-datastore/sync.md and a redirect entry was added to ensure backward compatibility.

  • Reorganize catalog-operations assets → source-datastore/sync: The old docs/assets/catalog-operations/ folder (31 images with -light suffixes like catalog-light.png, running-catalog-light.png) was replaced by docs/assets/source-datastore/sync/ (31 images with descriptive names like sync-page.png, sync-running-automatically.png). All -light/-dark suffixes were removed.

  • Reorganize datastores assets → add-datastores: The old docs/assets/datastores/ folder contained 529 images in a flat structure organized by connector name (e.g., datastores/amazon-s3/, datastores/bigquery/). These were moved to docs/assets/add-datastores/ with a new hierarchy that mirrors the content structure: add-datastores/dfs-datastores/amazon-s3/, add-datastores/jdbc-datastores/bigquery/, add-datastores/overview/, etc. All 25 datastore .md files had their image paths updated accordingly, and -light/-dark suffixes were removed from filenames.

  • Rename checks → data-quality-checks (content): All 55 content files from docs/checks/ were moved to docs/data-quality-checks/ to match the "Data Quality Checks" section name displayed in the navigation. The mkdocs.yml navigation was updated from checks/* to data-quality-checks/* for all entries. 57 redirect entries were added (one for each page including rule types, templates, and overview pages) to ensure backward compatibility for external links. Internal references in docs/explore/checks.md, docs/explore/insights.md, docs/container/actions-on-container.md, docs/container/computed-tables-and-files/overview.md, docs/container/manage-tables-and-files/add-checks.md, docs/datastore-checks/filter-and-sort.md, and docs/observability/freshness.md were also updated.

  • Reorganize checks assets → data-quality-checks: The old docs/assets/checks/ folder contained 575 images spread across subfolders like checks/manage-checks/, checks/rule-types/, checks/authored-checks/, etc. These were reorganized into docs/assets/data-quality-checks/ with subfolders matching the content file names (e.g., data-quality-checks/rule-types/between-check/, data-quality-checks/manage-checks/, data-quality-checks/check-templates/). All -light/-dark suffixes and numbered suffixes were removed from filenames.

  • Reorganize flows assets into per-page subfolders: The old docs/assets/flows/ folder had 162 images in a flat structure with generic names like flow-light-1.png, definitions-light-2.png. These were reorganized into per-page subfolders: flows/overview/, flows/add-flow/, flows/flow-entry/, flows/trigger-node/, flows/actions-node/ (with sub-subfolders for each action type: operations/, anomaly/, notification/, workflow/, ticketing/), flows/manage-flow/, and flows/view-and-track-flow-executions/. All 21 flows .md files had their image paths updated.

  • Rename HTTP → Workflow + add n8n integration: The file docs/flows/http.md was renamed to docs/flows/workflow.md and the navigation label changed from "HTTP" to "Workflow". Generic image names (http-1.png through http-9.png) were renamed to descriptive names based on what each screenshot actually shows — images from the Webhook section became webhook-settings-panel.png, webhook-fields.png, webhook-test.png, etc., and images from the HTTP Action section became http-action-select.png, http-action-settings-panel.png, http-action-fields.png, etc. A new ## n8n section was added to the page documenting the n8n workflow automation integration, including configuration fields (Webhook URL, Webhook Secret with x-qualytics-secret header), the structured JSON payload sent to n8n webhooks (with flow info, trigger type, datastore, anomalies, containers, quality checks, and operation details), and a tip about installing the @qualytics/n8n-nodes-qualytics community node. The n8n documentation was written based on the actual controlplane implementation (app/integrations/workflow/n8n.py) and frontend components (components/flow/action/form/http.vue). A redirect from flows/http.md to flows/workflow.md was added.

  • Reorganize remaining assets (connections, dashboard, platform pages): The old docs/assets/connections/connection/ (12 images) was moved to docs/assets/connections/overview-of-a-connection/ (9 images). The old docs/assets/dashboard/ (15 images), docs/assets/quick-start-guide/ (20 images), and docs/assets/keyboard-shortcuts/ (5 images) were consolidated into docs/assets/using-the-platform/ with subfolders for each page: web-app/, onboarding/, quick-start-guide/, and keyboard-shortcuts/. Image paths were updated in docs/connections/overview-of-a-connection.md, docs/web-app.md, docs/quick-start-guide.md, docs/keyboard-shortcuts.md, and docs/onboarding.md.

  • Backward compatibility redirects: All renamed/moved pages have redirect entries configured via the mkdocs-redirects plugin in mkdocs.yml:

    • source-datastore/catalog.mdsource-datastore/sync.md
    • flows/http.mdflows/workflow.md
    • checks/overview-of-a-check.mddata-quality-checks/overview-of-a-check.md (and 56 more entries covering every checks page)

Screenshots

N/A — This PR reorganizes existing files, updates references, and adds text content. No visual changes to the rendered documentation besides the new n8n section on the Workflow page.

How to test Checklist

  • Run mkdocs serve and verify the site builds without errors or warnings
  • Sync Operation pages: Confirm all references to "Catalog Operation" have been replaced with "Sync Operation" (search for "catalog" in the rendered site)
  • Sync Operation images: Navigate to Source Datastores > Sync and verify all screenshots load correctly
  • Redirect — Catalog → Sync: Access /source-datastore/catalog/ and confirm it redirects to /source-datastore/sync/
  • Add Datastores images: Open at least 3 JDBC datastore pages (e.g., PostgreSQL, BigQuery, Databricks) and 3 DFS datastore pages (e.g., Amazon S3, Google Cloud Storage, Azure Datalake) and verify all screenshots load correctly
  • Data Quality Checks pages: Navigate to Data Quality Checks > Overview and confirm the page loads with correct content
  • Data Quality Checks images: Open at least 5 rule type pages (e.g., Between, Not Null, Expected Values, Matches Pattern, Is Replica Of) and verify all screenshots load correctly
  • Redirect — checks → data-quality-checks: Access /checks/overview-of-a-check/ and confirm it redirects to /data-quality-checks/overview-of-a-check/
  • Redirect — checks rule types: Access at least 3 old rule type URLs (e.g., /checks/between-check/, /checks/not-null-check/, /checks/expected-values-check/) and confirm they redirect correctly
  • Flows Overview images: Navigate to Flows > Overview and verify all screenshots load correctly
  • Flows subpages images: Open Add Flow, Flow Entry, Trigger Node, and at least 2 Actions Node subpages (e.g., Operations, Notifications) and verify all screenshots load correctly
  • Workflow page — Webhook section: Navigate to Flows > Actions Node > Workflow and verify the Webhook section screenshots load correctly with descriptive alt text
  • Workflow page — HTTP Action section: Verify the HTTP Action section screenshots load correctly
  • Workflow page — n8n section: Verify the n8n section renders correctly, including the configuration fields table, the tip about the community node, and the JSON payload code block
  • Redirect — HTTP → Workflow: Access /flows/http/ and confirm it redirects to /flows/workflow/
  • Connections images: Navigate to Connections > Overview of a Connection and verify all screenshots load correctly
  • Platform pages images: Verify screenshots load correctly on Web App, Onboarding, Quick Start Guide, and Keyboard Shortcuts pages
  • Cross-references: Click internal links in Anomaly Detection, Explore > Activity, Container > Settings, and CLI Overview pages to verify they point to valid destinations
  • No broken images: Use browser developer tools (Network tab, filter by img) to scan for any 404 image errors across the site

- Rename source-datastore/catalog.md to source-datastore/sync.md
- Replace "Catalog Operation" with "Sync Operation" in page titles, descriptions, and references
- Replace "cataloging" with "syncing" in datastore setup pages and anomaly docs
- Update mkdocs.yml navigation entry from Catalog to Sync
- Add redirect from source-datastore/catalog.md to source-datastore/sync.md
- Update image paths from assets/catalog-operations/ to assets/source-datastore/sync/
- Update image paths from assets/datastores/ to assets/add-datastores/ in datastore pages
- Update image paths from flat flows assets to per-page subfolders

Note: some files in this commit also include asset path reorganization
changes that will be paired with their new asset files in subsequent commits.
- Delete old assets from docs/assets/catalog-operations/
- Add reorganized assets to docs/assets/source-datastore/sync/
- Remove -light/-dark suffixes from image filenames
- Rename images with descriptive names (e.g., catalog-light.png → sync-page.png)
…tructure

- Delete old assets from docs/assets/datastores/ (flat structure)
- Add reorganized assets to docs/assets/add-datastores/ with subfolders
  matching content hierarchy (dfs-datastores/, jdbc-datastores/, overview/)
- Remove -light/-dark suffixes from image filenames
- Move all content from docs/checks/ to docs/data-quality-checks/
- Update mkdocs.yml navigation from checks/* to data-quality-checks/*
- Add 57 redirect entries for backward compatibility (checks/* → data-quality-checks/*)
- Update internal references in explore, container, datastore-checks, and observability pages
…structure

- Delete old assets from docs/assets/checks/ (flat structure with light/dark variants)
- Add reorganized assets to docs/assets/data-quality-checks/ with subfolders
  matching content hierarchy (rule-types/, manage-checks/, check-templates/, etc.)
- Remove -light/-dark suffixes from image filenames
…P to Workflow

- Delete old flat assets from docs/assets/flows/
- Add reorganized assets into per-page subfolders (overview/, add-flow/, flow-entry/,
  trigger-node/, actions-node/, manage-flow/, view-and-track-flow-executions/)
- Remove -light/-dark suffixes from image filenames
- Rename images from generic http-N to descriptive names (webhook-*, http-action-*)
- Rename flows/http.md to flows/workflow.md
- Add n8n integration section to workflow.md with payload structure documentation
- Add redirect from flows/http.md to flows/workflow.md
- Update all image paths in flows content pages
…ages)

- Delete old assets from docs/assets/connections/connection/,
  docs/assets/dashboard/, docs/assets/quick-start-guide/, docs/assets/keyboard-shortcuts/
- Add reorganized assets to docs/assets/connections/overview-of-a-connection/
  and docs/assets/using-the-platform/ (web-app/, quick-start-guide/, keyboard-shortcuts/, onboarding/)
- Remove -light/-dark suffixes from image filenames
- Update image paths in connections, web-app, quick-start-guide,
  keyboard-shortcuts, and onboarding content pages
@RafaelOsiro RafaelOsiro self-assigned this Mar 20, 2026
@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Mar 20, 2026
@RafaelOsiro RafaelOsiro marked this pull request as ready for review March 20, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant