-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
296 lines (283 loc) · 10.9 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
site_name: User Guide
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 © 2024 Qualytics
# Page tree
nav:
- Home: https://qualytics.ai
- Introduction: index.md
# new page tree structure start
- Getting Started:
- onboarding.md
- quick-start-guide.md
- technical-quick-start-guide.md
- dashboard.md
- glossary.md
- Add Datastores:
- add-datastores/overview-of-a-datastore.md
- JDBC Datastores:
- add-datastores/overview-of-a-jdbc-datastore.md
- add-datastores/athena.md
- add-datastores/bigquery.md
- add-datastores/databricks.md
- add-datastores/db2.md
- add-datastores/hive.md
- add-datastores/maria-db.md
- add-datastores/microsoft-sql-server.md
- add-datastores/mysql.md
- add-datastores/oracle.md
- add-datastores/postgresql.md
- add-datastores/presto.md
- add-datastores/redshift.md
- add-datastores/snowflake.md
- add-datastores/synapse.md
- add-datastores/teradata.md
- add-datastores/timescale-db.md
- add-datastores/trino.md
- add-datastores/dremio.md
- DFS Datastores:
- add-datastores/overview-of-a-dfs-datastore.md
- add-datastores/amazon-s3.md
- add-datastores/azure-blob-storage.md
- add-datastores/azure-datalake-storage.md
- add-datastores/google-cloud-storage.md
- add-datastores/qfs.md
- connections/overview-of-a-connection.md
# new page tree structure end
- Source Datastores:
- Right Click Options: source-datastore/right-click-options.md
- Link Enrichment: source-datastore/associate-enrichment-datastore.md
- Assign Tags: source-datastore/assign-tags.md
- Catalog: source-datastore/catalog.md
- Profile: source-datastore/profile.md
- Scan: source-datastore/scan.md
- External Scan: source-datastore/external-scan.md
- Datastore Settings: source-datastore/datastore-settings.md
- Enrichment Datastores:
- Overview: enrichment/overview-of-an-enrichment-datastore.md
- Data Preview: enrichment/enrichment-datastore-preview.md
- Add Enrichment: enrichment/enrichment-datastore-creation.md
- Containers:
- Overview: container/container.md
- Data Preview: container/data-preview.md
- Computed Tables and Files: container/computed-tables-and-files.md
- Manage Tables and Files: container/manage-tables-and-files.md
- Computed Fields: container/overview-of-a-computed-field.md
- Export Metadata: container/export-metadata.md
- Settings:
- Identifiers: container/overview-of-identifiers.md
- Grouping: container/overview-of-grouping.md
- General: container/overview-of-infer-data-type.md
- Data Quality Checks:
- Overview: checks/overview-of-a-check.md
- Manage Checks: checks/manage-checks.md
- Authored: checks/authored-check.md
- Inferred: checks/inferred-check.md
- Rule Types:
- After Date: checks/after-date-check.md
- Aggregation Comparison: checks/aggregation-comparison-check.md
- Any Not Null: checks/any-not-null-check.md
- Before Date Time: checks/before-date-time-check.md
- Between: checks/between-check.md
- Between Times: checks/between-times-check.md
- Contains Credit Card: checks/contains-credit-card-check.md
- Contains Email: checks/contains-email-check.md
- Contains Social Security Number: checks/contains-social-security-number-check.md
- Contains Url: checks/contains-url.md
- Distinct Count: checks/distinct-count-check.md
- Entity Resolution: checks/entity-resolution.md
- Equal to: checks/equal-to-check.md
- Equal to Field: checks/equal-to-field-check.md
- Exists In: checks/exists-in-check.md
- Expected Schema: checks/expected-schema-check.md
- Expected Values: checks/expected-values-check.md
- Field Count: checks/field-count-check.md
- Greater Than: checks/greater-than-check.md
- Greater Than Field: checks/greater-than-field-check.md
- Is Address: checks/is-address.md
- Is Credit Card: checks/is-credit-card-check.md
- Is Replica Of: checks/is-replica-of-check.md
- Is Type: checks/is-type-check.md
- Less Than: checks/less-than-check.md
- Less Than Field: checks/less-than-field-check.md
- Matches Pattern: checks/matches-pattern-check.md
- Max Length: checks/max-length-check.md
- Max Partition Size: checks/max-partition-size-check.md
- Max Value: checks/max-value-check.md
- Metric: checks/metric-check.md
- Min Length: checks/min-length-check.md
- Min Partition Size: checks/min-partition-size-check.md
- Min Value: checks/min-value-check.md
- Not Exists In: checks/not-exists-in-check.md
- Not Future: checks/not-future-check.md
- Not Negative: checks/not-negative-check.md
- Not Null: checks/not-null-check.md
- Positive: checks/positive-check.md
- Predicted By: checks/predicted-by-check.md
- Required Values: checks/required-values-check.md
- Satisfies Expression: checks/satisfies-expression-check.md
- Sum: checks/sum-check.md
- Time Distribution Size: checks/time-distribution-size-check.md
- Unique: checks/unique-check.md
- User Defined Function: checks/user-defined-function-check.md
- Volumetric Checks: checks/volumetric-check.md
- Check Templates: checks/checks-template.md
- Apply Check Template for Quality Check: checks/apply-check-template-for-quality-checks.md
- Export Check Templates: checks/export-check-templates.md
- Observability:
- Overview: observability/observability.md
- Anomalies:
- Anomaly Analysis: anomalies/anomalies.md
- Manage Anomalies: anomalies/manage-anomalies.md
- Explore:
- Overview: explore/overview-of-explore.md
- Insights: explore/insights.md
- Activity: explore/activity.md
- Profiles: explore/profiles.md
- Checks: explore/checks.md
- Anomalies: explore/anomalies.md
- Notifications:
- Overview: notifications/overview-of-a-notification.md
- Manage Notifications: notifications/managing-notifications.md
- Channels:
- notifications/notification-services/email.md
- notifications/notification-services/http-action.md
- notifications/notification-services/microsoft-teams.md
- notifications/notification-services/pagerduty.md
- notifications/notification-services/slack.md
- notifications/notification-services/webhook.md
- Tags:
- Overview: tags/overview-of-tag.md
- Settings:
- Connections: settings/connections/manage-connections.md
- Integrations:
- Overview: settings/integrations/overview.md
- Atlan: settings/integrations/atlan.md
- Alation: settings/integrations/alation.md
- External Tag Propagation: settings/integrations/external-tag-propagation.md
- Security: settings/security/teams-and-permissions.md
- Tokens: settings/tokens/overview-of-tokens.md
- Health: settings/health/overview-of-health.md
- Qualytics CLI:
- Overview: cli/overview-of-qualytics-cli.md
- FAQ:
- quality-scores/what-are-quality-scores.md
- printing.md
- Misc:
- sso/sso.md
- deployments/deployments.md
- upgrades/qualytics-single-tenant-instance.md
- operation-automation/automated-tasks-with-cron.md
- dfs-globbing/how-dfs-filename-globbing-works.md
# - glossary.md
- API reference: https://demo.qualytics.io/api/docs
- changelog.md
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.png
favicon: assets/Q_sm_logo.png
name: material
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.tabs.link
markdown_extensions:
- pymdownx.tabbed:
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- pymdownx.snippets
- attr_list
- md_in_html
- pymdownx.superfences
- def_list
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- 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
- git-revision-date-localized
- include-markdown
- macros
- 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:
analytics:
provider: google
property: G-46N5E3NXG0
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- 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>.
comparator_short_desc: Specifies how variations are handled, allowing for slight deviations within a defined margin of error.