Wiki BookStack pour documentation

• Wiki BookStack - Documentation publique
• Accord de niveau de service (SLA)
• Administrer Bookstack
• Débuter avec BookStack

Wiki BookStack - Documentation publique

Accord de niveau de service (SLA)

Version	Date	Commentaire
0.1	02.06.2022	première version
0.2	13.06.2022	modification
1.0	09.04.2024	Mise en service

1. Description du service	Le Centre informatique de l'UNIL (Ci) offre un service de Wiki permettant le partage d'information et de documentation d'un service, département ou une faculté de l'UNIL. L'outil open source utilisé par le Ci est BookStack. Cette solution permet la création, modification et l'illustration collaboratives de pages à l'intérieur d'un site web.
2. Ayants-droits	Ont l'autorisation de demander la création d'un Wiki : les membres du personnel académique, administratif et technique sous contrat avec l'UNIL. Le Ci se réserve le droit de refuser une demande de création d'un Wiki. Dans ce cas, le Ci transmettra la raison de ce refus au demandeur.
3. Validité	Un wiki est valable pour une durée de 12 mois (renouvelable par son propriétaire)  La connexion au Wiki est automatiquement bloquée à la fermeture du compte informatique UNIL. La durée de vie du contenu d'un Wiki est limitée à la durée de vie de ce dernier.
4. Responsabilités	Propriétaire d'un Wiki : Les propriétaires d'un Wiki sont responsables de gérer les droits donnés aux utilisateurs de son Wiki. Les propriétaires d'un Wiki sont responsables de sa gestion (du contenu et de son administration) Les propriétaires d'un Wiki sont responsables de la communication aux utilisateurs de son Wiki. Les propriétaires d'un Wiki sont responsable de renouveler la durée de validité de leur wiki. Centre informatique : Le Ci est responsable du maintien de l'infrastructure et du support du service. Le Ci est responsable de la communication aux propriétaires des Wiki.
5. Confidentialité	Les données « en transit » sont cryptées Les données sont hébergées à l'UNIL La connexion au Wiki est sécurisé avec l'authentification SWITCH edu-ID La gestion des autorisations d'accès au Wiki est liée à la gestion des groupes de l'intranet
6. Sauvegarde	Toutes les modifications d'une page sont conservées, peuvent être comparées et restaurées. Une page supprimée peut être restaurée par le propriétaire du Wiki durant 30 jours. Une sauvegarde quotidienne complète du contenu du Wiki est assurée par le Ci.
7. Quota	Le volume maximal de données hébergé dans un Wiki est de 10 GB.
8. Fiabilité	La redondance des infrastructures physiques et logicielles est assurée par le Ci
9. Disponibilité	Le Ci se réserve le droit d'interrompre le service pour des raisons de maintenance qui seront annoncées.
10. Prix	Le service est offert aux membres du personnel UNIL et aux partenaires.
11. Support	Help desk et spécialistes (heures de bureau).

Administrer Bookstack

La documentation complète de Bookstack est disponible directement sur le site du produit.

Gestion des droits

Bookstack vous permet d'afficher les rôles et utilisateur·trice·s de votre wiki, néanmoins la gestion des droits doit être gérer directement via l'interface de gestion des groupes disponible sur l'intranet de l'UNIL

Au moment de la création de votre wiki, 3 groupes majeurs sont créés, ces groupes permettent de gérer les différents types d'utilisateurs (administrateurs, éditeurs et lecteurs) :

• wiki-WikiName-resp
• wiki-WikiName-editor
• wiki-WikiName-viewer

*il faut remplacer "WikiName" par le nom de votre Wiki.

Récupérer une page supprimée

Les administrateur·trice·s ont la possibilité de récupérer (sous 30 jours) des pages supprimées par les éditeur·trice·s. Pour accéder à la récupération des pages :

1. Cliquer sur "Settings"
2. Cliquer sur l'onglet "Maintenance"
3. Cliquer sur le bouton "OPEN RECYCLE BIN" pour récupérer 

La liste des fichiers apparait sur cette page. Le bouton "Actions" vous permet d'utiliser la fonction "Restore" pour récupérer l'élément supprimé.

Débuter avec BookStack

La documentation complète de Bookstack est disponible directement sur le site du produit.

BookStack est un système de wiki pour gérer et organiser de la documentation. L'organisation du contenu se base sur la métaphore d'une bibliothèque: une étagère contient des livres, qui contiennent des chapites, qui eux-mêmes contiennent des pages. Le contenu figure dans les pages.

L'édition s'effectue avec une interface WISIWYG, un peu à la manière d'un traitement de texte simplifié. On peut structurer le contenu d'une page avec plusieurs niveaux d'intertitres, mettre du texte important en évidence, et y ajouter des images et des documents.

Un système de droits d'accès permet de choisir quels contenus doivent être visibles par tout le monde, ou au contraire uniquement visibles par un groupe restreint.

BookStack est une application open source, une description de ses fonctionnalités est disponible sur le site du projet.

Bases de l'interface d'édition

Création de page et importation par copier/coller

On peut enregistrer une page comme brouillon ou la publier immédiatement. Lors de l'importation de texte par copier/coller, on peut nettoyer les styles importés.

Structure du document

Plusieurs niveaux d'intertitres permettent de structurer le document, ils sont représentés sous forme de sommaire cliquable latéral. Notre conseil: si possible éviter le niveau "header large", très volumineux sur le plan typographique et visuellement peu différenciable  du titre de la page.

Mise en évidence de messages importants

Plusieurs styles sont proposés.

Organisation et tri des contenus

Voir la documentation officielle: Content Overview et Organising Content.

Ajout de documents

Ajouter un document PDF

Pour ajouter un document PDF à une page, voici comment procéder:

Ajouter dans la page un lien vers ce document

Avec le simple ajout par défaut comme illustré ci-dessus, la présence du document associé à la page sera peu visible pour les personnes qui la consultent. Il est donc conseillé d'utiliser l'option d'ajout de lien vers le document dans la page: