platform.data.kit/mkdocs.yml at main · Infoblox-CTO/platform.data.kit · 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
# DK Documentation Site Configuration
# https://www.mkdocs.org/user-guide/configuration/

site_name: DataKit Documentation
site_description: Documentation for DataKit (dk) — build, test, and deploy data pipelines
site_url: https://datakit.internal.infoblox.dev/
repo_url: https://github.com/Infoblox-CTO/platform.data.kit
repo_name: Infoblox-CTO/platform.data.kit
edit_uri: edit/main/docs/

# Theme configuration
theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

# Markdown extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Infoblox-CTO
      repo: datakit
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Prerequisites: getting-started/prerequisites.md
    - Installation: getting-started/installation.md
    - Quickstart: getting-started/quickstart.md
  - Concepts:
    - concepts/index.md
    - Overview: concepts/overview.md
    - Data Packages: concepts/data-packages.md
    - DataSets: concepts/datasets.md
    - Manifests: concepts/manifests.md
    - Pipelines: concepts/pipelines.md
    - Lineage: concepts/lineage.md
    - Governance: concepts/governance.md
    - Environments: concepts/environments.md
    - Cells & Stores: concepts/cells.md
  - Tutorials:
    - tutorials/index.md
    - Kafka to S3: tutorials/kafka-to-s3.md
    - Local Development: tutorials/local-development.md
    - Promoting Packages: tutorials/promoting-packages.md
    - CloudQuery Python Plugin: tutorials/cloudquery-python.md
    - CloudQuery Go Plugin: tutorials/cloudquery-go.md
    - Deploying to Cells: tutorials/deploying-to-cells.md
  - Reference:
    - reference/index.md
    - CLI Commands: reference/cli.md
    - Manifest Schema: reference/manifest-schema.md
    - Configuration: reference/configuration.md
  - Troubleshooting:
    - troubleshooting/index.md
    - Common Issues: troubleshooting/common-issues.md
    - FAQ: troubleshooting/faq.md
  - Architecture: architecture.md
  - Target State: target-state.md
  - Testing: testing.md
  - Contributing: contributing.md

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Infoblox-CTO/platform.data.kit
  generator: false