docs(study-upgrade): add the "How to upgrade a study?" topic in the d…

…ocumentation (#1400)

docs/how-to/studies-upgrade.md

@@ -0,0 +1,60 @@
+---
+title: How to upgrade a study?
+author: Laurent LAPORTE <[email protected]>
+date: 2023-03-10
+tags:
+
+- upgrade
+- version
+
+---
+
+# Introduction
+
+Upgrading versioned studies is an important step to ensure compatibility of your studies with the latest versions of
+Antares Web and Antares Simulator. This upgrade is necessary because some earlier versions may be deprecated and no
+longer supported.
+
+The upgrade process involves updating your study to the latest available version, using an automated process that
+ensures consistency of results across versions. This upgrade may include minor or major changes to the structure of the
+study.Generally, the changes are related to the configuration, the creation of new folders to take into account new
+functionalities (adequacy patch, xpansion, etc.) but also the upgrade of matrices.
+
+> Please note that upgrading your study to the latest version of Antares Simulator does not automatically enable new
+> features, and may require manual adjustments to your study to take full advantage of the new capabilities.
+
+We strongly recommend upgrading your studies to the latest version to take advantage of all the new features, and
+improvements in Antares Web and Antares Simulator. If you encounter any difficulties during the upgrade, please do not
+hesitate to contact our support team for assistance.
+
+# Upgrading
+
+To upgrade your study to the latest version of Antares Web and Antares Simulator, you can follow these steps:
+
+On the main page of the study, you can find the version number at the top of the menu bar:
+
+![](../assets/media/how-to/sudies-upgrade-menu_version.png)
+
+To upgrade the study, click on the nemu and select "Upgrade Study".
+
+![studies-upgrade-menu_open.png](../assets/media/how-to/studies-upgrade-menu_open.png)
+
+The confirmation dialog box will appear, click "Yes" to start the upgrade:
+
+![studies-upgrade-menu_open.png](../assets/media/how-to/studies-upgrade-dialog_box.png)
+
+The upgrade task is launched in the task manager.
+
+> **NOTE:** Most of the upgrades are instantaneous but some can take time, especially when there are matrix
+> transformations.
+
+When the upgrade is done, you can see the version number updated:
+
+![](../assets/media/how-to/studies-upgrade-done.png)
+
+Once the upgrade is complete, you can open your study and perform the manual upgrade in the configuration.
+
+# See also
+
+- Create a new study in the latest version
+- Run a study in the latest version 

mkdocs.yml

@@ -30,18 +30,20 @@ theme:
 nav:
   - Home: index.md
   - 'User guide':
-    - 'Introduction': 'user-guide/0-introduction.md'
-    - 'User interface': 'user-guide/1-interface.md'
-    - 'Variant manager': 'user-guide/2-variant_manager.md'
+      - 'Introduction': 'user-guide/0-introduction.md'
+      - 'User interface': 'user-guide/1-interface.md'
+      - 'Variant manager': 'user-guide/2-variant_manager.md'
+  - 'How to':
+      - 'Upgrade a study': 'how-to/studies-upgrade.md'
   - 'Build':
-    - 'Introduction': 'install/0-INSTALL.md'
-    - 'Configuration': 'install/1-CONFIG.md'
-    - 'Deployment': 'install/2-DEPLOY.md'
+      - 'Introduction': 'install/0-INSTALL.md'
+      - 'Configuration': 'install/1-CONFIG.md'
+      - 'Deployment': 'install/2-DEPLOY.md'
   - 'Develop':
-    - 'Introduction': 'architecture/0-introduction.md'
-    - 'Database management': 'architecture/1-database.md'
-    - 'Roadmap': 'architecture/5-roadmap.md'
-  - 'Antares ecosystem' : 'https://antares-doc.readthedocs.io'
+      - 'Introduction': 'architecture/0-introduction.md'
+      - 'Database management': 'architecture/1-database.md'
+      - 'Roadmap': 'architecture/5-roadmap.md'
+  - 'Antares ecosystem': 'https://antares-doc.readthedocs.io'
   - 'Changelog': 'CHANGELOG.md'
 
 extra: