mkdocs.yml

site_name: User Guide
## DEPLOYMENT URL
site_url: https://userguide.qualytics.io/
## LOCAL URL
# site_url: http://localhost:8001/userguide/
site_description: User Guide for the Qualytics data quality platform
site_author: Qualytics Team

repo_url: https://github.com/Qualytics/userguide
repo_name: GitHub
edit_uri: edit/main/docs/
copyright: Copyright © 2026 Qualytics

validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: relative_to_docs
    unrecognized_links: warn

# Page tree
nav:
  - Introduction: index.md
    # new page tree structure start
  - Using the Platform:
    - onboarding.md
    - quick-start-guide.md
    - web-app.md
    - keyboard-shortcuts.md
    - Source Datastores:
      - Overview: source-datastore/overview.md
      - Datastore:
        - Getting Started: source-datastore/add-datastores/overview-of-a-datastore.md
        - JDBC:
          - Introduction: source-datastore/add-datastores/overview-of-a-jdbc-datastore.md
          - source-datastore/add-datastores/athena.md
          - source-datastore/add-datastores/bigquery.md
          - source-datastore/add-datastores/databricks.md
          - source-datastore/add-datastores/db2.md
          - source-datastore/add-datastores/fabric-analytics.md
          - source-datastore/add-datastores/hive.md
          - source-datastore/add-datastores/maria-db.md
          - source-datastore/add-datastores/microsoft-sql-server.md
          - source-datastore/add-datastores/mysql.md
          - source-datastore/add-datastores/oracle.md
          - source-datastore/add-datastores/postgresql.md
          - source-datastore/add-datastores/presto.md
          - source-datastore/add-datastores/redshift.md
          - source-datastore/add-datastores/snowflake.md
          - source-datastore/add-datastores/synapse.md
          - source-datastore/add-datastores/teradata.md
          - source-datastore/add-datastores/timescale-db.md
          - source-datastore/add-datastores/trino.md
          - source-datastore/add-datastores/dremio.md
        - DFS:
          - Introduction: source-datastore/add-datastores/overview-of-a-dfs-datastore.md
          - Supported File Formats: source-datastore/add-datastores/dfs-supported-file-formats.md
          - Filename Globbing: source-datastore/add-datastores/dfs-filename-globbing.md
          - source-datastore/add-datastores/amazon-s3.md
          - source-datastore/add-datastores/azure-datalake-storage.md
          - source-datastore/add-datastores/google-cloud-storage.md
        - Connection:
          - Introduction: source-datastore/add-datastores/connections/introduction.md
          - How It Works: source-datastore/add-datastores/connections/how-it-works.md
          - Available Connectors: source-datastore/add-datastores/available-datastore-connectors.md
        - Multiple-Schema:
          - Introduction: source-datastore/add-datastores/multi-schema/overview.md
          - How It Works: source-datastore/add-datastores/multi-schema/how-it-works.md
          - Supported Connectors: source-datastore/add-datastores/multi-schema/supported-connectors.md
          - Permissions: source-datastore/add-datastores/multi-schema/permissions.md
          - FAQ: source-datastore/add-datastores/multi-schema/faq.md
        - Managing:
          - Add Datastore with new connection: source-datastore/add-datastores/connections/new-connection.md
          - Add Datastore with existing connection: source-datastore/add-datastores/connections/existing-connection.md
          - Edit Datastore: source-datastore/managing-datastores/edit-datastore.md
          - Delete Datastore: source-datastore/managing-datastores/delete-datastore.md
        - API: source-datastore/add-datastores/api.md
        - FAQ: source-datastore/add-datastores/faq.md
      - Operations:
        - Sync: source-datastore/operations/sync.md
        - Profile: source-datastore/operations/profile.md
        - Scan: source-datastore/operations/scan.md
        - External Scan: source-datastore/operations/external-scan.md
      - Enrichment Datastore:
        - Getting Started: source-datastore/enrichment-datastore/getting-started.md
        - Deep Dive:
          - Introduction: source-datastore/enrichment-datastore/introduction.md
          - Permissions: source-datastore/enrichment-datastore/permissions.md
        - Managing:
          - Link Enrichment Datastore: source-datastore/managing-datastores/link-enrichment.md
          - Link on Datastore Creation: source-datastore/enrichment-datastore/link-during-creation.md
          - Unlink Enrichment Datastore: source-datastore/managing-datastores/unlink-enrichment.md
        - API: source-datastore/enrichment-datastore/api.md
        - FAQ: source-datastore/enrichment-datastore/faq.md
      - Data Quality Score:
        - Getting Started: source-datastore/data-quality-score/getting-started.md
        - Deep Dive:
          - Introduction: source-datastore/data-quality-score/introduction.md
          - Permissions: source-datastore/data-quality-score/permissions.md
        - Managing:
          - Settings: source-datastore/managing-datastores/quality-score-settings.md
        - API: source-datastore/data-quality-score/api.md
        - FAQ: source-datastore/data-quality-score/faq.md
      - Grouping:
        - Getting Started: source-datastore/managing-datastores/grouping/overview.md
        - Deep Dive:
          - Introduction: source-datastore/managing-datastores/grouping/concepts/understanding-grouping.md
          - Permissions: source-datastore/managing-datastores/grouping/concepts/permissions.md
        - Managing:
          - Create a Group: source-datastore/managing-datastores/grouping/managing-groups/create-a-group.md
          - Edit a Group: source-datastore/managing-datastores/grouping/managing-groups/edit-a-group.md
          - Delete a Group: source-datastore/managing-datastores/grouping/managing-groups/delete-a-group.md
          - Assign a Group: source-datastore/managing-datastores/grouping/managing-groups/assign-a-datastore.md
          - Unassign a Group: source-datastore/managing-datastores/grouping/managing-groups/unassign-a-datastore.md
          - Filter by Group: source-datastore/managing-datastores/grouping/managing-groups/filter-by-group.md
        - API: source-datastore/managing-datastores/grouping/concepts/grouping-api.md
        - FAQ: source-datastore/managing-datastores/grouping/concepts/grouping-faq.md
      - Tags:
        - Getting Started: source-datastore/tags/getting-started.md
        - Deep Dive:
          - Introduction: source-datastore/tags/introduction.md
          - Permissions: source-datastore/tags/permissions.md
        - Managing:
          - Assign a Tag: source-datastore/tags/assign-tags.md
          - Unassign a Tag: source-datastore/tags/unassign-tags.md
        - API: source-datastore/tags/api.md
        - FAQ: source-datastore/tags/faq.md
      - Right Click Options: source-datastore/tips-and-tricks/right-click-options.md
      - Keyboard Shortcuts: source-datastore/tips-and-tricks/keyboard-shortcuts.md
    - Enrichment Datastores:
      - Overview: enrichment/overview-of-an-enrichment-datastore.md
      - Table Types:
        - Overview: enrichment/table-types.md
        - Enrichment Tables: enrichment/enrichment-tables.md
        - Remediation Tables: enrichment/remediation-tables.md
        - Metadata Tables: enrichment/metadata-tables.md
        - API Payload Examples: enrichment/api-payload-examples.md
        - Schema Changelog: enrichment/schema-changelog.md
      - Data Preview: enrichment/enrichment-datastore-preview.md
      - Supported Enrichment Datastores: enrichment-support/supported-enrichment-datastores.md
      - Manage Enrichment:
        - Enrichment Actions: enrichment/enrichment-actions.md
        - Add Enrichment: enrichment/enrichment-datastore-creation.md
        - Edit Enrichment: enrichment/edit-enrichment.md
        - Delete Enrichment: enrichment/delete-enrichment.md
    - Containers:
      - Overview: container/overview.md
      - Container Types: container/container-types.md
      - Container Attributes: container/container-attributes.md
      - Actions on Container: container/actions-on-container.md
      - Manage Tables and Files:
        - Settings For JDBC Table: container/manage-tables-and-files/setting-for-jdbc-table.md
        - Settings For DFS Files Pattern: container/manage-tables-and-files/setting-for-dfs-files-pattern.md
        - Identifiers: container/settings/identifiers.md
        - Grouping: container/settings/grouping.md
        - General: container/settings/general.md
        - Add Checks: container/manage-tables-and-files/add-checks.md
        - Run: container/manage-tables-and-files/run.md
        - Observability Settings: container/manage-tables-and-files/observability-settings.md
        - Export: container/manage-tables-and-files/export.md
        - Materialize: container/manage-tables-and-files/materialize.md
        - Delete: container/manage-tables-and-files/delete.md
        - Mark Tables & Files as Favorite: container/manage-tables-and-files/mark-tables-&-files-as-favorite.md
      - Complex Data Types: container/complex-data-types.md
      - Computed Tables and Files:
        - Overview: container/computed-tables-and-files/overview.md
        - Computed Tables: container/computed-tables-and-files/computed-tables.md
        - Computed Files: container/computed-tables-and-files/computed-files.md
        - Computed Table VS File: container/computed-tables-and-files/computed-table-vs-file.md
      - Computed Join: container/computed-join.md
      - Data Preview: container/data-preview.md
      - Operations:
        - Export Operation: container/operations/export-operation.md
        - Materialize Operation: container/operations/materialize-operation.md
    - Fields:
      - Overview: fields/field-profiles.md
      - Status:
        - Getting Started: fields/field-status/overview.md
        - Deep Dive:
          - Introduction: fields/field-status/concepts/understanding-field-status.md
          - Status Types: fields/field-status/concepts/field-status-types.md
          - Lifecycle: fields/field-status/concepts/field-status-lifecycle.md
          - Field Masking: fields/field-status/concepts/field-masking.md
          - Merge Fields: fields/field-status/concepts/merge-fields.md
        - Managing:
          - Filtering by Status: fields/field-status/managing-field-status/filtering-by-status.md
          - Mask a Field: fields/field-status/managing-field-status/mask-a-field.md
          - Unmask a Field: fields/field-status/managing-field-status/unmask-a-field.md
          - Audit Log: fields/field-status/managing-field-status/masking-audit-log.md
          - Exclude a Field: fields/field-status/managing-field-status/exclude-a-field.md
          - Restore a Field: fields/field-status/managing-field-status/restore-a-field.md
          - Delete a Field: fields/field-status/managing-field-status/delete-a-field.md
          - Merge Fields: fields/field-status/managing-field-status/merge-fields.md
        - API: fields/field-status/concepts/field-status-api.md
        - FAQ: fields/field-status/concepts/field-status-faq.md
      - Computed Fields:
        - Overview: fields/computed-fields/overview.md
        - Transformation Types: fields/computed-fields/transformation-types.md
        - Computed Fields Details: fields/computed-fields/computed-fields-details.md
        - Add Computed Fields: fields/computed-fields/add-computed-fields.md
    - Weight:
      - Weight Mechanism: weight/weighting.md
    - Data Quality Checks:
      - Overview: data-quality-checks/overview-of-a-check.md
      - Authored: data-quality-checks/authored-check.md
      - Inferred: data-quality-checks/inferred-check.md
      - Rule Types:
        - Rule Types Overview: data-quality-checks/rule-types-overview.md
        - After Date Time: data-quality-checks/after-date-check.md
        - Aggregation Comparison: data-quality-checks/aggregation-comparison-check.md
        - Any Not Null: data-quality-checks/any-not-null-check.md
        - Before Date Time: data-quality-checks/before-date-time-check.md
        - Between: data-quality-checks/between-check.md
        - Between Times: data-quality-checks/between-times-check.md
        - Contains Credit Card: data-quality-checks/contains-credit-card-check.md
        - Contains Email: data-quality-checks/contains-email-check.md
        - Contains Social Security Number: data-quality-checks/contains-social-security-number-check.md
        - Contains Url: data-quality-checks/contains-url.md
        - Data Diff: data-quality-checks/data-diff-check.md
        - Distinct Count: data-quality-checks/distinct-count-check.md
        - Entity Resolution: data-quality-checks/entity-resolution.md
        - Equal to: data-quality-checks/equal-to-check.md
        - Equal to Field: data-quality-checks/equal-to-field-check.md
        - Exists In: data-quality-checks/exists-in-check.md
        - Expected Schema: data-quality-checks/expected-schema-check.md
        - Expected Values: data-quality-checks/expected-values-check.md
        - Field Count: data-quality-checks/field-count-check.md
        - Freshness Checks: data-quality-checks/freshness-check.md
        - Greater Than: data-quality-checks/greater-than-check.md
        - Greater Than Field: data-quality-checks/greater-than-field-check.md
        - Is Address: data-quality-checks/is-address.md
        - Is Credit Card: data-quality-checks/is-credit-card-check.md
        - Is Replica Of: data-quality-checks/is-replica-of-check.md
        - Is Type: data-quality-checks/is-type-check.md
        - Less Than: data-quality-checks/less-than-check.md
        - Less Than Field: data-quality-checks/less-than-field-check.md
        - Matches Pattern: data-quality-checks/matches-pattern-check.md
        - Max Length: data-quality-checks/max-length-check.md
        - Max Partition Size: data-quality-checks/max-partition-size-check.md
        - Max Value: data-quality-checks/max-value-check.md
        - Metric: data-quality-checks/metric-check.md
        - Min Length: data-quality-checks/min-length-check.md
        - Min Partition Size: data-quality-checks/min-partition-size-check.md
        - Min Value: data-quality-checks/min-value-check.md
        - Not Exists In: data-quality-checks/not-exists-in-check.md
        - Not Future: data-quality-checks/not-future-check.md
        - Not Negative: data-quality-checks/not-negative-check.md
        - Not Null: data-quality-checks/not-null-check.md
        - Positive: data-quality-checks/positive-check.md
        - Predicted By: data-quality-checks/predicted-by-check.md
        - Required Values: data-quality-checks/required-values-check.md
        - Satisfies Expression: data-quality-checks/satisfies-expression-check.md
        - Sum: data-quality-checks/sum-check.md
        - Time Distribution Size: data-quality-checks/time-distribution-size-check.md
        - Unique: data-quality-checks/unique-check.md
        - Volumetric Checks: data-quality-checks/volumetric-check.md
      - Check Templates: data-quality-checks/checks-template.md
      - Apply Check Template for Quality Check: data-quality-checks/apply-check-template-for-quality-checks.md
      - Export Check Templates: data-quality-checks/export-check-templates.md
    - Datastore Checks:
      - Checks : datastore-checks/checks-datastore.md
      - Manage Checks :
        - Overview : datastore-checks/overview.md
        - Draft Checks : datastore-checks/draft-checks.md
        - Activate Draft Check : datastore-checks/activate-draft-check.md
        - Archive Checks : datastore-checks/archive-check.md
        - Activate Archived Checks :  datastore-checks/activate-archived-checks.md
        - Draft Archived Checks : datastore-checks/draft-archived-checks.md
        - Restore Archived Checks : datastore-checks/restore-archived-checks.md
        - Edit Checks : datastore-checks/edit-checks.md
        - Delete Checks : datastore-checks/delete-checks.md
        - Dry Run : datastore-checks/dry-run.md
        - Clone Check : datastore-checks/clone-check.md
        - Quality Check Template : datastore-checks/quality-check-template.md
        - Mark Check Favorite : datastore-checks/check-favorite.md
        - Filter and Sort : datastore-checks/filter-and-sort.md
        - Quality Check Migration : datastore-checks/quality-check-migration.md
    - Observability:
      - Overview: observability/observability.md
      - Observability Categories:
        - Measures: observability/measures.md
        - Metric: observability/metric-check.md
        - Volumetric: observability/volumetric.md
        - Freshness: observability/freshness.md
      - Manage Observability:
        - Overview: observability/manage-observability.md
        - Edit Check: observability/edit-check.md
        - Edit Threshold: observability/edit-threshold.md
        - Edit Maximum Age: observability/edit-maximum-age.md
        - Mark Check as Favorite: observability/mark-check.md
        - Observability Filter: observability/observability-filter.md
    - Anomalies:
      - Overview: anomalies/anomalies.md
      - Types: anomalies/anomaly-types.md
      - Detection: anomalies/anomaly-detection.md
      - Details:
        - Insights: anomalies/anomaly-insights.md
        - Source Record: anomalies/source-record.md
      - Status: anomalies/anomaly-status.md
      - Fingerprints: anomalies/anomaly-fingerprints.md
      - Manage Anomalies:
        - Acknowledge Anomalies: anomalies/acknowledge-anomalies.md
        - Archive Anomalies: anomalies/archive-anomalies.md
        - Restore Anomalies: anomalies/restore-anomalies.md
        - Edit Anomalies: anomalies/edit-anomalies.md
        - Delete Anomalies: anomalies/delete-anomalies.md
        - Filter & Sort: anomalies/filter-and-sort.md
    - Explore:
      - Overview: explore/overview-of-explore.md
      - Insights: explore/insights.md
      - Activity: explore/activity.md
      - Profiles: explore/profiles.md
      - Observability: explore/observability.md
      - Checks: explore/checks.md
      - Anomalies: explore/anomalies.md
    - Flows:
      - Overview: flows/overview.md
      - Add Flow: flows/add-flow.md
      - Flow Entry: flows/flow-entry.md
      - Trigger Node: flows/trigger-node.md
      - Actions Node: 
        - Overview: flows/overview-action.md
        - Operations: flows/operations.md
        - Anomaly: flows/anomaly.md
        - Notifications:
          - Overview: flows/notifications/overview.md
          - Message Variables: flows/notifications/message-variables.md
          - In App:
            - Overview: flows/notifications/in-app/overview.md
            - API: flows/notifications/in-app/api.md
            - FAQ: flows/notifications/in-app/faq.md
          - Email:
            - Overview: flows/notifications/email/overview.md
            - API: flows/notifications/email/api.md
            - FAQ: flows/notifications/email/faq.md
          - Slack:
            - Overview: flows/notifications/slack/overview.md
            - API: flows/notifications/slack/api.md
            - FAQ: flows/notifications/slack/faq.md
          - Microsoft Teams:
            - Overview: flows/notifications/microsoft-teams/overview.md
            - API: flows/notifications/microsoft-teams/api.md
            - FAQ: flows/notifications/microsoft-teams/faq.md
          - PagerDuty:
            - Overview: flows/notifications/pagerduty/overview.md
            - API: flows/notifications/pagerduty/api.md
            - FAQ: flows/notifications/pagerduty/faq.md
          - FAQ: flows/notifications/faq.md
        - Workflow: flows/workflow.md
        - Ticketing: flows/ticketing.md
      - View and Track Flow Executions: flows/view-created-flows.md
      - Manage Flow:
        - Clone a Flows: flows/clone-a-flow.md
        - Execute Manual Flow: flows/execute-manual-flows.md
        - Abort Flow: flows/abort.md
        - Sort Flow: flows/sort-flow.md
        - Edit Flow: flows/edit-flow.md
        - Delete Flow: flows/delete-flow.md
        - Deactivate Flow: flows/deactivate-flow.md
        - Activate Flows: flows/activate-flow.md
        - Clone An Action: flows/clone-an-action.md 
        - Move An Action Node: flows/move-an-action-node.md
    - Tags:
      - Overview: tags/overview.md
      - External Tags: tags/external-tag.md
      - Manage Tags:
        - Add Tag: tags/add-tag.md
        - Applying Tag: tags/applying-a-tag.md
        - Edit Tag: tags/edit-tag.md
        - Filter and Sort: tags/filter-and-sort.md
        - Delete Tag: tags/delete-tag.md
    - Settings:
      - Connections: settings/connections/manage-connections.md
      - Security:
        - Overview: settings/security/overview.md
        - Team Permissions: settings/security/team-permissions.md
        - Directory Sync: settings/security/directory-sync.md
      - Tokens: settings/tokens/overview-of-tokens.md
      - Service Account: 
        - Overview: settings/service-account/service-account.md
        - Create Service Account: settings/service-account/create-service-account.md 
      - Service Token:
        - Overview: settings/service-token/overview.md
        - Service Token: settings/service-token/service-token.md
        - Generate Service Account: settings/service-token/generate-service-token.md
        - Token Usage Status: settings/service-token/token-usage-status.md
        - Revoking Service Token: settings/service-token/revoking-service-token.md
        - Restore Service Token: settings/service-token/restore-service-token.md
        - Delete Service Token: settings/service-token/delete-service-token.md
        - Team Membership Strategy: settings/service-token/team-membership-strategy.md
        - Best Practices: settings/service-token/best-practices.md
      - Status: settings/status/overview-of-status.md
    - Qualytics CLI:
        - Overview: cli/overview.md
        - Authentication: cli/authentication.md
        - Connections: cli/connections.md
        - Datastores: cli/datastores.md
        - Containers: cli/containers.md
        - Quality Checks: cli/quality-checks.md
        - Operations: cli/operations.md
        - Anomalies: cli/anomalies.md
        - Users: cli/users.md
        - Teams: cli/teams.md
        - Tags: cli/tags.md
        - Config as Code: cli/config-as-code.md
        - MCP Server: cli/mcp-server.md
        - Automation & CI/CD: cli/automation.md
        - Installing Python: cli/python-installation.md
    - Integrations:
        - Overview: settings/integrations/overview.md
        - Data Catalogs:
          - Overview: settings/integrations/data-catalogs/overview.md
          - Atlan: settings/integrations/data-catalogs/atlan.md
          - Alation: settings/integrations/data-catalogs/alation.md
          - Microsoft Purview: settings/integrations/data-catalogs/microsoft-purview.md
          - Collibra: settings/integrations/data-catalogs/collibra.md
          - DataHub: settings/integrations/data-catalogs/datahub.md
          - External Tag Propagation: settings/integrations/data-catalogs/external-tag-propagation.md
        - Single Sign-On: settings/integrations/sso/sso.md
        - Compute: settings/integrations/compute/compute.md
        - Alerting:
          - Overview: settings/integrations/alerting/overview.md
          - Slack: settings/integrations/alerting/slack.md
          - Microsoft Teams: settings/integrations/alerting/msft_teams.md
          - PagerDuty:
            - Overview: settings/integrations/alerting/pagerduty/overview.md
            - Deep Dive: settings/integrations/alerting/pagerduty/deep-dive.md
            - API: settings/integrations/alerting/pagerduty/pagerduty-api.md
            - FAQ: settings/integrations/alerting/pagerduty/pagerduty-faq.md
            - Managing PagerDuty:
              - Add Integration: settings/integrations/alerting/pagerduty/managing-pagerduty/add-integration.md
              - Edit Integration: settings/integrations/alerting/pagerduty/managing-pagerduty/edit-integration.md
              - Remove Integration: settings/integrations/alerting/pagerduty/managing-pagerduty/remove-integration.md
        - Ticketing: 
          - Overview: settings/integrations/ticketing/ticketing.md
          - Jira: settings/integrations/ticketing/jira.md
          - ServiceNow: settings/integrations/ticketing/servicenow.md
        - Workflow: settings/integrations/workflow/workflow.md
        - Analytics: settings/integrations/analytics/analytics.md
        - AI & Agents:
          - Overview: settings/integrations/ai-and-agents/overview.md
          - Deep Dive:
            - MCP: settings/integrations/ai-and-agents/deep-dive/mcp.md
            - Agent Q in Action: settings/integrations/ai-and-agents/deep-dive/agent-q-in-action.md
            - Conversations, Responses & Context: settings/integrations/ai-and-agents/deep-dive/agent-q-conversations.md
            - Best Practices: settings/integrations/ai-and-agents/deep-dive/agent-q-best-practices.md
            - Agent Q Limits: settings/integrations/ai-and-agents/deep-dive/agent-q-limits.md
            - Agentic API: settings/integrations/ai-and-agents/deep-dive/agentic.md
          - Managing:
            - Connecting External AI Clients: settings/integrations/ai-and-agents/managing/connecting-external-ai-clients.md
            - Add Integration: settings/integrations/ai-and-agents/managing/add-agent-q-integration.md
            - Update Integration: settings/integrations/ai-and-agents/managing/update-agent-q-integration.md
            - Remove Integration: settings/integrations/ai-and-agents/managing/remove-agent-q-integration.md
            - Start a New Conversation: settings/integrations/ai-and-agents/managing/start-a-new-conversation.md
            - Resume a Conversation: settings/integrations/ai-and-agents/managing/resume-a-conversation.md
            - Rename a Conversation: settings/integrations/ai-and-agents/managing/rename-a-conversation.md
            - Archive a Conversation: settings/integrations/ai-and-agents/managing/archive-a-conversation.md
            - Restore a Conversation: settings/integrations/ai-and-agents/managing/restore-a-conversation.md
            - Delete a Conversation: settings/integrations/ai-and-agents/managing/delete-a-conversation.md
            - Search Conversations: settings/integrations/ai-and-agents/managing/search-conversations.md
            - Chat Interface Tips: settings/integrations/ai-and-agents/managing/chat-interface-tips.md
          - API: settings/integrations/ai-and-agents/agent-q-api.md
          - FAQ: settings/integrations/ai-and-agents/agent-q-faq.md
    - FAQ:
      - quality-scores/what-are-quality-scores.md
      - printing.md
    - Misc:
      - Deployment Options: deployments/overview.md
      - SSO Setup (Managed Customers): deployments/sso.md
      - Self-Hosted Deployment:
        - Deployment Guide: deployments/self-hosted-deployment.md
        - OIDC Authentication: deployments/oidc-configuration.md
        - Auth0 Authentication: deployments/auth0-setup.md
      - Databricks Deployment: deployments/databricks-deployment.md
      - External Automation:
        - Overview: operation-automation/overview.md
        - Linux Machine: operation-automation/linux-machine.md
        - Windows Machine: operation-automation/windows-machine.md
        - Automated Setup Using Qualytics CLI: operation-automation/automated-setup-using-qualytics-cli.md
      - dfs-globbing/how-dfs-filename-globbing-works.md
      - glossary.md

  # - glossary.md
  - API docs: https://demo.qualytics.io/api/docs
  - Changelog:
    - changelog.md
    - changelog-2025.md
    - changelog-2024.md
    - changelog-2023.md

extra_javascript:
  - javascripts/os-detect.js
  - javascripts/card-filter.js

extra_css:
  - stylesheets/extra.css

# Configuration
theme:
  palette:
    # Palette toggle for light mode
    # - media: "(prefers-color-scheme: light)"
    - scheme: default
      primary: white
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode

    # Palette toggle for dark mode
    # - media: "(prefers-color-scheme: --md-primary-fg-color--dark)"
    - scheme: slate
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  logo: assets/logo-light.svg
  favicon: assets/favicon.ico
  name: material
  custom_dir: overrides
  font:
    text: Manrope

  features:
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.tables.sortable  # Adds horizontal scroll only to table
    # - content.tabs.link

markdown_extensions:
  - pymdownx.tabbed:
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - exclude:
      glob:
        - components/anomaly-support/*
        - components/comparators/*
        - components/general-props/*
  - git-revision-date-localized
  - include-markdown
  - macros
  - redirects:
      redirect_maps:
        'settings/integrations/atlan.md': 'settings/integrations/data-catalogs/atlan.md'
        'settings/integrations/catalog/atlan.md': 'settings/integrations/data-catalogs/atlan.md'
        'settings/integrations/catalog/alation.md': 'settings/integrations/data-catalogs/alation.md'
        'settings/integrations/catalog/collibra.md': 'settings/integrations/data-catalogs/collibra.md'
        'settings/integrations/catalog/datahub.md': 'settings/integrations/data-catalogs/datahub.md'
        'settings/integrations/catalog/external-tag-propagation.md': 'settings/integrations/data-catalogs/external-tag-propagation.md'
        'settings/integrations/catalog/purview.md': 'settings/integrations/data-catalogs/microsoft-purview.md'
        'settings/integrations/catalog/overview.md': 'settings/integrations/data-catalogs/overview.md'
        'deployments/deployments.md': 'deployments/overview.md'
        'upgrades/qualytics-single-tenant-instance.md': 'deployments/self-hosted-deployment.md'
        'container/field-profiles.md': 'fields/field-profiles.md'
        'container/computed-fields/overview.md': 'fields/computed-fields/overview.md'
        'container/computed-fields/transformation-types.md': 'fields/computed-fields/transformation-types.md'
        'container/computed-fields/computed-fields-details.md': 'fields/computed-fields/computed-fields-details.md'
        'container/computed-fields/add-computed-fields.md': 'fields/computed-fields/add-computed-fields.md'
        # Notifications restructure
        'flows/notification.md': 'flows/notifications/overview.md'
        'flows/notification-tokens.md': 'flows/notifications/message-variables.md'
        'flows/notifications/in-app.md': 'flows/notifications/in-app/overview.md'
        'flows/notifications/email.md': 'flows/notifications/email/overview.md'
        'flows/notifications/slack.md': 'flows/notifications/slack/overview.md'
        'flows/notifications/microsoft-teams.md': 'flows/notifications/microsoft-teams/overview.md'
        'flows/notifications/pagerduty.md': 'flows/notifications/pagerduty/overview.md'
        # Source Datastore reorganization
        'source-datastore/catalog.md': 'source-datastore/operations/sync.md'
        'source-datastore/operations/catalog.md': 'source-datastore/operations/sync.md'
        'source-datastore/profile.md': 'source-datastore/operations/profile.md'
        'source-datastore/scan.md': 'source-datastore/operations/scan.md'
        'source-datastore/external-scan.md': 'source-datastore/operations/external-scan.md'
        'source-datastore/right-click-options.md': 'source-datastore/tips-and-tricks/right-click-options.md'
        'source-datastore/assign-tags.md': 'source-datastore/tags/assign-tags.md'
        'source-datastore/settings-overview.md': 'source-datastore/managing-datastores/edit-datastore.md'
        'source-datastore/edit-datastore.md': 'source-datastore/managing-datastores/edit-datastore.md'
        'source-datastore/link-enrichment.md': 'source-datastore/managing-datastores/link-enrichment.md'
        'source-datastore/unlink-enrichment.md': 'source-datastore/managing-datastores/unlink-enrichment.md'
        'source-datastore/quality-score-settings.md': 'source-datastore/managing-datastores/quality-score-settings.md'
        'source-datastore/delete-datastore.md': 'source-datastore/managing-datastores/delete-datastore.md'
        # Old paths redirect to new managing-datastores location
        'source-datastore/navigation-and-organization/right-click-options.md': 'source-datastore/tips-and-tricks/right-click-options.md'
        'source-datastore/navigation-and-organization/assign-tags.md': 'source-datastore/tags/assign-tags.md'
        'source-datastore/managing-datastores/assign-tags.md': 'source-datastore/tags/assign-tags.md'
        'source-datastore/datastore-settings/settings-overview.md': 'source-datastore/managing-datastores/edit-datastore.md'
        'source-datastore/datastore-settings/edit-datastore.md': 'source-datastore/managing-datastores/edit-datastore.md'
        'source-datastore/datastore-settings/link-enrichment.md': 'source-datastore/managing-datastores/link-enrichment.md'
        'source-datastore/datastore-settings/unlink-enrichment.md': 'source-datastore/managing-datastores/unlink-enrichment.md'
        'source-datastore/datastore-settings/quality-score-settings.md': 'source-datastore/managing-datastores/quality-score-settings.md'
        'source-datastore/datastore-settings/delete-datastore.md': 'source-datastore/managing-datastores/delete-datastore.md'
        # Container Operations reorganization
        'container/enrichment-operation/export-operation.md': 'container/operations/export-operation.md'
        'container/enrichment-operation/materialize-operation.md': 'container/operations/materialize-operation.md'
        # Add Datastores moved into Source Datastores
        'add-datastores/overview-of-a-datastore.md': 'source-datastore/add-datastores/overview-of-a-datastore.md'
        'add-datastores/overview-of-a-jdbc-datastore.md': 'source-datastore/add-datastores/overview-of-a-jdbc-datastore.md'
        'add-datastores/overview-of-a-dfs-datastore.md': 'source-datastore/add-datastores/overview-of-a-dfs-datastore.md'
        'add-datastores/athena.md': 'source-datastore/add-datastores/athena.md'
        'add-datastores/bigquery.md': 'source-datastore/add-datastores/bigquery.md'
        'add-datastores/databricks.md': 'source-datastore/add-datastores/databricks.md'
        'add-datastores/db2.md': 'source-datastore/add-datastores/db2.md'
        'add-datastores/fabric-analytics.md': 'source-datastore/add-datastores/fabric-analytics.md'
        'add-datastores/hive.md': 'source-datastore/add-datastores/hive.md'
        'add-datastores/maria-db.md': 'source-datastore/add-datastores/maria-db.md'
        'add-datastores/microsoft-sql-server.md': 'source-datastore/add-datastores/microsoft-sql-server.md'
        'add-datastores/mysql.md': 'source-datastore/add-datastores/mysql.md'
        'add-datastores/oracle.md': 'source-datastore/add-datastores/oracle.md'
        'add-datastores/postgresql.md': 'source-datastore/add-datastores/postgresql.md'
        'add-datastores/presto.md': 'source-datastore/add-datastores/presto.md'
        'add-datastores/redshift.md': 'source-datastore/add-datastores/redshift.md'
        'add-datastores/snowflake.md': 'source-datastore/add-datastores/snowflake.md'
        'add-datastores/synapse.md': 'source-datastore/add-datastores/synapse.md'
        'add-datastores/teradata.md': 'source-datastore/add-datastores/teradata.md'
        'add-datastores/timescale-db.md': 'source-datastore/add-datastores/timescale-db.md'
        'add-datastores/trino.md': 'source-datastore/add-datastores/trino.md'
        'add-datastores/dremio.md': 'source-datastore/add-datastores/dremio.md'
        'add-datastores/amazon-s3.md': 'source-datastore/add-datastores/amazon-s3.md'
        'add-datastores/azure-datalake-storage.md': 'source-datastore/add-datastores/azure-datalake-storage.md'
        'add-datastores/google-cloud-storage.md': 'source-datastore/add-datastores/google-cloud-storage.md'
        'connections/overview-of-a-connection.md': 'source-datastore/add-datastores/connections/introduction.md'
        'source-datastore/add-datastores/connections/overview-of-a-connection.md': 'source-datastore/add-datastores/connections/introduction.md'
        # Multi-schema concepts folder removed
        'source-datastore/add-datastores/multi-schema/concepts/how-it-works.md': 'source-datastore/add-datastores/multi-schema/how-it-works.md'
        'source-datastore/add-datastores/multi-schema/concepts/supported-connectors.md': 'source-datastore/add-datastores/multi-schema/supported-connectors.md'
        'source-datastore/add-datastores/multi-schema/concepts/multi-schema-permissions.md': 'source-datastore/add-datastores/multi-schema/permissions.md'
        'source-datastore/add-datastores/multi-schema/concepts/multi-schema-faq.md': 'source-datastore/add-datastores/multi-schema/faq.md'
        # Catalog to Sync redirect
        'source-datastore/sync.md': 'source-datastore/operations/sync.md'
        # AI integrations redirects
        'settings/integrations/ai/mcp.md': 'settings/integrations/ai-and-agents/deep-dive/mcp.md'
        'settings/integrations/ai/agentic.md': 'settings/integrations/ai-and-agents/deep-dive/agentic.md'
        'settings/integrations/ai/mcp-quickstart.md': 'settings/integrations/ai-and-agents/managing/add-agent-q-integration.md'
        'settings/integrations/ai-and-agents/managing/update-llm-integration.md': 'settings/integrations/ai-and-agents/managing/update-agent-q-integration.md'
        'settings/integrations/ai-and-agents/managing/remove-llm-integration.md': 'settings/integrations/ai-and-agents/managing/remove-agent-q-integration.md'
        'settings/integrations/ai-and-agents/managing/how-to-use-agent-q.md': 'settings/integrations/ai-and-agents/overview.md'
        'flows/http.md': 'flows/workflow.md'
        # Checks renamed to data-quality-checks (from main)
        'checks/overview-of-a-check.md': 'data-quality-checks/overview-of-a-check.md'
        'checks/authored-check.md': 'data-quality-checks/authored-check.md'
        'checks/inferred-check.md': 'data-quality-checks/inferred-check.md'
        'checks/rule-types-overview.md': 'data-quality-checks/rule-types-overview.md'
        'checks/after-date-check.md': 'data-quality-checks/after-date-check.md'
        'checks/aggregation-comparison-check.md': 'data-quality-checks/aggregation-comparison-check.md'
        'checks/any-not-null-check.md': 'data-quality-checks/any-not-null-check.md'
        'checks/before-date-time-check.md': 'data-quality-checks/before-date-time-check.md'
        'checks/between-check.md': 'data-quality-checks/between-check.md'
        'checks/between-times-check.md': 'data-quality-checks/between-times-check.md'
        'checks/contains-credit-card-check.md': 'data-quality-checks/contains-credit-card-check.md'
        'checks/contains-email-check.md': 'data-quality-checks/contains-email-check.md'
        'checks/contains-social-security-number-check.md': 'data-quality-checks/contains-social-security-number-check.md'
        'checks/contains-url.md': 'data-quality-checks/contains-url.md'
        'checks/data-diff-check.md': 'data-quality-checks/data-diff-check.md'
        'checks/distinct-count-check.md': 'data-quality-checks/distinct-count-check.md'
        'checks/entity-resolution.md': 'data-quality-checks/entity-resolution.md'
        'checks/equal-to-check.md': 'data-quality-checks/equal-to-check.md'
        'checks/equal-to-field-check.md': 'data-quality-checks/equal-to-field-check.md'
        'checks/exists-in-check.md': 'data-quality-checks/exists-in-check.md'
        'checks/expected-schema-check.md': 'data-quality-checks/expected-schema-check.md'
        'checks/expected-values-check.md': 'data-quality-checks/expected-values-check.md'
        'checks/field-count-check.md': 'data-quality-checks/field-count-check.md'
        'checks/freshness-check.md': 'data-quality-checks/freshness-check.md'
        'checks/greater-than-check.md': 'data-quality-checks/greater-than-check.md'
        'checks/greater-than-field-check.md': 'data-quality-checks/greater-than-field-check.md'
        'checks/is-address.md': 'data-quality-checks/is-address.md'
        'checks/is-credit-card-check.md': 'data-quality-checks/is-credit-card-check.md'
        'checks/is-replica-of-check.md': 'data-quality-checks/is-replica-of-check.md'
        'checks/is-type-check.md': 'data-quality-checks/is-type-check.md'
        'checks/less-than-check.md': 'data-quality-checks/less-than-check.md'
        'checks/less-than-field-check.md': 'data-quality-checks/less-than-field-check.md'
        'checks/matches-pattern-check.md': 'data-quality-checks/matches-pattern-check.md'
        'checks/max-length-check.md': 'data-quality-checks/max-length-check.md'
        'checks/max-partition-size-check.md': 'data-quality-checks/max-partition-size-check.md'
        'checks/max-value-check.md': 'data-quality-checks/max-value-check.md'
        'checks/metric-check.md': 'data-quality-checks/metric-check.md'
        'checks/min-length-check.md': 'data-quality-checks/min-length-check.md'
        'checks/min-partition-size-check.md': 'data-quality-checks/min-partition-size-check.md'
        'checks/min-value-check.md': 'data-quality-checks/min-value-check.md'
        'checks/not-exists-in-check.md': 'data-quality-checks/not-exists-in-check.md'
        'checks/not-future-check.md': 'data-quality-checks/not-future-check.md'
        'checks/not-negative-check.md': 'data-quality-checks/not-negative-check.md'
        'checks/not-null-check.md': 'data-quality-checks/not-null-check.md'
        'checks/positive-check.md': 'data-quality-checks/positive-check.md'
        'checks/predicted-by-check.md': 'data-quality-checks/predicted-by-check.md'
        'checks/required-values-check.md': 'data-quality-checks/required-values-check.md'
        'checks/satisfies-expression-check.md': 'data-quality-checks/satisfies-expression-check.md'
        'checks/sum-check.md': 'data-quality-checks/sum-check.md'
        'checks/time-distribution-size-check.md': 'data-quality-checks/time-distribution-size-check.md'
        'checks/unique-check.md': 'data-quality-checks/unique-check.md'
        'checks/volumetric-check.md': 'data-quality-checks/volumetric-check.md'
        'checks/checks-template.md': 'data-quality-checks/checks-template.md'
        'checks/apply-check-template-for-quality-checks.md': 'data-quality-checks/apply-check-template-for-quality-checks.md'
        'checks/export-check-templates.md': 'data-quality-checks/export-check-templates.md'
  - print-site:
      add_to_navigation: false
      print_page_title: 'Print Site'
      add_print_site_banner: false
      # Table of contents
      add_table_of_contents: false
      toc_title: 'Table of Contents'
      toc_depth: 6
      # Content-related
      add_full_urls: false
      enumerate_headings: false
      enumerate_figures: true
      add_cover_page: true
      cover_page_template: ""
      path_to_pdf: ""
      include_css: true
      enabled: !ENV [MKDOCS_SERVE, true] # disable the print plugin when we are developing locally
      exclude:

extra:
  homepage: https://qualytics.ai
  analytics:
    provider: google
    property: G-46N5E3NXG0
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/Qualytics/userguide/issues" target="_blank" rel="noopener">issue tracker for this user guide</a>.
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
  comparator_short_desc: Specifies how variations are handled, allowing for slight deviations within a defined margin of error.