diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index bb8c76baece1238e59f454d8ced082d2055a76c1..0000000000000000000000000000000000000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Installation
-
-## v1.0
-
-### Configuration du web service
-
-Dans le fichier `config/autoload/local.php`, ajoutez une nouvelle clé `CURRENT_SCHEMA` avec pour valeur le
-nom du schéma dans lequel se trouvent les vues sources.
-Exemple :
-
- return [
- 'doctrine' => [
- 'connection' => [
- 'orm_default' => [
- //...
- 'params' => [
- //...
- 'CURRENT_SCHEMA' => 'APOGEE',
- ],
- ],
- ],
- ],
-
-### Mise à jour des vues sources
-
-NB: Le prefixe de nommage `OBJECTH_*` est abandonné au profit de `SYGAL_*`.
-
-#### Pour Apogée
-
-- Vous n'avez pas à renommer vous-même les vues en `SYGAL_*`.
-- Récupérez le script `data/sql/vues-apogee-{etab}.sql` où `{etab}` correspond à votre établissement
-(ex: `vues-apogee-urn.sql` est pour l'Université de Rouen Normandie), personnalisez la requête pour votre établissement
-puis lancez la requête SQL.
-- Exécutez ensuite le script `data/sql/vues-apogee.sql`.
-
-#### Pour Physalis
-
-- Renommer les vues existantes à l'aide du script `data/sql/vues-physalis.sql`.
-- Écrire les 4 nouvelles vues suivantes en s'inspirant du script `data/sql/vues-apogee.sql` :
- - SYGAL_STRUCTURE : factorisation des attributs communs aux établissements, UR, ED.
- - SYGAL_ETAB
- - SYGAL_ECOLE_DOCT
- - SYGAL_UNITE_RECH
-
diff --git a/README.md b/README.md
index 972105063ed112e88a3a0755a19ddc2d71209377..c5012d9725c7e591b2e29c45fd95ad65b793e9b2 100644
--- a/README.md
+++ b/README.md
@@ -10,34 +10,36 @@ et les met à disposition pour leur lecture via des requêtes GET.
## Technologies employées
*sygal-import-ws* repose sur l'utilisation de :
-- Apigility (https://apigility.org/) pour la fourniture du ws ;
-- Doctrine (http://www.doctrine-project.org/) pour la gestion de la partie BDD (notamment des schémas des tables).
+- [Apigility](https://apigility.org/) pour la fourniture du ws ;
+- [Doctrine](http://www.doctrine-project.org/) pour la gestion de la partie BDD (notamment des schémas des tables).
## Installation
### Obtention des sources
-La première fois que vous installez le ws, vous devez lancer la commande suivante :
+S'il s'agit de la première installation du ws, vous devez lancer la commande suivante pour obtenir les sources :
```bash
$ git clone git@git.unicaen.fr:dsi/sygal-import-ws.git
$ cd sygal-import-ws
```
+### Installation d'une version précise
+
Lancer la commande suivante pour obtenir la liste des versions disponibles du ws.
```bash
$ git fetch && git fetch --tags && git tag
```
-Et si la version la plus récente est par exemple la `1.0`, utilisez la commande suivante pour "basculer" sur cette version :
+Et si la version la plus récente est par exemple la `1.0.0`, utilisez la commande suivante pour "installer" sur cette version :
```bash
-$ git checkout 1.0
+$ git checkout 1.0.0
```
### Installation des dépendances
-Installez les packages requis par le ws via *composer* (https://getcomposer.org/) comme ceci :
+Installez les packages requis par le ws via [Composer](https://getcomposer.org/) comme ceci :
```bash
$ composer install
```
@@ -48,7 +50,7 @@ Ce fichier contient les utilisateurs/mot de passe autorisés à appeler le ws.
S'il s'agit d'une mise à jour du ws, vous avez déjà fait la manip, inutile de lire ce paragraphe.
-S'il s'agit de la première installation du ws, placez-vous dans le répertoire `config` des sources et lancer la
+S'il s'agit de la première installation du ws, placez-vous dans le répertoire [`config`](config) des sources et lancer la
commande suivante pour créer le fichier "users.htpasswd" contenant un utilisateur `sygal-app` dont le mot de passe
va vous être demandé :
```bash
@@ -63,6 +65,7 @@ $ pwgen 16 1 --symbols --secure
### Fichiers de config
S'il s'agit d'une mise à jour du ws, vous avez déjà fait la manip, inutile de lire ce paragraphe.
+Reportez-vous au "release notes" de la version choisie (ex: [1.0.0](https://git.unicaen.fr/dsi/sygal-import-ws/tags/1.0.0)).
S'il s'agit de la première installation du ws, 2 fichiers situés dans le répertoire `config/autoload` ont besoin d'être
complétés puis renommés :
@@ -79,7 +82,7 @@ Une fois ces fichiers complétés, changer leur extension `.php.dist` en `.php`.
Passer en mode développement ouvre l'accès à l'interface Apigility de modification du ws.
Cette fonctionnalité est réservée aux développeurs du ws et est **INTERDIT EN PRODUCTION**.
-Désactivez le mode développement ainsi :
+Assurez-vous de bien désactiver le mode développement :
```bash
$ composer development-disable
```
diff --git a/doc/release-notes/v1.0.0.md b/doc/release-notes/v1.0.0.md
new file mode 100644
index 0000000000000000000000000000000000000000..1853352eb93f2d6753881c21579412f18ab804a0
--- /dev/null
+++ b/doc/release-notes/v1.0.0.md
@@ -0,0 +1,46 @@
+# v1.0.0
+
+## Configuration du web service
+
+Dans le fichier `config/autoload/local.php` des sources du web service, ajoutez une nouvelle clé `CURRENT_SCHEMA` dans
+la config Doctrine avec pour valeur le nom du schéma dans lequel se trouvent les vues sources.
+Exemple :
+
+```php
+return [
+ 'doctrine' => [
+ 'connection' => [
+ 'orm_default' => [
+ //...
+ 'params' => [
+ //...
+ 'CURRENT_SCHEMA' => 'APOGEE',
+ ],
+ ],
+ ],
+ ],
+ //...
+];
+```
+
+## Mise à jour des vues sources
+
+NB: Le prefixe de nommage `OBJECTH_*` est abandonné au profit de `SYGAL_*`.
+
+### Pour Apogée
+
+- Récupérez le script `data/sql/vues-apogee-{etab}.sql` où `{etab}` correspond à votre établissement
+(ex: [`data/sql/vues-apogee-urn.sql`](data/sql/vues-apogee-urn.sql) est pour l'Université de Rouen Normandie), personnalisez la requête pour votre établissement puis exécutez le script.
+- Exécutez ensuite le script [`data/sql/vues-apogee.sql`](data/sql/vues-apogee.sql).
+- Faites un "merge request" sur le dépôt gitlab pour que nous puissions mettre à jour sur le dépôt le script `data/sql/vues-apogee-{etab}.sql` de votre établissement.
+
+### Pour Physalis
+
+- Ouvrir le script [`data/sql/vues-physalis.sql`](data/sql/vues-physalis.sql).
+- Exécuter les premières instructions pour renommer les vues sources existantes.
+- Écrire puis exécuter les 4 nouvelles vues suivantes en s'inspirant du script [`data/sql/vues-apogee.sql`](data/sql/vues-apogee.sql) :
+ - SYGAL_STRUCTURE : factorisation des attributs communs aux établissements, UR, ED.
+ - SYGAL_ETAB
+ - SYGAL_ECOLE_DOCT
+ - SYGAL_UNITE_RECH
+- Faire un "merge request" sur le dépôt gitlab pour que nous puissions mettre à jour sur le dépôt le script `data/sql/vues-physalis.sql`.