-
Notifications
You must be signed in to change notification settings - Fork 18
/
mkdocs-base.yml
263 lines (251 loc) · 9.07 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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# MkDocs configuration for builds with material theme
site_name: Percona Backup for MongoDB
site_description: documentation
site_author: Percona LLC
copyright: >
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024
— <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
repo_name: percona/pbm-docs
repo_url: https://github.com/percona/pbm-docs
edit_uri: edit/main/docs/
use_directory_urls: false
# Theme setup
theme:
name: material
logo: _images/mongodb-mark.svg
favicon: _images/mongodb-fav.svg
custom_dir: _resource/overrides/
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
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/extra.css
- css/design.css
- css/osano.css
- css/mongodb.css
- css/landing.css
extra_javascript:
- js/promptremover.js
- js/consent.js
markdown_extensions:
abbr: {}
attr_list: {}
toc:
permalink: True
title: On this page
toc_depth: 5
admonition: {}
footnotes: {}
def_list: {} # https://michelf.ca/projects/php-markdown/extra/#def-list
meta: {}
md_in_html: {}
smarty:
{smart_angled_quotes: true}
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tabbed:
{alternate_style: true}
pymdownx.tilde: {}
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.highlight:
use_pygments: true
pymdownx.inlinehilite: {}
pymdownx.snippets:
base_path: ["snippets"]
auto_append:
- services-banner.md
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- _resource/.icons
#Mkdocs plugins
plugins:
section-index: {}
search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
git-revision-date-localized:
enable_creation_date: true
enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
tags: {}
glightbox: {}
meta-descriptions:
export_csv: false
quiet: false
enable_checks: false
min_length: 50
max_length: 160
macros:
include_yaml:
- 'variables.yml' # Use in markdown as '{{ VAR }}'
# exclude: # Don't process these files
# glob:
# - file.md
with-pdf: # https://github.com/orzih/mkdocs-with-pdf
output_path: '_pdf/PerconaBackupforMongoDB.pdf'
cover_title: 'Backup for MongoDB Documentation'
cover_subtitle: 2.7.0 (October 9, 2024)
author: 'Percona Technical Documentation Team'
cover_logo: docs/_images/Percona_Logo_Color.png
debug_html: false
# two_columns_level: 3
custom_template_path: _resource/templates
enabled_if_env: ENABLE_PDF_EXPORT
mike:
version_selector: true
css_dir: css
javascript_dir: js
canonical_version: null
#extra:
# homepage:
# https://docs.percona.com
nav:
- Home: index.md
- Features:
- Backup and restore types: features/backup-types.md
- features/logical.md
- features/physical.md
- features/selective-backup.md
- features/incremental-backup.md
- features/point-in-time-recovery.md
- features/snapshots.md
- features/multi-storage.md
- Comparison with MongoDB: 'features/comparison.md'
- Get started:
- Quickstart guide: installation.md
- 1. Install:
- System requirements: system-requirements.md
- From repositories: install/repos.md
- Download tarballs: install/tarball.md
- Build from source: install/source.md
- Run in Docker: install/docker.md
- 2. Set up and configure:
- Overview: install/initial-setup.md
- install/configure-authentication.md
- install/backup-storage.md
- install/start-pbm-agent.md
- Backup and restore:
- Make a backup : "usage/start-backup.md"
- Restore a backup: usage/restore.md
- Make a point-in-time restore: usage/pitr-tutorial.md
- List backups: usage/list-backup.md
- usage/describe-backup.md
- usage/schedule-backup.md
- usage/cancel-backup.md
- usage/delete-backup.md
- usage/restore-progress.md
- usage/oplog-replay.md
- usage/logs.md
- Backup management via PMM: pmm.md
- Administer PBM:
- 'Overview': manage/overview.md
- 'PBM configuration via pipelines': 'manage/configure-remotely.md'
- 'Automate access to S3 buckets for PBM': 'manage/automate-s3-access.md'
- 'Upgrade PBM': 'manage/upgrading.md'
- 'Remove PBM': 'manage/uninstalling.md'
- Architecture:
- How PBM works: 'intro.md'
- PBM architecture: 'details/architecture.md'
- details/pbm-agent.md
- PBM CLI: details/cli.md
- PBM control collections: details/control-collections.md
- Remote backup storage:
- Overview: details/storage-configuration.md
- details/storage-config-example.md
- details/authentication.md
- details/deployments.md
- details/versions.md
- Troubleshooting & FAQ:
- Overview: troubleshoot/index.md
- 'Diagnose PBM': 'troubleshoot/troubleshooting.md'
- 'Check status': 'troubleshoot/status.md'
- 'Troubleshoot backup management via PMM': 'troubleshoot/pbm-pmm.md'
- troubleshoot/faq.md
- Release notes:
- "Release notes index": "release-notes.md"
- release-notes/2.7.0.md
- release-notes/2.6.0.md
- release-notes/2.5.0.md
- release-notes/2.4.1.md
- release-notes/2.4.0.md
- 2023 (versions 2.0.4 to 2.3.1):
- Percona Backup for MongoDB 2.3.1 (2023-12-04): release-notes/2.3.1.md
- release-notes/2.3.0.md
- release-notes/2.2.1.md
- release-notes/2.2.0.md
- release-notes/2.1.0.md
- release-notes/2.0.5.md
- release-notes/2.0.4.md
- '2022 (versions 1.8.0 to 2.0.3)':
- release-notes/2.0.3.md
- release-notes/2.0.2.md
- release-notes/2.0.1.md
- release-notes/2.0.0.md
- release-notes/1.8.1.md
- release-notes/1.8.0.md
- 'Percona Backup for MongoDB 1.7.0 (2022-04-18)': 'release-notes/1.7.0.md'
- '2021 (versions 1.4.1 to 1.6.1)':
- 'Percona Backup for MongoDB 1.6.1 (2021-11-04)': 'release-notes/1.6.1.md'
- 'Percona Backup for MongoDB 1.6.0 (2021-08-16)': 'release-notes/1.6.0.md'
- 'Percona Backup for MongoDB 1.5.0 (2021-05-10)': 'release-notes/1.5.0.md'
- 'Percona Backup for MongoDB 1.4.1 (2021-01-28)': 'release-notes/1.4.1.md'
- '2020 (versions 1.1.0 to 1.4.0)':
- 'Percona Backup for MongoDB 1.4.0 (2020-12-24)': 'release-notes/1.4.0.md'
- 'Percona Backup for MongoDB 1.3.4 (2020-11-19)': 'release-notes/1.3.4.md'
- 'Percona Backup for MongoDB 1.3.3 (2020-11-04)': 'release-notes/1.3.3.md'
- 'Percona Backup for MongoDB 1.3.2 (2020-10-14)': 'release-notes/1.3.2.md'
- 'Percona Backup for MongoDB 1.3.1 (2020-09-03)': 'release-notes/1.3.1.md'
- 'Percona Backup for MongoDB 1.3.0 (2020-08-26)': 'release-notes/1.3.0.md'
- 'Percona Backup for MongoDB 1.2.1 (2020-07-27)': 'release-notes/1.2.1.md'
- 'Percona Backup for MongoDB 1.2.0 (2020-05-13)': 'release-notes/1.2.0.md'
- 'Percona Backup for MongoDB 1.1.3 (2020-04-14)': 'release-notes/1.1.3.md'
- 'Percona Backup for MongoDB 1.1.1 (2020-01-31)': 'release-notes/1.1.1.md'
- 'Percona Backup for MongoDB 1.1.0 (2020-01-16)': 'release-notes/1.1.0.md'
- '2019 (versions 0.5.0 to 1.0.0)':
- 'Percona Backup for MongoDB 1.0.0 (2019-09-19)': 'release-notes/1.0.0.md'
- 'Percona Backup for MongoDB 0.5.0 (2019-06-17)': 'release-notes/0.5.0.md'
- Reference:
- PBM commands:
- reference/pbm-commands.md
- Configuration file options:
- Configuration file:
- reference/config.md
- reference/configuration-options.md
- reference/pitr-options.md
- reference/backup-options.md
- reference/restore-options.md
- reference/glossary.md
- reference/contributing.md
- Copyright and licensing: copyright.md
- Trademark policy: trademark-policy.md