Open
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR performs a comprehensive reorganization of the Qualytics User Guide documentation structure. The main goals are:
mkdocs.yml,checks/content section todata-quality-checks/,The asset folder convention adopted across the entire repository is:
docs/{content-section}/{page-name}.md → docs/assets/{content-section}/{page-name}/image.pngAll image filenames were standardized by removing
-lightand-darksuffixes (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 themkdocs.ymlnavigation. The content filesource-datastore/catalog.mdwas renamed tosource-datastore/sync.mdand 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-lightsuffixes likecatalog-light.png,running-catalog-light.png) was replaced bydocs/assets/source-datastore/sync/(31 images with descriptive names likesync-page.png,sync-running-automatically.png). All-light/-darksuffixes 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 todocs/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.mdfiles had their image paths updated accordingly, and-light/-darksuffixes were removed from filenames.Rename checks → data-quality-checks (content): All 55 content files from
docs/checks/were moved todocs/data-quality-checks/to match the "Data Quality Checks" section name displayed in the navigation. Themkdocs.ymlnavigation was updated fromchecks/*todata-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 indocs/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, anddocs/observability/freshness.mdwere also updated.Reorganize checks assets → data-quality-checks: The old
docs/assets/checks/folder contained 575 images spread across subfolders likechecks/manage-checks/,checks/rule-types/,checks/authored-checks/, etc. These were reorganized intodocs/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/-darksuffixes 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 likeflow-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/, andflows/view-and-track-flow-executions/. All 21 flows.mdfiles had their image paths updated.Rename HTTP → Workflow + add n8n integration: The file
docs/flows/http.mdwas renamed todocs/flows/workflow.mdand the navigation label changed from "HTTP" to "Workflow". Generic image names (http-1.pngthroughhttp-9.png) were renamed to descriptive names based on what each screenshot actually shows — images from the Webhook section becamewebhook-settings-panel.png,webhook-fields.png,webhook-test.png, etc., and images from the HTTP Action section becamehttp-action-select.png,http-action-settings-panel.png,http-action-fields.png, etc. A new## n8nsection was added to the page documenting the n8n workflow automation integration, including configuration fields (Webhook URL, Webhook Secret withx-qualytics-secretheader), 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-qualyticscommunity 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 fromflows/http.mdtoflows/workflow.mdwas added.Reorganize remaining assets (connections, dashboard, platform pages): The old
docs/assets/connections/connection/(12 images) was moved todocs/assets/connections/overview-of-a-connection/(9 images). The olddocs/assets/dashboard/(15 images),docs/assets/quick-start-guide/(20 images), anddocs/assets/keyboard-shortcuts/(5 images) were consolidated intodocs/assets/using-the-platform/with subfolders for each page:web-app/,onboarding/,quick-start-guide/, andkeyboard-shortcuts/. Image paths were updated indocs/connections/overview-of-a-connection.md,docs/web-app.md,docs/quick-start-guide.md,docs/keyboard-shortcuts.md, anddocs/onboarding.md.Backward compatibility redirects: All renamed/moved pages have redirect entries configured via the
mkdocs-redirectsplugin inmkdocs.yml:source-datastore/catalog.md→source-datastore/sync.mdflows/http.md→flows/workflow.mdchecks/overview-of-a-check.md→data-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
mkdocs serveand verify the site builds without errors or warnings/source-datastore/catalog/and confirm it redirects to/source-datastore/sync//checks/overview-of-a-check/and confirm it redirects to/data-quality-checks/overview-of-a-check//checks/between-check/,/checks/not-null-check/,/checks/expected-values-check/) and confirm they redirect correctly/flows/http/and confirm it redirects to/flows/workflow/img) to scan for any 404 image errors across the site