sf-operator/mkdocs.yml at master · softwarefactory-project/sf-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
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
site_name: sf-operator documentation

repo_name: softwarefactory-project/sf-operator
repo_url: https://github.com/softwarefactory-project/sf-operator

docs_dir: ./docs/

validation:
  links:
    unrecognized_links: warn
    not_found: warn
    anchors: warn
    absolute_links: relative_to_docs
  nav:
    omitted_files: warn
    not_found: warn

theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.tabs
    #- navigation.sections
    - navigation.expand
    - navigation.footer
    - navigation.top
  palette:
    - scheme: default
      primary: teal
      accent: deep purple
      toggle:
        icon: material/brightness-5
        name: dark mode
    - scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/brightness-7
        name: light mode
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - "."
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra:
  social:
    - icon: simple/matrix
      link: https://matrix.to/#/#softwarefactory-project:matrix.org
    - icon: fontawesome/brands/docker
      link: https://quay.io/organization/software-factory
    - icon: fontawesome/brands/golang
      link: https://pkg.go.dev/github.com/softwarefactory-project/sf-operator
    - icon: fontawesome/brands/github
      link: https://github.com/softwarefactory-project/sf-operator

exclude_docs: |
  reference/adr/adr-template.md

nav:
  - Home: README.md
  - Deploy:
      - deployment/index.md
      - Getting started: deployment/getting_started.md
      - Configuration repository: deployment/config_repository.md
      - Services reference:
          - Backing services: deployment/backing_services.md
          - Gateway: deployment/gateway.md
          - Log server: deployment/logserver.md
          - Nodepool: deployment/nodepool.md
          - Zuul: deployment/zuul.md
          - Zuul External Executor: deployment/external-executor.md
      - TLS:
          - Adding third-party certificates into the CA trust chain: deployment/corporate-certificates.md
      - Logging: deployment/logging.md
      - Backup and Restore: deployment/backup-restore.md
      - Secrets Rotation: deployment/secrets_rotation.md
      - General upgrade guidelines: deployment/upgrades.md
  - User:
      - user/index.md
      - Services configuration:
          - Nodepool: user/nodepool_config_repository.md
          - Zuul tenants: user/zuul_config_repository.md
  - Develop:
      - developer/index.md
      - Contributing: developer/CONTRIBUTING.md
      - Getting started: developer/getting_started.md
      - Developing on a MicroShift instance: developer/microshift.md
      - Testing: developer/testing.md
      - Releasing: developer/release.md
      - Hacking images: developer/images.md
      - Contributing: developer/CONTRIBUTING.md
      - Howtos:
          - developer/howtos/index.md
      - Troubleshooting: developer/troubleshooting.md
  - Reference:
      - reference/index.md
      - Decision Records (ADR):
          - reference/adr/index.md
          - reference/adr/0000-use-markdown-any-decision-records.md
          - reference/adr/0001-operator-config.md
          - reference/adr/0002-zuul-system-config.md
          - reference/adr/0003-config-update.md
          - reference/adr/0004-zuul-main.md
          - reference/adr/0005-ops-tooling.md
          - reference/adr/0006-monitoring.md
          - reference/adr/0007-edge-cert.md
          - reference/adr/0008-config-jobs.md
          - reference/adr/0009-database-agnosticity.md
          - reference/adr/0010-zuul-operator-usage.md
          - reference/adr/0011-backup-and-restore.md
          - reference/adr/0011-nodepool-builder.md
          - reference/adr/0012-CLI-overhaul.md
          - reference/adr/0013-more-CLI-features.md
          - reference/adr/0014-external-zuul-executor.md
          - reference/adr/0015-route-handling.md
          - reference/adr/0016-remove-olm-and-simplify-the-ci.md
          - reference/adr/0017-sf-operator-code-hosting.md
        # - Template: reference/adr/adr-template.md
      - Custom Resource Definitions: deployment/crds.md
      - API:
          - reference/api/index.md
      - CLI:
          - reference/cli/index.md
      - CHANGELOG: reference/CHANGELOG.md