forked from percona/pmm-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs-base.yml
246 lines (239 loc) · 9.67 KB
/
mkdocs-base.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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Monitoring and Management
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: Percona LLC, © 2021
use_directory_urls: false
repo_name: percona/pmm-doc
repo_url: https://github.com/percona/pmm-doc
edit_uri: edit/main/docs/
theme:
name: material
logo: _images/percona-logo.svg
favicon: _images/percona-favicon.ico
palette:
# - media: "(prefers-color-scheme: light)"
scheme: percona-light
# toggle:
# icon: material/toggle-switch-off-outline
# name: Switch to night mode
# - media: "(prefers-color-scheme: dark)"
# scheme: slate
# toggle:
# icon: material/toggle-switch
# name: Switch to day mode
extra_css:
- https://unicons.iconscout.com/release/v3.0.3/css/line.css
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
- css/percona.css
- css/lightgallery.min.css
extra_javascript:
- js/version-select.js
- js/toctree.js
- js/lightgallery.min.js
markdown_extensions:
attr_list: {}
toc:
permalink: True
admonition: {}
def_list: {}
meta: {}
smarty: { smart_angled_quotes: true }
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tabbed: {}
pymdownx.tilde: {}
pymdownx.superfences: {}
pymdownx.highlight:
linenums: false
plantuml_markdown: {}
lightgallery: {}
plugins:
search: {}
git-revision-date: {}
macros:
include_yaml:
- 'variables.yml'
# https://pypi.org/project/mkdocs-exclude/
exclude:
glob:
- 'setting-up/client/docker.md'
# https://github.com/orzih/mkdocs-with-pdf
with-pdf:
output_path: '_pdf/PerconaMonitoringAndManagement-2.23.0.pdf'
cover_title: 'Documentation'
cover_subtitle: 2.23.0 (October 21, 2021)
author: 'Percona Technical Documentation Team'
cover_logo: docs/_images/PMM_Logo.svg
custom_template_path: _resources/templates
enabled_if_env: ENABLE_PDF_EXPORT
# Check links - but extends build time significantly
# https://pypi.org/project/mkdocs-htmlproofer-plugin/
# htmlproofer: {}
mike:
version_selector: true
css_dir: css
javascript_dir: js
canonical_version: null
extra: # Used in main.html template and can't be externalized
edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
updated_text: '<i class="uil uil-refresh"></i> Page updated'
version:
provider: mike
# Common navigation for percona.com, netlify and PDF
nav:
- Welcome: index.md
- Setting up:
- setting-up/index.md
- Server:
- setting-up/server/index.md
- setting-up/server/network.md
- setting-up/server/docker.md
- setting-up/server/virtual-appliance.md
- setting-up/server/aws.md
- setting-up/server/easy-install.md
- setting-up/server/dbaas.md
- Client:
- setting-up/client/index.md
- setting-up/client/mysql.md
- setting-up/client/mongodb.md
- setting-up/client/postgresql.md
- setting-up/client/proxysql.md
- setting-up/client/aws.md
- setting-up/client/azure.md
- setting-up/client/google.md
- setting-up/client/linux.md
- setting-up/client/external.md
- setting-up/client/haproxy.md
- setting-up/client/remote.md
- Using:
- using/index.md
- using/interface.md
- using/alerting.md
- using/backup.md
- using/query-analytics.md
- using/dbaas.md
- using/security-threat-tool.md
# - Advisors:
# - using/advisors/innodb_log_buffer_flushed_to_disk_after_each_trx.md
- How to:
- how-to/index.md
- how-to/configure.md
- how-to/upgrade.md
- how-to/secure.md
- how-to/optimize.md
- how-to/annotate.md
- how-to/render-dashboard-images.md
- how-to/extend-metrics.md
- how-to/troubleshoot.md
- Details:
- details/index.md
- details/architecture.md
- details/interface.md
- Dashboards:
- details/dashboards/index.md
- Insight:
- details/dashboards/dashboard-home.md
- details/dashboards/dashboard-advanced-data-exploration.md
- details/dashboards/dashboard-victoriametrics.md
- details/dashboards/dashboard-victoriametrics-agents-overview.md
- PMM:
- details/dashboards/dashboard-inventory.md
- OS Dashboards:
- details/dashboards/dashboard-cpu-utilization-details.md
- details/dashboards/dashboard-disk-details.md
- details/dashboards/dashboard-network-details.md
- details/dashboards/dashboard-memory-details.md
- details/dashboards/dashboard-node-temperature-details.md
- details/dashboards/dashboard-nodes-compare.md
- details/dashboards/dashboard-nodes-overview.md
- details/dashboards/dashboard-node-summary.md
- details/dashboards/dashboard-numa-details.md
- details/dashboards/dashboard-processes-details.md
- Prometheus Dashboards:
- details/dashboards/dashboard-prometheus-exporter-status.md
- details/dashboards/dashboard-prometheus-exporters-overview.md
- MySQL Dashboards:
- details/dashboards/dashboard-mysql-amazon-aurora-details.md
- details/dashboards/dashboard-mysql-command-handler-counters-compare.md
- details/dashboards/dashboard-mysql-innodb-compression-details.md
- details/dashboards/dashboard-mysql-innodb-details.md
- details/dashboards/dashboard-mysql-myisam-aria-details.md
- details/dashboards/dashboard-mysql-myrocks-details.md
- details/dashboards/dashboard-mysql-instance-summary.md
- details/dashboards/dashboard-mysql-instances-compare.md
- details/dashboards/dashboard-mysql-instances-overview.md
- details/dashboards/dashboard-mysql-wait-event-analyses-details.md
- details/dashboards/dashboard-mysql-performance-schema-details.md
- details/dashboards/dashboard-mysql-query-response-time-details.md
- details/dashboards/dashboard-mysql-replication-summary.md
- details/dashboards/dashboard-mysql-group-replication-summary.md
- details/dashboards/dashboard-mysql-table-details.md
- details/dashboards/dashboard-mysql-user-details.md
- details/dashboards/dashboard-mysql-tokudb-details.md
- MongoDB Dashboards:
- details/dashboards/dashboard-mongodb-cluster-summary.md
- details/dashboards/dashboard-mongodb-instance-summary.md
- details/dashboards/dashboard-mongodb-instances-overview.md
- details/dashboards/dashboard-mongodb-instances-compare.md
- details/dashboards/dashboard-mongodb-replset-summary.md
- details/dashboards/dashboard-mongodb-inmemory-details.md
- details/dashboards/dashboard-mongodb-mmapv1-details.md
- details/dashboards/dashboard-mongodb-wiredtiger-details.md
- PostgreSQL Dashboards:
- details/dashboards/dashboard-postgresql-instances-overview.md
- details/dashboards/dashboard-postgresql-instance-summary.md
- details/dashboards/dashboard-postgresql-instances-compare.md
- ProxySQL Dashboards:
- details/dashboards/dashboard-proxysql-instance-summary.md
- HA Dashboards:
- details/dashboards/dashboard-pxc-galera-node-summary.md
- details/dashboards/dashboard-pxc-galera-cluster-summary.md
- details/dashboards/dashboard-pxc-galera-nodes-compare.md
- details/dashboards/dashboard-haproxy-instance-summary.md
- Commands:
- details/commands/index.md
- details/commands/pmm-admin.md
- details/commands/pmm-agent.md
- details/api.md
- details/victoria-metrics.md
- details/glossary.md
- details/develop-checks.md
- faq.md
- Release Notes:
- release-notes/index.md
- 'PMM 2.23.0': release-notes/2.23.0.md
- 'PMM 2.22.0': release-notes/2.22.0.md
- 'PMM 2.21.0': release-notes/2.21.0.md
- 'PMM 2.20.0': release-notes/2.20.0.md
- 'PMM 2.19.0': release-notes/2.19.0.md
- 'PMM 2.18.0': release-notes/2.18.0.md
- 'PMM 2.17.0': release-notes/2.17.0.md
- 'PMM 2.16.0': release-notes/2.16.0.md
- 'PMM 2.15.1': release-notes/2.15.1.md
- 'PMM 2.15.0': release-notes/2.15.0.md
- 'PMM 2.14.0': release-notes/2.14.0.md
- 'PMM 2.13.0': release-notes/2.13.0.md
- 'PMM 2.12.0': release-notes/2.12.0.md
- 'PMM 2.11.1': release-notes/2.11.1.md
- 'PMM 2.11.0': release-notes/2.11.0.md
- 'PMM 2.10.1': release-notes/2.10.1.md
- 'PMM 2.10.0': release-notes/2.10.0.md
- 'PMM 2.9.1': release-notes/2.9.1.md
- 'PMM 2.9.0': release-notes/2.9.0.md
- 'PMM 2.8.0': release-notes/2.8.0.md
- 'PMM 2.7.0': release-notes/2.7.0.md
- 'PMM 2.6.1': release-notes/2.6.1.md
- 'PMM 2.6.0': release-notes/2.6.0.md
- 'PMM 2.5.0': release-notes/2.5.0.md
- 'PMM 2.4.0': release-notes/2.4.0.md
- 'PMM 2.3.0': release-notes/2.3.0.md
- 'PMM 2.2.2': release-notes/2.2.2.md
- 'PMM 2.2.1': release-notes/2.2.1.md
- 'PMM 2.2.0': release-notes/2.2.0.md
- 'PMM 2.1.0': release-notes/2.1.0.md
- 'PMM 2.0.1': release-notes/2.0.1.md
- 'PMM 2.0.0': release-notes/2.0.0.md