diff --git a/docs/upgrading.rst b/docs/upgrading.rst index 76824490a1ab9775af156ed9904997cfa2851965..9155d76909c906b3c35ab166d208aa2cb804ef20 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -96,10 +96,9 @@ renamed from ``oas`` to ``stackspin``. You can choose from these options: Rocket.Chat ~~~~~~~~~~~ -We replaced Rocket.Chat with `Zulip <https://zulip.com>`__ in this release. -If you want to migrate your Rocket.Chat data to your new Zulip installation -please refer to -`Import from Rocket.Chat https://api.zulip.com/help/import-from-rocketchat`__. +We replaced Rocket.Chat with `Zulip`_ in this release. +If you want to migrate your Rocket.Chat data to your new `Zulip`_ installation +please refer to `Import from Rocket.Chat`_. Monitoring ~~~~~~~~~~ @@ -131,13 +130,12 @@ from v0.6 to v0.7!** .. note:: Before you start, please ensure that you have the right ``yq`` tool installed, because you will need it later. There are two very different versions of - ``yq``. The one you need is the go based `yq from Mike Farah - <http://mikefarah.github.io/yq>`_, which installs the same binary name ``yq`` - as the `python-yq <https://github.com/kislyuk/yq>`_, while both have different - command sets. + ``yq``. The one you need is the go based `yq from Mike Farah`_, + which installs the same binary name as the `python-yq`_ one, while both have + different command sets. The yq needed here can be installed by running ``sudo snap install yq``, - ``brew install yq`` or with other methods from the `yq installation - instructions <http://mikefarah.github.io/yq/#install>`_. + ``brew install yq`` or with other methods from the + `yq installation instructions`_. If you're unsure which ``yq`` you have installed, look at the output of ``yq --help`` and make sure ``eval`` shows up under ``Available Commands:``. @@ -394,3 +392,8 @@ intervention. .. _reach out to us: https://openappstack.net/contact.html .. _Flux: https://fluxcd.io +.. _yq from Mike Farah: https://mikefarah.github.io/yq +.. _yq installation instructions: https://mikefarah.github.io/yq/#install +.. _python-yq: https://github.com/kislyuk/yq +.. _Zulip: https://zulip.com +.. _Import from Rocket.Chat: https://api.zulip.com/help/import-from-rocketchat diff --git a/docs/usage.rst b/docs/usage.rst index b618c09fa914471f1a07cdfebd594ce35e9c9c19..d7ea1299e7f7a1b03872b917062dd4f63625b707 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -24,7 +24,7 @@ them access to applications, take a look at the `user panel documentation .. note:: If you don't see applications, make sure you have installed at least one - optional application in :ref:`additional_apps` of the installation procedure. + optional application in :ref:`install_additional_apps` of the installation procedure. For creating users follow the `user creation documentation <https://docs.stackspin.net/projects/user-panel/en/latest/#creating-a-new-user>`_.