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

* feat: add rediraffe sphinx extension and discourse redirects for each page

* fix: minor style issues in README.md and CONTRIBUTING.md

* convert tabs to single space

* remove unnecessary redirects

Author: a-velasco

CONTRIBUTING.md

@@ -40,6 +40,7 @@ tox                      # runs 'lint' and 'unit' environments
 ## Build charm
 
 The build environment assumes that there are preinstalled on the system:
+
 * [tox](https://tox.wiki/) (version 4+ !!!)
 * [poetry](https://python-poetry.org/)
 * [charmcraft](https://snapcraft.io/charmcraft)
@@ -69,6 +70,7 @@ pipx install charmcraftcache
 ```
 
 Ensure local pip binaries are in your $PATH (otherwise re-login to your shell):
+
 ```shell
 charmcraftcache --help
 ```

README.md

@@ -1,4 +1,5 @@
 # Charmed PostgreSQL VM Operator
+
 [![CharmHub Badge](https://charmhub.io/postgresql/badge.svg)](https://charmhub.io/postgresql)
 [![Release](https://github.com/canonical/postgresql-operator/actions/workflows/release.yaml/badge.svg)](https://github.com/canonical/postgresql-operator/actions/workflows/release.yaml)
 [![Tests](https://github.com/canonical/postgresql-operator/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/canonical/postgresql-operator/actions/workflows/ci.yaml?query=branch%3Amain)
@@ -131,13 +132,15 @@ juju integrate postgresql <application_name>
 ```
 
 To remove a relation:
+
 ```shell
 juju remove-relation postgresql <application_name>
 ```
 
 #### Legacy `pgsql` interface
 
 We have also added support for the two database legacy relations from the [original version](https://launchpad.net/postgresql-charm) of the charm via the `pgsql` interface. Please note that these relations will be deprecated.
+
  ```shell
 juju relate postgresql:db mailman3-core
 juju relate postgresql:db-admin landscape-server

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,6 +259,7 @@
     "sphinxcontrib.cairosvgconverter",
     "sphinx_last_updated_by_git",
     "sphinx.ext.intersphinx",
+    "sphinxext.rediraffe"
 ]
 
 # Excludes files or directories from processing

docs/redirects.txt

@@ -0,0 +1,16 @@
+# 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/
+
+# How-to guides
+h-deploy-juju-spaces how-to/deploy/juju-spaces

docs/requirements.txt

@@ -1,3 +1,4 @@
 canonical-sphinx[full]
 sphinxcontrib-svg2pdfconverter[CairoSVG]
 sphinx-last-updated-by-git
+sphinxext-rediraffe