data-caterer/mkdocs.yml at main · data-catering/data-caterer · GitHub

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
site_name: Data Catering
site_url: https://data.catering/
repo_url: https://github.com/data-catering/data-caterer
repo_name: data-caterer

extra_css:
  - stylesheets/extra.css

plugins:
  - open-in-new-tab
  - search
  - social
  - privacy

theme:
  name: material
  logo: diagrams/logo/data_catering_transparent.svg
  favicon: diagrams/logo/data_catering_transparent.svg
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.top
    - navigation.footer
    - navigation.path
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - toc.integrate
    - toc.follow
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: amber
      accent: lime
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      accent: lime
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/git-alt
    admonition:
      example: fontawesome/solid/database
      note: simple/spring
      abstract: simple/apachekafka
      info: fontawesome/solid/file

nav:
  - Home: 'index.md'
  - Get Started: 'get-started/quick-start.md'
  - Docs:
      - 'docs/index.md'
      - Design: 'docs/design.md'
      - Guide:
          - 'docs/guide/index.md'
          - Scenario:
              - Auto Generate: 'docs/guide/scenario/auto-generate-connection.md'
              - Data Generation: 'docs/guide/scenario/data-generation.md'
              - Data Validation: 'docs/guide/scenario/data-validation.md'
              - Delete Generated Data: 'docs/guide/scenario/delete-generated-data.md'
              - First Data Generation: 'docs/guide/scenario/first-data-generation.md'
              - Foreign Keys Across Data Sources: 'docs/guide/scenario/batch-and-event.md'
              - Generate Batch and Event Data: 'docs/guide/scenario/batch-and-event.md'
              - Multiple Records Per Field Value: 'docs/guide/scenario/records-per-field.md'
          - Data Sources:
              - Database:
                - BigQuery: 'docs/guide/data-source/database/bigquery.md'
                - Cassandra: 'docs/guide/data-source/database/cassandra.md'
                - MySQL: 'docs/guide/data-source/database/mysql.md'
                - Postgres: 'docs/guide/data-source/database/postgres.md'
              - Files:
                - CSV: 'docs/guide/data-source/file/csv.md'
                - Delta Lake: 'docs/guide/data-source/file/delta-lake.md'
                - Iceberg: 'docs/guide/data-source/file/iceberg.md'
                - JSON: 'docs/guide/data-source/file/json.md'
                - ORC: 'docs/guide/data-source/file/orc.md'
                - Parquet: 'docs/guide/data-source/file/parquet.md'
              - HTTP:
                - REST API: 'docs/guide/data-source/http/http.md'
              - Messaging:
                - Kafka: 'docs/guide/data-source/messaging/kafka.md'
                - RabbitMQ: 'docs/guide/data-source/messaging/rabbitmq.md'
                - Solace: 'docs/guide/data-source/messaging/solace.md'
              - Metadata:
                - Data Contract CLI: 'docs/guide/data-source/metadata/data-contract-cli.md'
                - Great Expectations: 'docs/guide/data-source/metadata/great-expectations.md'
                - JSON Schema: 'docs/guide/data-source/metadata/json-schema.md'
                - Marquez: 'docs/guide/data-source/metadata/marquez.md'
                - OpenMetadata: 'docs/guide/data-source/metadata/open-metadata.md'
                - Open Data Contract Standard (ODCS): 'docs/guide/data-source/metadata/open-data-contract-standard.md'
                - Data Caterer YAML: 'docs/guide/data-source/metadata/yaml-configurations.md'
      - Connections: 'docs/connection.md'
      - Generator:
          - Data Generator: 'docs/generator/data-generator.md'
          - Record Count: 'docs/generator/count.md'
          - Relationships: 'docs/generator/foreign-key.md'
          - Transformations: 'docs/generator/transformation.md'
      - Validation:
          - 'docs/validation.md'
          - Basic: 'docs/validation/basic-validation.md'
          - Group by/Aggregate: 'docs/validation/group-by-validation.md'
          - Upstream: 'docs/validation/upstream-data-source-validation.md'
          - Field Names: 'docs/validation/field-name-validation.md'
          - External Source: 'docs/validation/external-source-validation.md'
      - Report:
          - HTML Report: 'docs/report/html-report.md'
          - Alert: 'docs/report/alert.md'
      - API: 'docs/api.md'
      - Delete Data: 'docs/delete-data.md'
      - Configuration:
          - Overview: 'docs/configuration.md'
          - Unified YAML Schema: 'docs/configuration/unified-yaml-schema.md'
      - Migrations:
          - Overview: 'migrations/README.md'
          - Unified YAML Format: 'migrations/yaml-unified-format/MIGRATION.md'
      - Deployment: 'docs/deployment.md'
      - Advanced: 'docs/advanced.md'
  - Use Case:
      - 'use-case.md'
      - Business Value: 'use-case/business-value.md'
      - Comparison: 'use-case/comparison.md'
      - Roadmap: 'use-case/roadmap.md'
      - Blog:
          - Rethinking shift-left for data pipelines: 'use-case/blog/rethinking-shift-left-for-data-pipelines.md'
          - A year of getting paid from Medium articles: 'use-case/blog/a-year-of-getting-paid-from-medium-articles.md'
          - Shift Left Data Quality: 'use-case/blog/shift-left-data-quality.md'
      - Changelog:
          - 0.19.1: 'use-case/changelog/0.19.1.md'
          - 0.19.0: 'use-case/changelog/0.19.0.md'
          - 0.18.0: 'use-case/changelog/0.18.0.md'
          - 0.17.3: 'use-case/changelog/0.17.3.md'
          - 0.17.2: 'use-case/changelog/0.17.2.md'
          - 0.17.1: 'use-case/changelog/0.17.1.md'
          - 0.17.0: 'use-case/changelog/0.17.0.md'
          - 0.16.11: 'use-case/changelog/0.16.11.md'
          - 0.16.10: 'use-case/changelog/0.16.10.md'
          - 0.16.9: 'use-case/changelog/0.16.9.md'
          - 0.16.8: 'use-case/changelog/0.16.8.md'
          - 0.16.7: 'use-case/changelog/0.16.7.md'
          - 0.16.6: 'use-case/changelog/0.16.6.md'
          - 0.16.5: 'use-case/changelog/0.16.5.md'
          - 0.16.4: 'use-case/changelog/0.16.4.md'
          - 0.16.3: 'use-case/changelog/0.16.3.md'
          - 0.16.2: 'use-case/changelog/0.16.2.md'
          - 0.16.1: 'use-case/changelog/0.16.1.md'
          - 0.16.0: 'use-case/changelog/0.16.0.md'
          - 0.15.4: 'use-case/changelog/0.15.4.md'
          - 0.15.3: 'use-case/changelog/0.15.3.md'
          - 0.15.2: 'use-case/changelog/0.15.2.md'
          - 0.15.1: 'use-case/changelog/0.15.1.md'
          - 0.15.0: 'use-case/changelog/0.15.0.md'
          - 0.14.7: 'use-case/changelog/0.14.7.md'
          - 0.14.6: 'use-case/changelog/0.14.6.md'
          - 0.14.5: 'use-case/changelog/0.14.5.md'
          - 0.14.4: 'use-case/changelog/0.14.4.md'
          - 0.14.3: 'use-case/changelog/0.14.3.md'
          - 0.14.2: 'use-case/changelog/0.14.2.md'
  - About:
      - 'about.md'
  - Demo: 'demo.md'


extra:
  social:
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/data-catering/shared_invite/zt-2664ylbpi-w3n7lWAO~PHeOG9Ujpm~~w
    - icon: fontawesome/brands/github
      link: https://github.com/data-catering/data-caterer
    - icon: fontawesome/brands/medium
      link: https://medium.com/@pflooky
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/data-catering
    - icon: fontawesome/solid/paper-plane
      link: mailto:hello@data.catering
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCNJACecY00X3JuV99UOySqQ
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/datacatering
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/datacatering
  analytics:
    provider: google
    property: G-4098CTH5TX
  version:
    provider: mike

markdown_extensions:
  - attr_list
  - def_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format