From 0458317278c45f5b9e6a124daa7dcae54e9fcf7a Mon Sep 17 00:00:00 2001 From: Varac <varac@varac.net> Date: Mon, 16 Aug 2021 22:11:33 +0200 Subject: [PATCH] Use autosectionlabel_prefix_document --- docs/conf.py | 1 + docs/security.rst | 2 +- docs/testing.rst | 6 +++--- docs/upgrading.rst | 2 +- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0848dcf60..41ef6396f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,3 +66,4 @@ master_doc = 'index' # # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings suppress_warnings = ['autosectionlabel.*'] +autosectionlabel_prefix_document = True diff --git a/docs/security.rst b/docs/security.rst index 3dbb4ebf6..64a2240e7 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -12,7 +12,7 @@ If you like to limit who can access your cluster resources you can configure the OAS ingress (`ingress-nginx <https://kubernetes.github.io/ingress-nginx>`__) to only accept connections from a certain IP address or range. -Follow the :ref:`Customize OAS applications` instructions, but use the following +Follow the :ref:`advanced_installation:Customize OAS applications` instructions, but use the following secret as ``install/overrides/oas-nginx-override.yml`` and apply the secret in the ``oas`` namespace instead of ``oas-apps``. Replace the source range with the IP address ranges you want to allow. diff --git a/docs/testing.rst b/docs/testing.rst index aa98cf352..12f144b91 100644 --- a/docs/testing.rst +++ b/docs/testing.rst @@ -18,13 +18,13 @@ Testing OAS installation ------------------------ First we’d like you to setup an OpenAppStack cluster by yourself, -following the `installation -instructions <https://docs.openappstack.net/en/latest/installation.html>`__. +following the :ref:`installation:Installation` and :ref:`usage:Usage` documentation and make sure +you complete all steps. Command line tests ------------------ -Please :ref:`Run the CLI tests` which checks +Please :ref:`troubleshooting:Run the CLI tests` which checks the overall functionality of your cluster and include the output in your feedback. diff --git a/docs/upgrading.rst b/docs/upgrading.rst index d81ee9c33..e8d1f3739 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -159,7 +159,7 @@ A few things are important when upgrading to 0.6.0: - We now use Flux 2 and the installation procedure has been overhauled. For this reason we advice you to set up a completely new cluster. - Copy your configuration details from ``settings.yaml`` to a new ``.flux.env``. - See ``install/.flux.env.example`` and the :ref:`Installation` + See ``install/.flux.env.example`` and the :ref:`installation:Installation` instructions for more information. Please `reach out to us`_ if you are using, or plan to use OAS in -- GitLab