From cbc5d16a1139aac8b762585edcd92621afb7d770 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Mon, 14 Mar 2022 07:53:10 -0400 Subject: [PATCH] Constrain label char set (r6,r5) Some characters in rST labels are not handled correctly by XSLT post-processors. This change fixes two known instances and modifies the newfile tox job to handle these chars. Signed-off-by: Ron Stone Change-Id: I535362dc40de6796b795b2ac86ef46a1edec685c --- ...ration-of-n-plus-1-load-on-a-subcloud.rst} | 7 +++---- ...lation-of-n-plus-1-load-on-a-subcloud.rst} | 2 +- .../index-dist-cloud-kub-95bef233eef0.rst | 4 ++-- ...andling-during-an-orchestrated-upgrade.rst | 13 ++++++------- new-topic.sh | 19 ++++++++++++++++++- 5 files changed, 30 insertions(+), 15 deletions(-) rename doc/source/dist_cloud/kubernetes/{failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst => failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud.rst} (90%) rename doc/source/dist_cloud/kubernetes/{failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst => failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud.rst} (95%) diff --git a/doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud.rst similarity index 90% rename from doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud.rst index b70f02642..4a60787b0 100644 --- a/doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud.rst +++ b/doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud.rst @@ -1,6 +1,6 @@ .. oeo1597292999568 -.. _failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud: +.. _failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud: =========================================================================== Failure During the Installation or Data Migration of N+1 Load on a Subcloud @@ -86,9 +86,8 @@ and finalized. If failure occurs: - Check specified log files -- Follow the recovery procedure. See :ref:`Failure Prior to the Installation - of N+1 Load on a Subcloud ` +- Follow the recovery procedure. See :ref:`failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud` .. only:: partner - .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest \ No newline at end of file + .. include:: /_includes/distributed-upgrade-orchestration-process-using-the-cli.rest diff --git a/doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst b/doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud.rst similarity index 95% rename from doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst rename to doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud.rst index 310288a40..eab62bbe8 100644 --- a/doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n+1-load-on-a-subcloud.rst +++ b/doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud.rst @@ -1,6 +1,6 @@ .. uvp1597292940831 -.. _failure-prior-to-the-installation-of-n+1-load-on-a-subcloud: +.. _failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud: =========================================================== Failure Prior to the Installation of N+1 Load on a Subcloud diff --git a/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst b/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst index d8e4d9897..da1c25303 100644 --- a/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst +++ b/doc/source/dist_cloud/kubernetes/index-dist-cloud-kub-95bef233eef0.rst @@ -148,8 +148,8 @@ Upgrade Orchestration for Distributed Cloud SubClouds using the CLI aborting-the-distributed-upgrade-orchestration configuration-for-specific-subclouds robust-error-handling-during-an-orchestrated-upgrade - failure-prior-to-the-installation-of-n+1-load-on-a-subcloud - failure-during-the-installation-or-data-migration-of-n+1-load-on-a-subcloud + failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud + failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud -------- Appendix diff --git a/doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst b/doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst index b8c7514b2..676716e50 100644 --- a/doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst +++ b/doc/source/dist_cloud/kubernetes/robust-error-handling-during-an-orchestrated-upgrade.rst @@ -14,6 +14,8 @@ upgrade and the steps you can use to troubleshoot the errors. For a successful orchestrated upgrade, ensure the upgrade prerequisites, procedure, and postrequisites are met. +.. rubric:: |proc| + If a failure occurs, use the following general steps: @@ -24,9 +26,8 @@ If a failure occurs, use the following general steps: #. Check the output using the :command:`dcmanager strategy-step list` command for failures, if any. -#. Address the cause of the failure. For more information, see :ref:`Failure - During the Installation or Data Migration of N+1 Load on a Subcloud - `. +#. Address the cause of the failure. For more information, see + :ref:`failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud`. #. Retry the orchestrated upgrade. For more information, see :ref:`Distributed Upgrade Orchestration Process Using the CLI @@ -40,8 +41,6 @@ If a failure occurs, use the following general steps: .. seealso:: - :ref:`Failure Prior to the Installation of N+1 Load on a Subcloud - ` + * :ref:`failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud` - :ref:`Failure During the Installation or Data Migration of N+1 Load on a - Subcloud ` + * :ref:`failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud` diff --git a/new-topic.sh b/new-topic.sh index de5578b71..1de95e478 100644 --- a/new-topic.sh +++ b/new-topic.sh @@ -7,6 +7,15 @@ fi INCLUDEDIR="$2/doc/source/_includes" +declare -A charReplacements + +charReplacements=( + ["-"]="minus" + ["+"]="plus" + ["\@"]="at" + ["\&"]="and" +) + ask_name () { echo -e "`cat <