diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2dc7736..edce32c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -535,8 +535,57 @@ #### Cas d'une nouvelle instance 1. publier l'instance dans `internal-proxy` et `internal-monitoring` via `make publish` À COMPLÉTER -2. créer un fichier `instance-conf.json` à la racine du dépôt À COMPLÉTER -3. changer le `title` dans la configuration À COMPLÉTER +2. changer le `title` dans la configuration À COMPLÉTER +3. créer un fichier `instance-conf.json` à la racine du dépôt À COMPLÉTER + +Pour la publication dans `internal-proxy` et `internal-monitoring`, il faut +renseigner, dans le répertoire de l'instance, le fichier `swagger.json` puis +lancer `make publish` sur ce répertoire. + +Ex de `swagger.json`: + +```json +{ + "info": { + "title": "ark-tools - Génération des identifiants ARK", + "summary": "Permet la génération d'identifiants ARK uniques et pérennes.", + "version": "1.0.0", + "termsOfService": "https://objectif-tdm.inist.fr/", + "contact": { + "name": "Inist-CNRS", + "url": "https://www.inist.fr/nous-contacter/" + } + }, + "servers": [ + { + "x-comment": "Will be automatically completed by the ezs server." + }, + { + "url": "http://vptdmservices.intra.inist.fr:49194/", + "description": "Latest version for production", + "x-profil": "Standard" + } + ], + "tags": [ + { + "name": "ark-tools", + "description": "Génération des identifiants ARK", + "externalDocs": { + "description": "Plus de documentation", + "url": "https://gitbucket.inist.fr/tdm/web-services/tree/master/ark-tools" + } + } + ] +} +``` + +Champs importants: dans `servers`, champ `url`. + +Lancer avec: + +```bash +make publish +``` ## Après le déploiement