diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess index 738f5fa0..94295d24 100644 --- a/doc/source/_extra/.htaccess +++ b/doc/source/_extra/.htaccess @@ -54,4 +54,4 @@ RedirectMatch 301 ^/charm-guide/([^/]+)/reference/2010.html$ /charm-guide/$1/rel RedirectMatch 301 ^/charm-guide/([^/]+)/reference/2101.html$ /charm-guide/$1/release-notes/2101.html RedirectMatch 301 ^/charm-guide/([^/]+)/reference/2110.html$ /charm-guide/$1/release-notes/2110.html -RedirectMatch 301 ^/charm-guide/([^/]+)/admin/index.html$ /charm-guide/$1/howto/index.html +RedirectMatch 301 ^/charm-guide/([^/]+)/howto/([^/]+).html$ /charm-guide/$1/admin/$2.html diff --git a/doc/source/howto/deferred-events.rst b/doc/source/admin/deferred-events.rst similarity index 100% rename from doc/source/howto/deferred-events.rst rename to doc/source/admin/deferred-events.rst diff --git a/doc/source/howto/index.rst b/doc/source/admin/index.rst similarity index 53% rename from doc/source/howto/index.rst rename to doc/source/admin/index.rst index d6a0709c..bb114305 100644 --- a/doc/source/howto/index.rst +++ b/doc/source/admin/index.rst @@ -2,31 +2,28 @@ How-to guides ============= -Administrators --------------- - Operations -~~~~~~~~~~ +---------- General cloud operations: .. toctree:: :maxdepth: 1 - ../admin/ops-change-keystone-password - ../admin/ops-scale-in-nova-compute - ../admin/ops-unseal-vault - ../admin/ops-config-tls-vault-api - ../admin/ops-live-migrate-vms - ../admin/ops-scale-back-with-hacluster - ../admin/ops-scale-out-nova-compute - ../admin/ops-start-innodb-from-outage - ../admin/ops-auto-glance-image-updates - ../admin/ops-implement-ha-with-vip - ../admin/ops-cloud-admin-access - ../admin/ops-reissue-tls-certs - ../admin/ops-replace-rabbitmq-node - ../admin/ops-repair-rabbitmq-node + ops-change-keystone-password + ops-scale-in-nova-compute + ops-unseal-vault + ops-config-tls-vault-api + ops-live-migrate-vms + ops-scale-back-with-hacluster + ops-scale-out-nova-compute + ops-start-innodb-from-outage + ops-auto-glance-image-updates + ops-implement-ha-with-vip + ops-cloud-admin-access + ops-reissue-tls-certs + ops-replace-rabbitmq-node + ops-repair-rabbitmq-node Ceph storage operations (published in the Charmed Ceph documentation): @@ -40,7 +37,7 @@ Ceph storage operations (published in the Charmed Ceph documentation): Software upgrades Management -~~~~~~~~~~ +---------- Cloud management how-to guides: diff --git a/doc/source/howto/managing-power-events-juju-status.rst b/doc/source/admin/managing-power-events-juju-status.rst similarity index 100% rename from doc/source/howto/managing-power-events-juju-status.rst rename to doc/source/admin/managing-power-events-juju-status.rst diff --git a/doc/source/howto/managing-power-events-topology.rst b/doc/source/admin/managing-power-events-topology.rst similarity index 100% rename from doc/source/howto/managing-power-events-topology.rst rename to doc/source/admin/managing-power-events-topology.rst diff --git a/doc/source/howto/managing-power-events.rst b/doc/source/admin/managing-power-events.rst similarity index 100% rename from doc/source/howto/managing-power-events.rst rename to doc/source/admin/managing-power-events.rst diff --git a/doc/source/admin/ops-repair-rabbitmq-node.rst b/doc/source/admin/ops-repair-rabbitmq-node.rst index 4555d56d..50f478a1 100644 --- a/doc/source/admin/ops-repair-rabbitmq-node.rst +++ b/doc/source/admin/ops-repair-rabbitmq-node.rst @@ -41,8 +41,8 @@ Below is a comparison of the repair and replacement methods. \* especially if a new machine must be provisioned -\** can be mitigated with the :doc:`Deferred service events -<../howto/deferred-events>` feature +\** can be mitigated with the :doc:`Deferred service events ` +feature Initial state of the cluster ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/ops-replace-rabbitmq-node.rst b/doc/source/admin/ops-replace-rabbitmq-node.rst index 7b9970fe..fd843d9d 100644 --- a/doc/source/admin/ops-replace-rabbitmq-node.rst +++ b/doc/source/admin/ops-replace-rabbitmq-node.rst @@ -21,7 +21,7 @@ to replace one of its nodes. have adverse effects on the cloud's ability to service its current workload. The above issue can be mitigated through the use of :doc:`Deferred service - events <../howto/deferred-events>`. If restarts are deferred, a client will + events `. If restarts are deferred, a client will nonetheless experience a slight delay (due to timeouts) if it tries to contact a non-existent node. diff --git a/doc/source/admin/ops-start-innodb-from-outage.rst b/doc/source/admin/ops-start-innodb-from-outage.rst index 54f9e99b..8ea45659 100644 --- a/doc/source/admin/ops-start-innodb-from-outage.rst +++ b/doc/source/admin/ops-start-innodb-from-outage.rst @@ -56,5 +56,5 @@ healthy state: mysql-innodb-cluster/2* active idle 2/lxd/2 10.0.0.218 Unit is ready: Mode: R/W, Cluster is ONLINE and can tolerate up to ONE failure. See the :ref:`mysql-innodb-cluster section ` on -the :doc:`Managing power events <../howto/managing-power-events>` page for full +the :doc:`Managing power events ` page for full coverage. diff --git a/doc/source/index.rst b/doc/source/index.rst index a0025c88..77b1a1c4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -38,7 +38,7 @@ Operators, including key tasks for successful deployment and operations. .. toctree:: :maxdepth: 1 - howto/index + admin/index Concepts -------- diff --git a/doc/test/redirect-tests.txt b/doc/test/redirect-tests.txt index da9847ef..5c38cf1d 100644 --- a/doc/test/redirect-tests.txt +++ b/doc/test/redirect-tests.txt @@ -64,4 +64,6 @@ /charm-guide/latest/reference/2101.html 301 /charm-guide/latest/release-notes/2101.html /charm-guide/latest/reference/2110.html 301 /charm-guide/latest/release-notes/2110.html -/charm-guide/xena/admin/index.html 301 /charm-guide/xena/howto/index.html +/charm-guide/latest/howto/managing-power-events.html 301 /charm-guide/latest/admin/managing-power-events.html +/charm-guide/latest/howto/deferred-events.html 301 /charm-guide/latest/admin/deferred-events.html +