Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
technique:adminserv:sites:doc [2022/04/15 20:24] – [Documentation (doc.picasoft.net)] crozatst | technique:adminserv:sites:doc [2022/04/15 20:40] (Version actuelle) – [Modifier un module existant] crozatst | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
+ | {{indexmenu_n> | ||
+ | |||
+ | # Documentation (doc.picasoft.net) | ||
+ | |||
+ | < | ||
+ | |||
+ | ## Modifier un module existant | ||
+ | |||
+ | Pour mettre à jour un élément de documentation qui existe déjà, rendez-vous dans l' | ||
+ | |||
+ | On trouve les différents modules existants (documentation de Mattermost, documentation de AIL...). | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Mettre à jour les fichiers concernés. Souvent, il s' | ||
+ | |||
+ | 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 : | ||
+ | |||
+ | {{ : | ||
+ | //[Copie d' | ||
+ | |||
+ | Une fois que l'on est satisfait·e, | ||
+ | |||
+ | {{ : | ||
+ | //[Copie d' | ||
+ | |||
+ | On clique ensuite sur `Télécharger` pour télécharger l' | ||
+ | |||
+ | ## 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' | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Ajouter un guide utilisateur, | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Ajoutez lui un titre et une première section, sans quoi il subsiste des erreurs. Exemple : | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Construire votre documentation, | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | Générer et télécharger l' | ||
+ | |||
+ | ### Mise à jour de la page d' | ||
+ | |||
+ | Se connecter sur l' | ||
+ | |||
+ | Le lien prendra la forme `doc.picasoft.net/ | ||
+ | |||
+ | Générer et publier le support web, comme pour le module. | ||
+ | |||
+ | ## Mise en ligne du nouveau site | ||
+ | |||
+ | Voir [[technique: | ||
+ | |||
+ | < | ||
+ | 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' | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | |||