Skip to content

Commit 2275dc4

Browse files
authored
Add redirects for all charmhub pages (14) (#994)
* chore: rename interfaces-endpoints for consistency with VM * update references to interfaces-and-endpoints * add rediraffe sphinx extension and redirect mapping list
1 parent 14a14cc commit 2275dc4

File tree

8 files changed

+105
-8
lines changed

8 files changed

+105
-8
lines changed

docs/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,9 @@
193193
# NOTE: If undefined, set to None, or empty,
194194
# the sphinx_reredirects extension will be disabled.
195195

196-
redirects = {}
196+
# redirects = {}
197197

198+
rediraffe_redirects = "redirects.txt"
198199

199200
###########################
200201
# Link checker exceptions #
@@ -258,7 +259,8 @@
258259
"sphinxcontrib.cairosvgconverter",
259260
"sphinx_last_updated_by_git",
260261
"sphinx.ext.intersphinx",
261-
"sphinxcontrib.mermaid"
262+
"sphinxcontrib.mermaid",
263+
"sphinxext.rediraffe"
262264
]
263265

264266
# Excludes files or directories from processing

docs/explanation/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Charm event flowcharts:
2626
<!-- Links -->
2727

2828
[Architecture]: /explanation/architecture
29-
[Interfaces and endpoints]: /explanation/interfaces-endpoints
29+
[Interfaces and endpoints]: /explanation/interfaces-and-endpoints
3030
[Users]: /explanation/users
3131
[Logs]: /explanation/logs
3232
[Juju]: /explanation/juju
@@ -46,7 +46,7 @@ Charm event flowcharts:
4646
:hidden:
4747
4848
Architecture <architecture>
49-
Interfaces and endpoints <interfaces-endpoints>
49+
Interfaces and endpoints <interfaces-and-endpoints>
5050
Juju <juju>
5151
Legacy charm <legacy-charm>
5252
Users <users>
File renamed without changes.

docs/explanation/users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ When an application charm requests a new user through the relation/integration i
111111
```{note}
112112
`extra-user-roles` is only supported by the modern interface `postgresql_client`. It is not supported for the legacy `pgsql` interface. R
113113
114-
Read more about the supported charm interfaces in [](/explanation/interfaces-endpoints).
114+
Read more about the supported charm interfaces in [](/explanation/interfaces-and-endpoints).
115115
```
116116

117117
## Identity users

docs/how-to/development/integrate-with-your-charm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Charmed PostgreSQL K8s can be integrated with any charmed application that suppo
44

55
## Check supported interfaces
66

7-
First, we recommend that you check [the supported interfaces](/explanation/interfaces-endpoints) of the current charm. You have options to use modern (preferred) or legacy interfaces.
7+
First, we recommend that you check [the supported interfaces](/explanation/interfaces-and-endpoints) of the current charm. You have options to use modern (preferred) or legacy interfaces.
88

99
Most existing charms currently use the [ops-lib-pgsql](https://github.com/canonical/ops-lib-pgsql) interface (legacy). For new charms, **Canonical recommends using [data-platform-libs](https://github.com/canonical/data-platform-libs) instead.**
1010

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is a **Kubernetes** operator. To deploy on IAAS/VM, see [Charmed PostgreSQL
1313
| | |
1414
|--|--|
1515
| [**Get started**](/tutorial/index) - [Deploy on a cloud](/how-to/deploy/index) \| [Scale](/how-to/scale-replicas) \| [Manage passwords](/how-to/manage-passwords) \| [Enable encryption](/how-to/enable-tls) \| [Back up](/how-to/back-up-and-restore/index) \| [Monitoring](/how-to/monitoring-cos/index) </br> | [**How-to guides**](/how-to/index) for key tasks, use-cases, and problems. These guides assume basic familiarity with Juju and PostgreSQL. </br> |
16-
| [**Reference**](/reference/index) - Technical information for quick lookup, such as [requirements](/reference/system-requirements), [plugins](/reference/plugins-extensions), and [statuses](/reference/statuses). | [**Explanation**](/explanation/interfaces-endpoints) - Discussion and clarification of key topics such as [architecture](/explanation/architecture), [users](/explanation/users), and [legacy charms](/explanation/legacy-charm)|
16+
| [**Reference**](/reference/index) - Technical information for quick lookup, such as [requirements](/reference/system-requirements), [plugins](/reference/plugins-extensions), and [statuses](/reference/statuses). | [**Explanation**](/explanation/interfaces-and-endpoints) - Discussion and clarification of key topics such as [architecture](/explanation/architecture), [users](/explanation/users), and [legacy charms](/explanation/legacy-charm)|
1717

1818
## Project and community
1919

docs/redirects.txt

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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+
# Tutorials
16+
t-set-up tutorial/
17+
t-deploy tutorial/
18+
t-access 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+
h-deploy how-to/deploy
27+
h-deploy-canonical-k8s how-to/deploy/canonical-k8s
28+
h-deploy-gke how-to/deploy/gke
29+
h-deploy-eks how-to/deploy/eks
30+
h-deploy-aks how-to/deploy/aks
31+
h-deploy-multi-az how-to/deploy/multi-az
32+
h-deploy-terraform how-to/deploy/terraform
33+
h-deploy-airgapped how-to/deploy/air-gapped
34+
35+
h-integrate how-to/integrate-with-another-application
36+
h-manage-passwords how-to/manage-passwords
37+
h-external-access how-to/external-network-access
38+
h-scale how-to/scale-replicas
39+
h-enable-tls how-to/enable-tls
40+
h-enable-ldap how-to/enable-ldap
41+
42+
h-enable-plugins-extensions how-to/enable-plugins-extensions
43+
44+
h-backup how-to/back-up-and-restore/
45+
h-configure-s3-aws how-to/back-up-and-restore/configure-s3-aws
46+
h-configure-s3-radosgw how-to/back-up-and-restore/configure-s3-radosgw
47+
h-create-backup how-to/back-up-and-restore/create-a-backup
48+
h-restore-backup how-to/back-up-and-restore/restore-a-backup
49+
h-manage-backup-retention how-to/back-up-and-restore/manage-backup-retention
50+
h-migrate-cluster how-to/back-up-and-restore/migrate-a-cluster
51+
52+
h-monitor how-to/monitoring-cos/
53+
h-enable-monitoring how-to/monitoring-cos/enable-monitoring
54+
h-enable-alert-rules how-to/monitoring-cos/enable-alert-rules
55+
h-enable-tracing how-to/monitoring-cos/enable-tracing
56+
57+
h-upgrade how-to/upgrade/
58+
h-upgrade-minor how-to/upgrade/perform-a-minor-upgrade
59+
h-rollback-minor how-to/upgrade/perform-a-minor-rollback
60+
61+
h-async how-to/cross-regional-async-replication/
62+
h-async-set-up how-to/cross-regional-async-replication/set-up-clusters
63+
h-async-integrate how-to/cross-regional-async-replication/integrate-with-a-client-app
64+
h-async-remove-recover how-to/cross-regional-async-replication/remove-or-recover-a-cluster
65+
66+
h-development how-to/development/
67+
h-development-integrate how-to/development/integrate-with-your-charm
68+
h-migrate-pgdump how-to/development/migrate-data-via-pg-dump
69+
h-migrate-backup-restore how-to/development/migrate-data-via-backup-restore
70+
71+
# Reference
72+
r-releases reference/releases
73+
r-system-requirements reference/system-requirements
74+
r-software-testing reference/software-testing
75+
r-performance reference/performance-and-resources
76+
77+
r-troubleshooting reference/troubleshooting/
78+
79+
r-plugins-extensions reference/plugins-extensions
80+
r-alert-rules reference/alert-rules
81+
r-statuses reference/statuses
82+
r-contacts reference/contacts
83+
84+
# Explanation
85+
e-architecture explanation/architecture
86+
e-interfaces-endpoints explanation/interfaces-and-endpoints
87+
e-juju-details explanation/juju
88+
e-legacy-charm explanation/legacy-charm
89+
e-users explanation/users
90+
e-logs explanation/logs
91+
e-connection-pooling explanation/connection-pooling
92+
93+
e-security explanation/security/
94+
e-cryptography explanation/security/cryptography

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ canonical-sphinx[full]
22
packaging
33
sphinxcontrib-svg2pdfconverter[CairoSVG]
44
sphinx-last-updated-by-git
5-
sphinxcontrib-mermaid
5+
sphinxcontrib-mermaid
6+
sphinxext-rediraffe

0 commit comments

Comments
 (0)