weir/mkdocs.yml at main · colliery-io/weir · 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
site_name: weir
site_description: An early-stage Rust project.
site_url: https://colliery-io.github.io/weir
repo_url: https://github.com/colliery-io/weir
repo_name: colliery-io/weir

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/colliery-io/weir

# Docs are organised around Diátaxis (https://diataxis.fr): Tutorials (learning),
# How-to guides (tasks), Reference (information), Explanation (understanding).
nav:
  - Home: index.md
  - Tutorials:
    - Your first sync: tutorials/first-sync.md
  - How-to guides:
    - Onboard a declarative connector: guides/onboard-manifest-connector.md
    - Schedule syncs: guides/schedule-syncs.md
    - Capture changes + propagate deletes: guides/cdc-deletes.md
    - Secure the control plane: guides/secure-control-plane.md
    - Manage tenants: guides/manage-tenants.md
    - Deploy to Kubernetes: guides/deploy-kubernetes.md
    - Map fields: guides/field-mapping.md
    - Author a connector: guides/connector-authoring.md
    - Soak testing: guides/soak-testing.md
    - Demo pipelines: guides/demo-pipelines.md
  - Reference:
    - Installation: reference/installation.md
    - CLI: reference/cli.md
    - Connection config: reference/connection-config.md
    - Connector contract: reference/connector-contract.md
    - HTTP API: api/index.md
  - Explanation:
    - Architecture: explanation/architecture.md
    - The connector model: explanation/connector-model.md
    - Multi-tenancy: explanation/multi-tenancy.md
    - Delivery guarantees: explanation/delivery-guarantees.md
    - Typed schemas: explanation/typed-schemas.md
    - Deployment topology: explanation/deployment.md