-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathmkdocs-base.yml
223 lines (203 loc) · 7.58 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
# MkDocs configuration
# Used as base - look for .yml files with INHERIT
site_name: Percona Everest
site_description: Documentation
site_author: Percona LLC
site_url: ""
copyright: Percona LLC, © 2025
use_directory_urls: false
repo_name: percona/everest-doc
repo_url: https://github.com/percona/everest-doc
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides
logo: assets/everest-mark.svg
favicon: assets/everest-fav.svg
font:
text: Roboto
code: Roboto Mono
icon:
edit: material/file-edit-outline
view: material/file-eye-outline
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Color theme set to Automatic. Click to change
- media: "(prefers-color-scheme: light)"
scheme: percona-light
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Color theme set to Light Mode. Click to change
- media: "(prefers-color-scheme: dark)"
scheme: percona-dark
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Color theme set to Dark Mode. Click to change
# Theme features
features:
- search.highlight
- navigation.top
- content.tabs.link
- content.code.copy
- navigation.tracking
- content.action.edit
- content.action.view
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/design.css
- css/nocopy.css
- css/osano.css
- css/everest.css
- css/extra.css
extra_javascript:
# - js/lightgallery.min.js
- js/promptremover.js
- js/consent.js
#Copyright
copyright: >
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024 — <a href="#__consent">Cookie Consent</a>
#Extensions
markdown_extensions:
attr_list: {}
toc:
permalink: true
md_in_html: {}
admonition: {}
def_list: {}
meta: {}
smarty: { smart_angled_quotes: true }
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tilde: {}
pymdownx.superfences: {}
pymdownx.tabbed:
alternate_style: true
pymdownx.tasklist:
custom_checkbox: true
pymdownx.snippets:
base_path: ["snippets"]
# auto_append:
# - services-banner.md
pymdownx.highlight:
use_pygments: true
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
plugins:
search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
git-revision-date: {}
meta-descriptions:
export_csv: false
quiet: false
enable_checks: false
min_length: 50
max_length: 160
macros:
include_yaml:
- "variables.yml"
# https://pypi.org/project/mkdocs-exclude/
exclude:
glob: []
# https://github.com/orzih/mkdocs-with-pdf
with-pdf:
output_path: "pdf/Everest-0.1.0.pdf"
cover_title: "Everest Documentation"
cover_subtitle: version (Date, Year)
author: "Everest Team"
cover_logo: docs/images/Percona_Logo_Color.png
enabled_if_env: ENABLE_PDF_EXPORT
# Check links - but extends build time significantly
# https://pypi.org/project/mkdocs-htmlproofer-plugin/
# htmlproofer: {}
mike:
version_selector: false
css_dir: css
javascript_dir: js
canonical_version: null
extra:
edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
updated_text: '<i class="uil uil-refresh"></i> Page updated'
# Common navigation for percona.com, render.com and PDF
nav:
- Welcome to Percona Everest: index.md
- get-help.md
- Release Notes:
- Release notes index: release-notes/release_notes_index.md
- Percona-Everest 1.4.0 (2025-01-07): release-notes/Percona-Everest-1.4.0-(2025-01-07).md
- Percona-Everest 1.3.0 (2024-11-18): release-notes/Percona-Everest-1.3.0-(2024-11-18).md
- Percona-Everest 1.2.0 (2024-10-01): release-notes/Percona-Everest-1.2.0-(2024-10-01).md
- Percona-Everest 1.1.1 (2024-08-22): release-notes/Percona-Everest-1.1.1-(2024-08-22).md
- Percona-Everest 1.1.0 (2024-08-12): release-notes/Percona-Everest-1.1.0-(2024-08-12).md
- Percona-Everest 1.0.1 (2024-07-08): release-notes/Percona-Everest-1.0.1-(2024-07-08).md
- Percona-Everest 1.0.0 (2024-06-28): release-notes/Percona-Everest-1.0.0-(2024-06-28).md
- Percona-Everest 0.10.1 (2024-05-23): release-notes/Percona-Everest-0.10.1-(2024-05-23).md
- Percona Everest 0.10.0 (2024-05-03): release-notes/Percona-Everest-0.10.0-(2024-05-03).md
- Percona Everest 0.9.1 (2024-04-02): release-notes/Percona-Everest-0.9.1-(2024-04-02).md
- Percona Everest 0.9.0 (2024-04-01): release-notes/Percona-Everest-0.9.0-(2024-04-01).md
- Percona Everest 0.8.0 (2024-02-22): release-notes/Percona-Everest-0.8.0-(2024-02-22).md
- Percona Everest 0.7.0 (2024-01-31): release-notes/Percona-Everest-0.7.0-(2024-01-31).md
- Percona Everest 0.6.0 (2024-01-11): release-notes/Percona-Everest-0.6.0-(2024-01-11).md
- Percona Everest 0.5.0 (2023-11-28): release-notes/Percona-Everest-0.5.0-(2023-11-28).md
- Percona Everest 0.4.0 (2023-10-30): release-notes/Percona-Everest-0.4.0-(2023-10-30).md
- Features: features.md
- Quickstart guide: quick-install.md
- Install:
- Setup and prerequisites:
- install/prerequisites.md
- install/supported_operators_k8s.md
- install/eks.md
- install/gke.md
- install/installEverestCLI.md
- install/install_everest_helm_charts.md
- install/installEverest.md
- Upgrade:
- Upgrade Percona Everest using Helm: upgrade/upgrade_with_helm.md
- Upgrade Percona Everest using CLI: upgrade/upgrade_with_cli.md
- Upgrade Percona operators: upgrade/upgrade_operators.md
- Uninstall:
- Uninstall Percona Everest using Helm: uninstall/uninstall_everest_helm.md
- Uninstall Percona Everest using CLI: uninstall/uninstallEverest.md
- Administer:
- User management: administer/manage_users.md
- Single sign-on (SSO): administer/Idp_integration.md
- Role-based access control: administer/rbac.md
- Namespaces management: administer/manage_namespaces.md
- Use:
- Database view: use/database_view.md
- Provision a database: use/db_provision.md
- Back up and restore data:
- About backups: use/AboutBackups.md
- Create storage locations: use/CreateStorage.md
- Create on-demand and scheduled backups: use/createBackups/CreateOnDemand.md
- Enable Point-in-time recovery (PITR): use/createBackups/EnablePITR.md
- Create database from backups: use/createBackups/create_new_database.md
- Restore backups: use/RestoreBackup.md
- Manage clusters: use/cluster-management.md
- MongoDB sharding: use/mongo_sharding.md
- Scale database deployment: use/scaling.md
- Configure database engine: use/db_engine_config.md
- Monitoring: use/monitor_endpoints.md
- Multiple namepaces: use/multi-namespaces.md
- API rate limiting: use/API_rate_limit.md
- API: API.md
- Reference:
- Breaking API changes: api_rbac.md
- Limitations: reference/known_limitations.md
- Telemetry on Percona Everest: reference/telemetry.md
- Migrate to Percona Everest: reference/migration_guide.md
- Copyright and licensing information: reference/copyright.md
- Trademark and copyright policy: reference/trademark-policy.md
- Contribute: contribute.md