gitlab-runner-operator/mkdocs.yml at main · alekc/gitlab-runner-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
site_name: Runner Operator for GitLab CI
site_description: >-
  Kubernetes operator that manages GitLab CI runners using the kubernetes
  executor. Typed CRDs instead of config.toml.
# Points at the default alias, not the domain root, so every versioned copy of
# a page emits a canonical URL pointing at /latest/. Without that, /2.0/ and
# /latest/ are near-duplicates competing with each other in search.
site_url: https://gitlab-runner-operator.alekc.dev/latest/
site_author: Alexander Chernov
copyright: Apache License 2.0

repo_url: https://github.com/alekc/gitlab-runner-operator
repo_name: alekc/gitlab-runner-operator
edit_uri: edit/main/docs/

# Fail the build on a broken internal link or a nav entry pointing at a missing
# file, rather than publishing a site with dead links in it.
strict: true

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - content.code.copy
    - navigation.instant
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  # Lets a page include a manifest straight out of config/samples rather than
  # retyping it. Configured ahead of the guides being migrated onto it.
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true

exclude_docs: |
  requirements.txt

plugins:
  - search

extra:
  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Install: install.md
  - Authentication: authentication.md
  - Guides:
      - guides/index.md
      - Docker-in-Docker: guides/docker-in-docker.md
      - Rootless builds: guides/rootless-builds.md
      - Node placement: guides/node-placement.md
      - Spot and preemptible nodes: guides/spot-nodes.md
      - Mount secrets and configmaps: guides/mount-secrets.md
      - Pull from a private registry: guides/private-registry.md
      - Persistent and ephemeral storage: guides/storage.md
      - Sizing jobs: guides/sizing-jobs.md
      - Concurrency: guides/concurrency.md
      - Jobs stuck in Pending: guides/stuck-pods.md
      - Dedicated build namespace: guides/build-namespace.md
      - Service containers: guides/service-containers.md
      - Outbound proxy: guides/outbound-proxy.md
      - Watching a runner: guides/monitoring.md
      - Draining the runner manager: guides/draining.md
  - Operations:
      - RBAC and namespaces: operations/rbac-and-namespaces.md
      - Uninstalling: operations/uninstall.md
  - Reference:
      - CRD API: reference/api.md
      - Limitations: reference/limitations.md
  - Contributing: contributing.md