Skip to content

Commit 9fc2613

Browse files
authored
Add redirects to new RTD slugs (#677)
1 parent 7a2e679 commit 9fc2613

File tree

3 files changed

+100
-1
lines changed

3 files changed

+100
-1
lines changed

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@
216216

217217
# redirects = {}
218218

219-
# rediraffe_redirects = "redirects.txt"
219+
rediraffe_redirects = "redirects.txt"
220220

221221
###########################
222222
# Link checker exceptions #
@@ -283,6 +283,7 @@
283283
"sphinx_last_updated_by_git",
284284
"sphinx.ext.intersphinx",
285285
"sphinx_sitemap",
286+
"sphinxext.rediraffe"
286287
]
287288

288289
# Excludes files or directories from processing

docs/redirects.txt

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# The redirects.txt file stores all the redirects for the published docs
2+
# If you change a filename, move or delete a file, you need a redirect here.
3+
# - Comment lines start with a hash (#) and are ignored
4+
# - Each redirect should appear on its own line
5+
6+
# We are using the dirhtml builder, so files are treated as directories:
7+
# - A file is built like `filename/index.html`, not `filename.html`
8+
# - *Do* include a trailing slash at the end of the path
9+
# - *Do not* include a file extension or you'll get errors
10+
# - Paths don't need a slash in front of them
11+
12+
# Example:
13+
# redirect/from/file/ redirect/to/file/
14+
15+
# Tutorial
16+
17+
t-set-up/ tutorial/
18+
t-deploy/ tutorial/
19+
t-scale/ tutorial/
20+
t-manage-passwords/ tutorial/
21+
t-integrate/ tutorial/
22+
t-enable-tls/ tutorial/
23+
t-clean-up/ tutorial/
24+
25+
# How-to guides
26+
27+
h-deploy-sunbeam/ how-to/deploy/sunbeam
28+
h-deploy-lxd/ how-to/deploy/lxd
29+
h-deploy-maas/ how-to/deploy/maas
30+
h-deploy-ec2/ how-to/deploy/aws-ec2
31+
h-deploy-gce/ how-to/deploy/gce
32+
h-deploy-azure/ how-to/deploy/azure
33+
h-deploy-multi-az/ how-to/deploy/multi-az
34+
h-deploy-terraform/ how-to/deploy/terraform
35+
h-deploy-airgapped/ how-to/deploy/air-gapped
36+
h-deploy-spaces/ how-to/deploy/juju-spaces
37+
38+
h-integrate/ how-to/integrate-with-another-application
39+
h-external-access/ how-to/external-network-access
40+
h-scale/ how-to/scale-replicas
41+
h-enable-tls/ how-to/enable-tls
42+
43+
h-configure-s3-aws/ how-to/back-up-and-restore/configure-s3-aws
44+
h-configure-s3-radosgw/ how-to/back-up-and-restore/configure-s3-radosgw
45+
h-create-backup/ how-to/back-up-and-restore/create-a-backup
46+
h-restore-backup/ how-to/back-up-and-restore/restore-a-backup
47+
h-migrate-cluster/ how-to/back-up-and-restore/migrate-a-cluster
48+
49+
h-enable-monitoring/ how-to/monitoring-cos/enable-monitoring
50+
h-enable-alert-rules/ how-to/monitoring-cos/enable-alert-rules
51+
h-enable-tracing/ how-to/monitoring-cos/enable-tracing
52+
53+
h-upgrade/ how-to/upgrade/
54+
h-upgrade-juju/ how-to/upgrade/upgrade-juju
55+
h-upgrade-minor/ how-to/upgrade/perform-a-minor-upgrade
56+
h-rollback-minor/ how-to/upgrade/perform-a-minor-rollback
57+
58+
h-async/ how-to/cross-regional-async-replication/
59+
h-async-deployment/ how-to/cross-regional-async-replication/deploy
60+
h-async-clients/ how-to/cross-regional-async-replication/clients
61+
h-async-failover/ how-to/cross-regional-async-replication/switchover-failover
62+
h-async-recovery/ how-to/cross-regional-async-replication/recovery
63+
h-async-removal/ how-to/cross-regional-async-replication/removal
64+
65+
h-development-integrate/ how-to/development/integrate-with-your-charm
66+
h-migrate-mysqldump/ how-to/development/migrate-data-via-mysqldump
67+
h-migrate-mydumper/ how-to/development/migrate-data-via-mydumper
68+
h-migrate-backup-restore/ how-to/development/migrate-data-via-backup-restore
69+
70+
h-troubleshooting/ reference/troubleshooting/
71+
h-contribute/ how-to/contribute
72+
73+
# Reference
74+
75+
r-releases/ reference/releases
76+
r-system-requirements/ reference/system-requirements
77+
r-testing/ reference/software-testing
78+
r-profiles/ reference/profiles
79+
r-plugins-extensions/ reference/plugins-extensions
80+
r-alert-rules/ reference/alert-rules
81+
r-statuses/ reference/charm-statuses
82+
r-contacts/ reference/contacts
83+
r-sos-report/ reference/troubleshooting/sos-report
84+
85+
# Explanation
86+
87+
e-architecture/ explanation/architecture
88+
e-interfaces-endpoints/ explanation/interfaces-and-endpoints
89+
e-juju/ explanation/juju
90+
e-legacy-charm/ explanation/legacy-charm
91+
e-users/ explanation/users
92+
93+
e-logs/ explanation/logs/
94+
e-audit-logs/ explanation/logs/audit-logs
95+
96+
e-security/ explanation/security/
97+
e-cryptography/ explanation/security/cryptography

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ packaging
33
sphinxcontrib-svg2pdfconverter[CairoSVG]
44
sphinx-last-updated-by-git
55
sphinx-sitemap
6+
sphinxext-rediraffe

0 commit comments

Comments
 (0)