From 11798232a99965a20a175519a0798eb042b8b75d 2024-01-30 22:53:17 From: RhodeCode Admin Date: 2024-01-30 22:53:17 Subject: [PATCH] docs(misc): various docs improvements --- diff --git a/docs/source/conf.py b/docs/source/conf.py index 81db16e..f3675f3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -68,7 +68,10 @@ rst_epilog = ''' .. |git| replace:: Git .. |hg| replace:: Mercurial .. |svn| replace:: Subversion - +.. |repo| replace:: repository +.. |repos| replace:: repositories +.. |authtoken| replace:: Authentication Token +.. |authtokens| replace:: **Auth Tokens** .. |RCC| replace:: RhodeCode Control .. |RCE| replace:: RhodeCode Enterprise .. |RCCE| replace:: RhodeCode Community diff --git a/docs/source/index.rst b/docs/source/index.rst index a9abe15..3f23fee 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -148,14 +148,13 @@ There are two requirements for OS to be able to run whole rcstack. configuration/set-license-file.rst configuration/set-specific-install-version.rst - .. toctree:: :maxdepth: 1 :hidden: :caption: Usage usage/monitoring-unhealthy-containers.rst - + usage/full-text-search-setup.rst .. toctree:: :maxdepth: 1 diff --git a/docs/source/install/upgrade.rst b/docs/source/install/upgrade.rst index d4fb954..70dc8fd 100644 --- a/docs/source/install/upgrade.rst +++ b/docs/source/install/upgrade.rst @@ -11,6 +11,23 @@ It's usually recommended to start with updating the installer itself by running: ./rcstack self-update +.. note:: + + It's possible to change the update channel, or update to only specific versions. This can be done by providing + extra flags to self-update + + .. code-block:: bash + + # upgrade to master branch release line + ./rcstack self-update --force --cli-revision master --docker-revision master + + # upgrade to a specific version corresponding to a git tag + ./rcstack self-update --force --cli-revision v5.3.0 --docker-revision v5.3.0 + + +Upgrade of services +=================== + Then upgrade each stack based on instructions provided from the help output: .. code-block:: bash @@ -68,8 +85,8 @@ which might result in killed ongoing connections -Install specific version -++++++++++++++++++++++++ +Install specific version of RhodeCode ++++++++++++++++++++++++++++++++++++++ In order to run a specific version of RhodeCode stack simply follow this: diff --git a/docs/source/migration/migration-to-docker.rst b/docs/source/migration/migration-to-docker.rst index b916406..afdad6d 100644 --- a/docs/source/migration/migration-to-docker.rst +++ b/docs/source/migration/migration-to-docker.rst @@ -293,6 +293,15 @@ be also adjusted in the UI Session().add(ui3);Session().commit() +11. Run full remap & rescan ++++++++++++++++++++++++++++ + +From RhodeCode web-interface, the last step is to run a full remap & rescan action. + +1. From the RhodeCode Web interface, open + :menuselection:`Admin --> Settings --> Remap and rescan` +2. Select :guilabel:`Invalidate cache for all repositories` to ensure we cleanup old caches from previous installs +3. Click :guilabel:`Rescan Repositories` action SSL Certificates