Différences

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

--- technique:adminserv:sites:scenari [2020/11/08 22:30] – ↷ Page déplacée de technique:adminsys:sites:scenari à technique:adminserv:sites:scenari qduchemi
+++ technique:adminserv:sites:doc [2022/04/15 20:25] – [Documentation (doc.picasoft.net)] crozatst
@@ Ligne 1: / Ligne 1: @@
-# Administration des sites de Picasoft
+{{indexmenu_n>10}}
-todo ajouter pour le site principal Picasoft : MyScenari https://download.scenari.software/MyScenari@5.0
+# Documentation (doc.picasoft.net)
-demander un compte à Steph
+<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>
-entrepôt tiers `stph`
+## Modifier un module existant
-atelier ` picasoft-optim`
+Pour mettre à jour un élément de documentation qui existe déjà, rendez-vous dans l'atelier `picasoft-dokiel`.
-==== Explications générales ====
+On trouve les différents modules existants (documentation de Mattermost, documentation de AIL...).
-https://doc.picasoft.net/modules/scenari01
+{{ :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.
-=== Site principal de Picasoft ===
+Une fois les modifications effectués, se rendre sur le fichier `.pub` du module.
-Le site de Picasoft est créé avec ScenariChain et le modèle Optim 1.4. Le contenu source (XML) est hébergé sur le ScenariServer de l'UTC.
+<bootnote warning>Attention, ne pas utiliser le `.pdf.pub`, qui génère un PDF.</bootnote>
-Le contenu généré (site HTML diffusé) est hébergé dans le dossier ''/DATA/docker/website/html'' sur ''pica01''.
+Vérifier via la prévisualisation que vos modifications sont correctement apportées. Exemple pour Mattermost :
-NB : Un skin adapté a été créé avec ScenariStyler (style Picasoft).
+{{ :technique:adminserv:sites:scenari_dokier_prev.png |}}
-=== Autres sites de Picasoft ===
+Une fois que l'on est satisfait·e, on peut générer une archive contenant les fichiers du module (clic sur `Generate`).
-Les autres sites de Picasoft (modules Opale schoool.picasoft.net, modules Dokiel de doc.picasoft.net) sont gérés sur un principe similaire.
+{{ :technique:adminserv:sites:scenari_dokiel_generate.png |}}
-==== Installation ====
+On clique ensuite sur `Download` pour télécharger l'archive.
-Pour contribuer aux sites Picasoft, il faut un client Scenari pour se connecter au serveur Scenari de l'UTC :
+## Ajout d'un nouveau module
-https://doc.picasoft.net/scenari01/co/installation.html
-==== Édition ====
+### Rédaction du module dans Dokiel
-L'édition du site web de Picasoft se fait dans l'atelier ''picasoft-optim''
+Pour ajouter de la documentation sur un nouveau service, par exemple.
-On pourra lire la documentation Optim ici : https://doc.scenari.software/Optim@1.4/fr/ ; et là : https://docs.kelis.fr/models/optim/14/site/
-Quelques conseils :
+Commencer par créer un nouveau dossier dans l'atelier Dokiel depuis l'arborescence.
-  * Pour obtenir un plan complet du site sélectionner l'item racine ''home.website'' et afficher le plan (clic droit ou CTRL+SHIFT+O)
-  * Pour récupérer une version antérieure dans l'historique sélectionner l'item recherché et clic droit
+{{ :technique:adminserv:sites:scenari_dokiel_create_space.png |}}
-==== Publication ====
+Ajouter un guide utilisateur, qui sera la base du module (clic droit → créer un item). Exemple :
-=== Note ===
-Pour mettre à jour le site, il est nécessaire d'avoir sa clé SSH sur ''pica01''
-=== Génération ===
-  * Sélectionner l'item racine ''home.website''
-  * Onglet ''Publi.''
-  * Choisir le skin ''Site picasoft''
-  * ''Générer'' puis ''Consulter'' pour visualiser le résultat
-=== Diffusion ===
+{{ :technique:adminserv:sites:scenari_dokiel_create_guide.png |}}
-  * Télécharger pour récupérer un ZIP du site sur votre poste
+Ajoutez lui un titre et une première section, sans quoi il subsiste des erreurs. Exemple :
-  * Utiliser transfer.py pour déposer le site sur le serveur web de Picasoft ().
-=== transfer.py ===
+{{ :technique:adminserv:sites:scenari_dokiel_add_section.png |}}
-https://gitlab.utc.fr/picasoft/website
-Le script ''transfer.py''permet de faire un ''unzip'' puis un ''rsync'' sur le le serveur web qui héberge le site de Picasoft
+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>
-**Méthode alternative (manuelle) :**
-  * Récupérer le ZIP
-  * L'extraire. On va supposer qu'on l'a extrait dans le dossier ''A''
-  * Ouvrir un terminal à la racine du dossier ''A'' (la commande ''ls'' devrait retourner ''co  index.html  lib-md  lib-sc  meta  res  skin'')
-  * Exécuter cette commande (en l'adaptant à votre contexte): ''rsync -vru -e "ssh -i /home/<nom-utilisateur>/.ssh/<clé_privée>" ./* root@pica02.picasoft.net:/DATA/docker/website/html''
-=== Autres sites ===
-Pour les autre sites, la publication doit être faite à la main : suivre la procédure ci-avant.
-transfer.py doit être amélioré pour géré la publication multisites (#TODO)