-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
168 lines (163 loc) · 7.41 KB
/
mkdocs.yml
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
site_name: Perses
site_url: "https://perses.dev"
repo_name: "perses/perses"
repo_url: "https://github.com/perses/perses"
theme:
name: material
logo: assets/images/favicon.png
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: black
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
primary: black
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
primary: black
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.tabs
- content.code.copy
- search.suggest
- search.highlight
markdown_extensions:
- attr_list
- md_in_html
- 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.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: "#"
- admonition
extra_css:
- 'css/style.css'
# extra_javascript:
# - 'js/main.js'
copyright: |
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href='https://www.linuxfoundation.org/trademark-usage/'>Trademark Usage</a>
extra:
# used to remove the text "made with material for mkdocs: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#generator-notice"
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/perses
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/PersesDev
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/company/persesdev
- icon: fontawesome/brands/slack
link: https://cloud-native.slack.com/messages/C07KQR95WBE
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/persesdev/perses
# Multi repo support
plugins:
- search
- multirepo:
# (optional) tells multirepo to cleanup the temporary directory after site is built.
cleanup: true
# if set the docs directory will not be removed when importing docs.
# When using this with a nav section in an imported repo you must keep the
# docs directory in the path (e.g., docs/path/to/file.md).
keep_docs_dir: true
nav_repos:
- name: perses
import_url: https://github.com/perses/perses?branch=main
# forward slash is needed in '/README.md' so that only the README.md in the root
# directory is imported and not all README.md files.
imports: [docs/*]
nav:
- 'Home': 'index.md'
- 'Docs':
- 'API':
- 'Introduction': 'perses/docs/api/README.md'
- 'Dashboard': 'perses/docs/api/dashboard.md'
- 'Datasource': 'perses/docs/api/datasource.md'
- 'Ephemeral Dashboard': 'perses/docs/api/ephemeral-dashboard.md'
- 'Project': 'perses/docs/api/project.md'
- 'Role': 'perses/docs/api/role.md'
- 'Role Binding': 'perses/docs/api/rolebinding.md'
- 'Secret': 'perses/docs/api/secret.md'
- 'User': 'perses/docs/api/user.md'
- 'Variable': 'perses/docs/api/variable.md'
- 'Dashboard-as-Code':
- 'CUE':
- 'CUE SDK for Dashboards as Code': "perses/docs/dac/cue/README.md"
- 'Dashboard': 'perses/docs/dac/cue/dashboard.md'
- 'Panel Groups': 'perses/docs/dac/cue/panelgroups.md'
- 'Variable':
- 'Variable Group': 'perses/docs/dac/cue/variable/group.md'
- 'Static List Variable': 'perses/docs/dac/cue/variable/staticlist.md'
- 'Text Variable': 'perses/docs/dac/cue/variable/text.md'
- 'Prometheus':
- 'Filter': 'perses/docs/dac/cue/prometheus/filter.md'
- 'Panel': 'perses/docs/dac/cue/prometheus/panel.md'
- 'Label Names Variable': 'perses/docs/dac/cue/prometheus/variable/labelnames.md'
- 'Label Values Variable': 'perses/docs/dac/cue/prometheus/variable/labelvalues.md'
- 'PromQL Variable': 'perses/docs/dac/cue/prometheus/variable/promql.md'
- 'Go':
- 'Go SDK for Dashboards as Code': 'perses/docs/dac/go/README.md'
- 'Dashboard': 'perses/docs/dac/go/dashboard.md'
- 'Datasource': 'perses/docs/dac/go/datasource.md'
- 'Panel': 'perses/docs/dac/go/panel.md'
- 'Panel Plugins':
- 'Bar': 'perses/docs/dac/go/panel/bar.md'
- 'Gauge': 'perses/docs/dac/go/panel/gauge.md'
- 'Markdown': 'perses/docs/dac/go/panel/markdown.md'
- 'Stat': 'perses/docs/dac/go/panel/stat.md'
- 'Timeseries': 'perses/docs/dac/go/panel/time-series.md'
- 'Panel Group': 'perses/docs/dac/go/panel-group.md'
- 'Query': 'perses/docs/dac/go/query.md'
- 'Variable': 'perses/docs/dac/go/variable.md'
- 'Variable Group': 'perses/docs/dac/go/variable-group.md'
- 'Helpers':
- 'HTTP Proxy': 'perses/docs/dac/go/helper/http-proxy.md'
- 'Prometheus':
- 'Datasource': 'perses/docs/dac/go/prometheus/datasource.md'
- 'Query': 'perses/docs/dac/go/prometheus/query.md'
- 'Label Names Variable': 'perses/docs/dac/go/prometheus/variable/label-names.md'
- 'Label Values Variable': 'perses/docs/dac/go/prometheus/variable/label-values.md'
- 'PromQL Variable': 'perses/docs/dac/go/prometheus/variable/promql.md'
- 'Design Docs':
- 'Authentication': 'perses/docs/design-docs/authentication.md'
- 'Authorization': 'perses/docs/design-docs/authorization.md'
- 'Perses on Kubernetes': 'perses/docs/design-docs/kubernetes.md'
- 'Plugins':
- 'Introduction': 'perses/docs/plugins/introduction.md'
- 'CUE in Perses': 'perses/docs/plugins/cue.md'
- 'Panel Plugin': 'perses/docs/plugins/panels.md'
- 'Prometheus Plugins': 'perses/docs/plugins/prometheus.md'
- 'Tooling':
- 'Perses CLI (percli)': 'perses/docs/tooling/cli.md'
- 'Troubleshooting':
- 'TLS and HTTP Datasource': 'perses/docs/troubleshooting/tls-plain-http-datasource.md'
- 'User Guides':
- 'Configuration': 'perses/docs/user-guides/configuration.md'
- 'Dashboard-as-Code': 'perses/docs/user-guides/dashboard-as-code.md'
- 'Embedding Perses Panels': 'perses/docs/user-guides/embedding-panels.md'
- 'Installation':
- 'Installing Perses from Source': 'perses/docs/user-guides/installing-perses-from-source.md'
- 'Installing Perses in a Container': 'perses/docs/user-guides/installing-perses-in-a-container.md'
- 'OAuth Helper': 'perses/docs/user-guides/oauth-configuration-helpers.md'
- 'Provisioning': 'perses/docs/user-guides/provisioning.md'
- Demo: 'https://demo.perses.dev'