From d9eb274e87a07008393a6b361bdd072def0fe86f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Grand?= <francois.grand@inrae.fr>
Date: Thu, 13 Apr 2023 08:59:42 +0200
Subject: [PATCH] feat(doc): add PWA installation documentation
refs #617
---
docs/en/general/installation.md | 35 +++++++++++++++++++++++++++++++++
docs/en/index.md | 4 ++--
docs/fr/general/installation.md | 35 +++++++++++++++++++++++++++++++++
docs/fr/index.md | 4 ++--
mkdocs/mkdocs-en.yml | 1 +
mkdocs/mkdocs-fr.yml | 1 +
6 files changed, 76 insertions(+), 4 deletions(-)
create mode 100644 docs/en/general/installation.md
create mode 100644 docs/fr/general/installation.md
diff --git a/docs/en/general/installation.md b/docs/en/general/installation.md
new file mode 100644
index 000000000..63d05ab42
--- /dev/null
+++ b/docs/en/general/installation.md
@@ -0,0 +1,35 @@
+# Installation
+
+Cassiopée can be installed for use without an internet connection as an executable program or as a progressive web app (PWA).
+
+## Installation of the Cassiopée progressive web application
+
+A progressive web app (PWA) is a web application that consists of pages or websites, and can appear to the user in the same way as native applications or mobile applications.
+
+PWAs are available for all platforms (Windows, Linux, MacOS, Android, and iOS) provided you have a compatible browser:
+
+| Plateforme | Chrome/Chromium | Edge | Firefox | Safari |
+|------------|-----------------|------|---------------|--------|
+| Windows | Yes | Yes | via extension | |
+| Linux | Yes | | via extension | |
+| MacOS | Yes | | via extension | |
+| Android | Yes | | Yes | |
+| iOS | | | | Yes |
+
+The installation is done directly from the web browser at <https://cassiopee.g-eau.net> by clicking on a button located on the right of the address bar. The appearance of the button may vary depending on the browser used:
+
+* Install a PWA with Chrome/Chromium: <https://support.google.com/chrome/answer/9658361?hl=fr>
+* Installing a PWA with Edge: <https://learn.microsoft.com/fr-fr/microsoft-edge/progressive-web-apps-chromium/ux>
+* Install a PWA (any browser and platform): <https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Installing>
+
+After the installation, Cassiopée can be launched from the application icon on the desktop.
+
+Updates are automatically detected and installed (the user is invited to restart Cassiopée after downloading the update).
+
+N.B.: even without going through the PWA installation procedure, Cassiopée is available in the browser without an internet connection provided it has been previously loaded.
+
+## Installation of the Desktop application (obsolete)
+
+Cassiopée is available as an executable program for Windows, Linux and MacOS platforms. The installation programs can be downloaded at the following address: <https://cassiopee.g-eau.fr/cassiopee-releases/>
+
+The installation in the form of a progressive web application (see above) will definitely replace this installation mode in a future version of Cassiopée.
diff --git a/docs/en/index.md b/docs/en/index.md
index f8e9b1078..1fb2aeaeb 100644
--- a/docs/en/index.md
+++ b/docs/en/index.md
@@ -13,9 +13,9 @@ Cassiopée is a software dedicated to rivers hydraulics with especially some hel
## Pre-requisites - installation
-Cassiopée does not require any installation. It is available online using an up-to-date browser (tested with Firefox, Chrome and Chromium) by navigating to the following address: [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr)
+Cassiopée does not require any installation. It is available online using an up-to-date browser (tested with Firefox, Edge, Chrome and Chromium) by navigating to the following address: [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr).
-Offline versions are available (Windows, Linux, macOS, Android) at the following address : [https://cassiopee.g-eau.fr/cassiopee-releases/](https://cassiopee.g-eau.fr/cassiopee-releases/)
+Offline versions are available for the Windows, Linux, macOS, Android platforms. For details, see the ["Installation" section](general/installation.md) in the documentation.
## Documentation
diff --git a/docs/fr/general/installation.md b/docs/fr/general/installation.md
new file mode 100644
index 000000000..42d86052e
--- /dev/null
+++ b/docs/fr/general/installation.md
@@ -0,0 +1,35 @@
+# Installation
+
+Cassiopée peut être installé pour une utilisation sans connexion internet sous la forme d'un programme exécutable ou d'une Web App progressive (PWA).
+
+## Installation de l'application web progressive Cassiopée
+
+Une progressive web app (PWA, application web progressive en français) est une application web qui consiste en des pages ou des sites web, et qui peuvent apparaître à l'utilisateur de la même manière que les applications natives ou les applications mobiles.
+
+Les PWA sont disponibles pour toutes les platesformes (Windows, Linux, MacOS, Android, et iOS) Ã condition d'avoir un browser compatible :
+
+| Plateforme | Chrome/Chromium | Edge | Firefox | Safari |
+|------------|-----------------|------|---------------|--------|
+| Windows | Oui | Oui | via extension | |
+| Linux | Oui | | via extension | |
+| MacOS | Oui | | via extension | |
+| Android | Oui | | Oui | |
+| iOS | | | | Oui |
+
+L'installation se fait directement à partir du navigateur internet à l'adresse <https://cassiopee.g-eau.net> en cliquant sur un bouton situé à droite de la barre d'adresse. L'aspect du bouton peut varier en fonction du navigateur utilisé :
+
+* Installer une PWA avec Chrome/Chromium : <https://support.google.com/chrome/answer/9658361?hl=fr>
+* Installer une PWA avec Edge : <https://learn.microsoft.com/fr-fr/microsoft-edge/progressive-web-apps-chromium/ux>
+* Installer une PWA (tout browser et plateforme - en anglais) : <https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Installing>
+
+Après l'installation, Cassiopée peut être lancé à partir de l'icône de l'application présente sur le bureau.
+
+Les mises à jour sont automatiquement détectées et installées (l'utilisateur est invité à redémarrer Cassiopée après le téléchargement de la mise à jour).
+
+N.B.: même sans passer par la procédure d'installation de la PWA, Cassiopée est disponible dans le navigateur sans connection internet à condition d'avoir été chargé précédemment.
+
+## Installation de l'application Desktop (obsolète)
+
+Cassiopée est disponible sous la forme d'un programme exécutable pour les plateformes Windows, Linux et MacOS. Les programmes d'installation sont téléchargeables à l'adresse suivante : <https://cassiopee.g-eau.fr/cassiopee-releases/>
+
+L'installation sous la forme d'une application web progressive (cf. ci-dessus) remplacera définitivement ce mode d'installation dans une prochaine version de Cassiopée.
diff --git a/docs/fr/index.md b/docs/fr/index.md
index c7d0948eb..a2718ab7d 100644
--- a/docs/fr/index.md
+++ b/docs/fr/index.md
@@ -13,9 +13,9 @@ Cassiopée est un logiciel consacré à l'hydraulique des rivières avec notamme
## Pré-requis - installation
-Cassiopée ne nécessite aucune installation. Il est disponible en ligne à partir d'un navigateur récent (testé sous Firefox, Chrome et Chromium) en se rendant à l'adresse suivante : [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr)
+Cassiopée ne nécessite aucune installation. Il est disponible en ligne à partir d'un navigateur récent (testé sous Firefox, Edge, Chrome et Chromium) en se rendant à l'adresse suivante : [https://cassiopee.g-eau.fr](https://cassiopee.g-eau.fr).
-Des versions hors-ligne sont disponibles (Windows, Linux, macOS, Android) Ã l'adresse suivante : [https://cassiopee.g-eau.fr/cassiopee-releases/](https://cassiopee.g-eau.fr/cassiopee-releases/)
+Des versions hors-ligne sont installables sur les plateformes Windows, Linux, macOS, Android. Voir le détail dans la [section installation](general/installation.md) de la documentation.
## Documentation
diff --git a/mkdocs/mkdocs-en.yml b/mkdocs/mkdocs-en.yml
index 88ae9eff9..1e1f282b8 100644
--- a/mkdocs/mkdocs-en.yml
+++ b/mkdocs/mkdocs-en.yml
@@ -25,6 +25,7 @@ markdown_extensions:
nav:
- Presentation of Cassiopée:
- index.md
+ - general/installation.md
- general/principe_fonctionnement.md
- general/parametres_application.md
- general/raccourcis_clavier.md
diff --git a/mkdocs/mkdocs-fr.yml b/mkdocs/mkdocs-fr.yml
index 4c31e2e74..8f3d38653 100644
--- a/mkdocs/mkdocs-fr.yml
+++ b/mkdocs/mkdocs-fr.yml
@@ -25,6 +25,7 @@ markdown_extensions:
nav:
- Présentation de Cassiopée:
- index.md
+ - general/installation.md
- general/principe_fonctionnement.md
- general/parametres_application.md
- general/raccourcis_clavier.md
--
GitLab