openvox-operator/mkdocs.yml at develop · slauger/openvox-operator · 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
site_name: OpenVox Operator
site_description: A Kubernetes Operator that maps OpenVox Server infrastructure onto native building blocks for running Puppet on Kubernetes and OpenShift
site_url: https://slauger.github.io/openvox-operator
repo_url: https://github.com/slauger/openvox-operator
repo_name: slauger/openvox-operator

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

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Concepts:
      - Architecture: concepts/architecture.md
      - Code Deployment: concepts/code-deployment.md
      - Traffic Flow: concepts/traffic-flow.md
      - Gateway API: concepts/gateway-api.md
      - External Node Classification: concepts/external-node-classification.md
      - Report Processing: concepts/report-processing.md
      - Configuration Rollout: concepts/config-rollout.md
      - Certificate Signing: concepts/certificate-signing.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Guides:
      - CA Import & External CA: guides/ca-import.md
  - Examples:
      - Overview: examples/index.md
  - Development:
      - Local Setup: development/local-setup.md
      - Testing: development/testing.md
      - E2E Infrastructure: development/e2e-infrastructure.md
      - Mock Server: development/mock-server.md
  - Reference:
      - Overview: reference/index.md
      - Helper Binaries: reference/binaries.md
      - Config: reference/config.md
      - CertificateAuthority: reference/certificateauthority.md
      - SigningPolicy: reference/signingpolicy.md
      - Certificate: reference/certificate.md
      - Server: reference/server.md
      - Pool: reference/pool.md
      - NodeClassifier: reference/nodeclassifier.md
      - ReportProcessor: reference/reportprocessor.md