Merge pull request #194 from web-vision/task/update-documentation

[TASK] Introduce Upgrade instructions
web-vision · May 5, 2023 · aa0f639 · aa0f639
2 parents bcc5ea8 + da1fb0f
commit aa0f639
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 0 deletions.
diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
@@ -13,3 +13,4 @@ Administration
  Installation/Index
  Configuration/Index
  AutoTranslatePrefix/Index
+ Updates/Index
diff --git a/Documentation/Administration/Updates/Index.rst b/Documentation/Administration/Updates/Index.rst
@@ -0,0 +1,24 @@
+.. include:: /Includes.rst.txt
+
+.. _updates:
+
+Updates
+=======
+
+Version 2.x > 3.x
+-----------------
+
+.. note:: This Upgrade is only needed, if you are using glossary functionality.
+
+Run the Upgrade wizard shipped with version 3. The wizard only appears, if necessary:
+
+.. figure:: /Images/Administration/upgrade-wizard-v3.png
+ :alt: Screenshot ob backend Upgrade wizard
+
+This wizard moves your glossaries to the new structure, fixes backend group
+rights and changes the module name.
+
+After this, you have to run a GlossarySync update, either by CLI or by backend
+
+#. :ref:`sync-cli`
+#. :ref:`glossaries`
diff --git a/Documentation/Editor/Glossary/Index.rst b/Documentation/Editor/Glossary/Index.rst
@@ -1,5 +1,7 @@
 .. include:: /Includes.rst.txt
 
+.. _glossaries:
+
 Glossaries
 ==========
 

diff --git a/Documentation/Housekeeping/Index.rst b/Documentation/Housekeeping/Index.rst
@@ -1,5 +1,7 @@
 .. include:: /Includes.rst.txt
 
+.. _housekeeping`:
+
 Housekeeping
 ============
 
@@ -55,6 +57,7 @@ Your glossaries in TYPO3 are not deleted with this command.
 
 After this, you are able to sync your glossaries again to DeepL.
 
+.. _sync-cli:
 
 Synchronisation
 ---------------

diff --git a/Documentation/Images/Administration/upgrade-wizard-v3.png b/Documentation/Images/Administration/upgrade-wizard-v3.png