Add redirects for all charmhub pages (16) (#995)

* rename interfaces-endpoints for consistency with VM

* add rediraffe sphinx extension and redirect mapping list

* remove unnecessary redirects

Author: a-velasco

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

docs/explanation/index.md

@@ -26,7 +26,7 @@ Charm event flowcharts:
 <!-- Links -->
 
 [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 <architecture>
-Interfaces and endpoints <interfaces-endpoints>
+Interfaces and endpoints <interfaces-and-endpoints>
 Juju <juju>
 Legacy charm <legacy-charm>
 Users <users>

docs/explanation/interfaces-endpoints.md renamed to docs/explanation/interfaces-and-endpoints.md

@@ -114,7 +114,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

docs/explanation/users.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.** 
 

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

@@ -19,7 +19,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) </br> |  [**How-to guides**](/how-to/index) for key tasks, use-cases, and problems. These guides assume basic familiarity with Juju and PostgreSQL. </br>  |
-| [**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
 

docs/index.md

@@ -0,0 +1,13 @@
+# 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/

docs/redirects.txt

@@ -2,4 +2,5 @@ canonical-sphinx[full]
 packaging
 sphinxcontrib-svg2pdfconverter[CairoSVG]
 sphinx-last-updated-by-git
-sphinxcontrib-mermaid
+sphinxcontrib-mermaid
+sphinxext-rediraffe