diff --git a/docs/conf.py b/docs/conf.py index 01d22f0eb2..418d8fa262 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -193,8 +193,9 @@ # NOTE: If undefined, set to None, or empty, # the sphinx_reredirects extension will be disabled. -redirects = {} +# redirects = {} +rediraffe_redirects = "redirects.txt" ########################### # Link checker exceptions # @@ -258,7 +259,8 @@ "sphinxcontrib.cairosvgconverter", "sphinx_last_updated_by_git", "sphinx.ext.intersphinx", - "sphinxcontrib.mermaid" + "sphinxcontrib.mermaid", + "sphinxext.rediraffe" ] # Excludes files or directories from processing diff --git a/docs/explanation/index.md b/docs/explanation/index.md index 55554e617e..848e7787c9 100644 --- a/docs/explanation/index.md +++ b/docs/explanation/index.md @@ -26,7 +26,7 @@ Charm event flowcharts: [Architecture]: /explanation/architecture -[Interfaces and endpoints]: /explanation/interfaces-endpoints +[Interfaces and endpoints]: /explanation/interfaces-and-endpoints [Users]: /explanation/users [Logs]: /explanation/logs [Juju]: /explanation/juju @@ -46,7 +46,7 @@ Charm event flowcharts: :hidden: Architecture -Interfaces and endpoints +Interfaces and endpoints Juju Legacy charm Users diff --git a/docs/explanation/interfaces-endpoints.md b/docs/explanation/interfaces-and-endpoints.md similarity index 100% rename from docs/explanation/interfaces-endpoints.md rename to docs/explanation/interfaces-and-endpoints.md diff --git a/docs/explanation/users.md b/docs/explanation/users.md index 5afe008746..d504b7d990 100644 --- a/docs/explanation/users.md +++ b/docs/explanation/users.md @@ -111,7 +111,7 @@ When an application charm requests a new user through the relation/integration i ```{note} `extra-user-roles` is only supported by the modern interface `postgresql_client`. It is not supported for the legacy `pgsql` interface. R -Read more about the supported charm interfaces in [](/explanation/interfaces-endpoints). +Read more about the supported charm interfaces in [](/explanation/interfaces-and-endpoints). ``` ## Identity users diff --git a/docs/how-to/development/integrate-with-your-charm.md b/docs/how-to/development/integrate-with-your-charm.md index 0b006a1fc8..a59c6f5103 100644 --- a/docs/how-to/development/integrate-with-your-charm.md +++ b/docs/how-to/development/integrate-with-your-charm.md @@ -4,7 +4,7 @@ Charmed PostgreSQL K8s can be integrated with any charmed application that suppo ## Check supported interfaces -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. +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. 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.** diff --git a/docs/index.md b/docs/index.md index 6decca0d40..d4a314bde4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ This is a **Kubernetes** operator. To deploy on IAAS/VM, see [Charmed PostgreSQL | | | |--|--| | [**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)
| [**How-to guides**](/how-to/index) for key tasks, use-cases, and problems. These guides assume basic familiarity with Juju and PostgreSQL.
| -| [**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)| +| [**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)| ## Project and community diff --git a/docs/redirects.txt b/docs/redirects.txt new file mode 100644 index 0000000000..f7601c4fba --- /dev/null +++ b/docs/redirects.txt @@ -0,0 +1,94 @@ +# The redirects.txt file stores all the redirects for the published docs +# If you change a filename, move or delete a file, you need a redirect here. +# - Comment lines start with a hash (#) and are ignored +# - Each redirect should appear on its own line + +# We are using the dirhtml builder, so files are treated as directories: +# - A file is built like `filename/index.html`, not `filename.html` +# - *Do* include a trailing slash at the end of the path +# - *Do not* include a file extension or you'll get errors +# - Paths don't need a slash in front of them + +# Example: +# redirect/from/file/ redirect/to/file/ + +# Tutorials +t-set-up tutorial/ +t-deploy tutorial/ +t-access tutorial/ +t-scale tutorial/ +t-manage-passwords tutorial/ +t-integrate tutorial/ +t-enable-tls tutorial/ +t-clean-up tutorial/ + +# How-to guides +h-deploy how-to/deploy +h-deploy-canonical-k8s how-to/deploy/canonical-k8s +h-deploy-gke how-to/deploy/gke +h-deploy-eks how-to/deploy/eks +h-deploy-aks how-to/deploy/aks +h-deploy-multi-az how-to/deploy/multi-az +h-deploy-terraform how-to/deploy/terraform +h-deploy-airgapped how-to/deploy/air-gapped + +h-integrate how-to/integrate-with-another-application +h-manage-passwords how-to/manage-passwords +h-external-access how-to/external-network-access +h-scale how-to/scale-replicas +h-enable-tls how-to/enable-tls +h-enable-ldap how-to/enable-ldap + +h-enable-plugins-extensions how-to/enable-plugins-extensions + +h-backup how-to/back-up-and-restore/ +h-configure-s3-aws how-to/back-up-and-restore/configure-s3-aws +h-configure-s3-radosgw how-to/back-up-and-restore/configure-s3-radosgw +h-create-backup how-to/back-up-and-restore/create-a-backup +h-restore-backup how-to/back-up-and-restore/restore-a-backup +h-manage-backup-retention how-to/back-up-and-restore/manage-backup-retention +h-migrate-cluster how-to/back-up-and-restore/migrate-a-cluster + +h-monitor how-to/monitoring-cos/ +h-enable-monitoring how-to/monitoring-cos/enable-monitoring +h-enable-alert-rules how-to/monitoring-cos/enable-alert-rules +h-enable-tracing how-to/monitoring-cos/enable-tracing + +h-upgrade how-to/upgrade/ +h-upgrade-minor how-to/upgrade/perform-a-minor-upgrade +h-rollback-minor how-to/upgrade/perform-a-minor-rollback + +h-async how-to/cross-regional-async-replication/ +h-async-set-up how-to/cross-regional-async-replication/set-up-clusters +h-async-integrate how-to/cross-regional-async-replication/integrate-with-a-client-app +h-async-remove-recover how-to/cross-regional-async-replication/remove-or-recover-a-cluster + +h-development how-to/development/ +h-development-integrate how-to/development/integrate-with-your-charm +h-migrate-pgdump how-to/development/migrate-data-via-pg-dump +h-migrate-backup-restore how-to/development/migrate-data-via-backup-restore + +# Reference +r-releases reference/releases +r-system-requirements reference/system-requirements +r-software-testing reference/software-testing +r-performance reference/performance-and-resources + +r-troubleshooting reference/troubleshooting/ + +r-plugins-extensions reference/plugins-extensions +r-alert-rules reference/alert-rules +r-statuses reference/statuses +r-contacts reference/contacts + +# Explanation +e-architecture explanation/architecture +e-interfaces-endpoints explanation/interfaces-and-endpoints +e-juju-details explanation/juju +e-legacy-charm explanation/legacy-charm +e-users explanation/users +e-logs explanation/logs +e-connection-pooling explanation/connection-pooling + +e-security explanation/security/ +e-cryptography explanation/security/cryptography \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index 8127d1280b..5964e8d7cb 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,5 @@ canonical-sphinx[full] packaging sphinxcontrib-svg2pdfconverter[CairoSVG] sphinx-last-updated-by-git -sphinxcontrib-mermaid \ No newline at end of file +sphinxcontrib-mermaid +sphinxext-rediraffe \ No newline at end of file