technique:adminserv:sites:doc

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision		 Révision précédente
technique:adminserv:sites:doc [2021/01/09 00:37] – ↷ Nom de la page changé de technique:adminserv:sites:scenari à technique:adminserv:sites:doc qduchemitechnique:adminserv:sites:doc [2022/04/15 20:40] (Version actuelle) – [Modifier un module existant] crozatst
Ligne 1: Ligne 1:
 +{{indexmenu_n>10}}
 +
 +# Documentation (doc.picasoft.net)
 +
 +<bootnote warning>On suppose que vous êtes connecté au domaine `stph` du serveur MyScenari et en mode `Explorateur` (sinon voir [[technique:adminserv:sites:picasoft]]</bootnote>
 +
 +## Modifier un module existant
 +
 +Pour mettre à jour un élément de documentation qui existe déjà, rendez-vous dans l'atelier `picasoft-dokiel`.
 +
 +On trouve les différents modules existants (documentation de Mattermost, documentation de AIL...).
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_arb.png |}}
 +
 +Mettre à jour les fichiers concernés. Souvent, il s'agira de modifier un fichier `.scen` ou d'en ajouter un pour ajouter une nouvelle section.
 +
 +Une fois les modifications effectués, se rendre sur le fichier `.pub` du module.
 +
 +Vérifier via la prévisualisation que vos modifications sont correctement apportées. Exemple pour Mattermost : 
 +
 +{{ :technique:adminserv:sites:scenari_dokier_prev.png |}}
 +//[Copie d'écran correspondant à la version 4 de Scenari, obsolète ; dans la version 6 choisir l'onglet `Relecture` ou `Prévisualisation`]//
 +
 +Une fois que l'on est satisfait·e, on peut `Générer` une archive contenant les fichiers du module.
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_generate.png |}}
 +//[Copie d'écran correspondant à la version 4 de Scenari, obsolète ; dans la version 6 choisir l'onglet `Publications` tout en bas à gauche]//
 +
 +On clique ensuite sur `Télécharger` pour télécharger l'archive.
 +
 +## Ajout d'un nouveau module
 +
 +### Rédaction du module dans Dokiel
 +
 +Pour ajouter de la documentation sur un nouveau service, par exemple.
 +
 +Commencer par créer un nouveau dossier dans l'atelier Dokiel depuis l'arborescence.
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_create_space.png |}}
 +
 +Ajouter un guide utilisateur, qui sera la base du module (clic droit → créer un item). Exemple :
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_create_guide.png |}}
 +
 +Ajoutez lui un titre et une première section, sans quoi il subsiste des erreurs. Exemple : 
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_add_section.png |}}
 +
 +Construire votre documentation, puis pour finir, ajouter un guide web (utilisé pour la génération). Exemple :
 +
 +{{ :technique:adminserv:sites:scenari_dokiel_add_pub.png |}}
 +
 +Générer et télécharger l'archive, comme pour une modification classique.
 +
 +### Mise à jour de la page d'accueil dans Optim
 +
 +Se connecter sur l'atelier `picasoft-optim`. Se rendre dans le dossier `doc`, puis modifier `doc.website` pour ajouter un lien vers votre nouveau module.
 +
 +Le lien prendra la forme `doc.picasoft.net/modules/<nom_nouveau_module>`.
 +
 +Générer et publier le support web, comme pour le module.
 +
 +## Mise en ligne du nouveau site
 +
 +Voir [[technique:adminserv:sites:update_from_archive|la page de mise à jour à partir d'une archive Scenari.]]
 +
 +<bootnote warning>
 +Pour mettre à jour le module généré, on copiera les fichiers dans le dossier `modules` du site !
 +
 +Tandis que pour mettre à jour la page d'accueil du site, on copiera les fichiers à la racine du site.
 +</bootnote>
 +
 +
 +
 +