Add redirects to new RTD slugs (#649)

* add rediraffe extension and redirects.txt

* add link to Charmhub in home page

* add backslash to troubleshooting folder path

* remove broken URL

Author: a-velasco

docs/conf.py

@@ -216,7 +216,7 @@
 
 # redirects = {}
 
-# rediraffe_redirects = "redirects.txt"
+rediraffe_redirects = "redirects.txt"
 
 ###########################
 # Link checker exceptions #
@@ -283,6 +283,7 @@
     "sphinx.ext.intersphinx",
     "sphinx_sitemap",
     "sphinxcontrib.mermaid",
+    "sphinxext.rediraffe"
 ]
 
 # Excludes files or directories from processing

docs/explanation/flowcharts.md

@@ -1,7 +1,5 @@
 # Charm lifecycle flowcharts
 
-[Click to navigate the mermaid diagram on GitHub](https://github.com/canonical/mysql-k8s-operator/blob/main/docs/explanation/e-flowcharts.md).
-
 ```{mermaid}
 flowchart TD
     id101([leader_elected]) --> id102[generate\npassword/configs]

docs/index.md

@@ -1,3 +1,7 @@
+---
+relatedlinks: "[Charmhub](https://charmhub.io/mysql-k8s)"
+---
+
 # Charmed MySQL K8s documentation
 
 Charmed MySQL K8s is an open-source software operator that deploys and operates [MySQL Community Edition](https://www.mysql.com/products/community/) relational databases on Kubernetes via [Juju](https://juju.is/). 

docs/redirects.txt

@@ -0,0 +1,96 @@
+# 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/
+
+# Tutorial
+
+t-set-up/ tutorial/
+t-deploy/ tutorial/
+t-scale/ tutorial/
+t-manage-passwords/ tutorial/
+t-integrate/ tutorial/
+t-enable-tls/ tutorial/
+t-clean-up/ tutorial/
+
+# How-to guides
+
+h-deploy-canonical-k8s/ how-to/deploy/canonical-k8s
+h-deploy-microk8s/ how-to/deploy/microk8s
+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-external-access/ how-to/external-network-access
+h-scale/ how-to/scale-replicas
+h-enable-tls/ how-to/enable-tls
+
+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-migrate-cluster/ how-to/back-up-and-restore/migrate-a-cluster
+
+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-juju/ how-to/upgrade/upgrade-juju
+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-deployment/ how-to/cross-regional-async-replication/deploy
+h-async-clients/ how-to/cross-regional-async-replication/clients
+h-async-failover/ how-to/cross-regional-async-replication/switchover-failover
+h-async-recovery/ how-to/cross-regional-async-replication/recovery
+h-async-removal/ how-to/cross-regional-async-replication/removal
+
+h-development-integrate/ how-to/development/integrate-with-your-charm
+h-migrate-mysqldump/ how-to/development/migrate-data-via-mysqldump
+h-migrate-mydumper/ how-to/development/migrate-data-via-mydumper
+h-migrate-backup-restore/ how-to/development/migrate-data-via-backup-restore
+
+h-troubleshooting/ reference/troubleshooting/
+h-contribute/ how-to/contribute
+
+# Reference
+
+r-releases/ reference/releases
+r-system-requirements/ reference/system-requirements
+r-testing/ reference/software-testing
+r-profiles/ reference/profiles
+r-plugins-extensions/ reference/plugins-extensions
+r-alert-rules/ reference/alert-rules
+r-statuses/ reference/charm-statuses
+r-contacts/ reference/contacts
+
+# Explanation
+
+e-architecture/ explanation/architecture
+e-interfaces-endpoints/ explanation/interfaces-and-endpoints
+e-juju/ explanation/juju
+e-legacy-charm/ explanation/legacy-charm
+e-users/ explanation/users
+
+e-logs/ explanation/logs/
+e-audit-logs/ explanation/logs/audit-logs
+
+e-security/ explanation/security/
+e-cryptography/ explanation/security/cryptography
+
+e-flowcharts/ explanation/flowcharts

docs/requirements.txt

@@ -4,3 +4,4 @@ sphinxcontrib-svg2pdfconverter[CairoSVG]
 sphinx-last-updated-by-git
 sphinx-sitemap
 sphinxcontrib-mermaid
+sphinxext-rediraffe