ecfe1ed7ca25689fb0ae9c79ef6e24cff2ca9ff3
Services/Wiki.md
| ... | ... | @@ -1,8 +1,60 @@ |
| 1 | -Gollum est un service simple de Wiki hosté via Git, et pouvant afficher divers langage de Markup, dont Markdown ou Org-mode. |
|
| 2 | -Ce le service par défaut utilisé par Gitlab et Github, mais il peut aussi être autohébergé seul, comme fait au ResEl. |
|
| 3 | 1 | |
| 4 | 2 | Gollum est hébergé sur la machine [Smeagol](/Serveurs/Smeagol). |
| 5 | 3 | |
| 6 | 4 | Au ResEl, nous avons notre version un peu forké, pour corriger des problèmes d'UTF-8, le code source est versionné sur [Gitlab : ResEl/gollum-forks](https://git.resel.fr/resel/gollum-forks/). |
| 7 | 5 | |
| 8 | -Le wiki est disponible sur le dépôt [ResEl/general.wiki](https://git.resel.fr/resel/general.wikit.git) et est synchronisé avec le dépôt sur Smeagol dans `/home/wiki/general.wiki`. |
|
| ... | ... | \ No newline at end of file |
| 0 | +Le wiki est disponible sur le dépôt [ResEl/general.wiki](https://git.resel.fr/resel/general.wikit.git) et est synchronisé avec le dépôt sur Smeagol dans `/home/wiki/general.wiki`. |
|
| 1 | + |
|
| 2 | +# Description |
|
| 3 | + |
|
| 4 | +Gollum est un service simple de Wiki, synchronisé via Git, et pouvant traiter divers langage de Markup, dont Markdown ou Org-mode. |
|
| 5 | +Il s'agit du service par défaut utilisé par les wikis Gitlab et Github, mais il peut aussi être autohébergé seul, comme fait au ResEl. |
|
| 6 | + |
|
| 7 | +### Motivations |
|
| 8 | + |
|
| 9 | +Avant, le ResEl à utilisé [trac](trac.resel.fr) puis [redmine](redmine.resel.fr) comme solution complète de gestion de projet. Mais il a été décidé, suite au passage à [Gitlab](/Services/Gitlab) comme solution de gestion de projet, de séparer les outils de gestion de projet et le wiki. |
|
| 10 | + |
|
| 11 | +# Mise en place |
|
| 12 | + |
|
| 13 | +Gollum est un [programme](https://github.com/gollum/gollum) développé en Ruby, qui se compose de trois partie, le frontend **Gollum**, le backend **Gollum-lib** et l'interface avec git **rugged-adapter**. |
|
| 14 | + |
|
| 15 | +Gollum a été mis en place sur [Smeagol](/Serveurs/Smeagol), il pousse une plateforme web https://wiki.resel.fr, pointant sur le reverse publique [Situs](/Serveurs/Situs). |
|
| 16 | + |
|
| 17 | +Pour résoudre quelques problèmes dans Gollum (notamment d'UTF-8), le code a été légèrement patchée par le ResEl, le code est disponible sur le [dépôt associé](https://git.resel.fr/resel/gollum-forks), plus d'informations sur le README. |
|
| 18 | + |
|
| 19 | +# Utilisation |
|
| 20 | + |
|
| 21 | +A priori, vous avez réussi à vous connecter et naviguer jusqu'à cette page, Bravo :clap: ! |
|
| 22 | + |
|
| 23 | +### Rédaction des articles |
|
| 24 | + |
|
| 25 | +Pour rédiger un article, vous pouvez simplement cliquer sur le lien vers un article inexistant, ou cliquer sur le bouton `New`. Pour éditer, le bouton `Edit`. |
|
| 26 | + |
|
| 27 | +La rédaction peut se faire selon différent langage de markup, le recommandé étant Markdown, [lisez le tuto](https://daringfireball.net/projects/markdown/). |
|
| 28 | + |
|
| 29 | +##### Quelques conseils |
|
| 30 | + |
|
| 31 | +* Pour un service et la machine qui l'héberge : |
|
| 32 | +Tout ce qui touche au serice va sur la page service, tout ce qui touche à la machine va sur la page machine. On évite de mélanger des infos. Il faut bien comprendre qu'une machine peut être supprimé, et le service réinstallé sur une autre. Donc sur la page de la machine on ne traite que des infos du service vraiment en rapport avec la machine. |
|
| 33 | +Quelques pages modèles : [Gollum]()/[Smeagol](/Serveurs/Smeagol), [Sites Clubs](/Utilisateurs/SiteClubs)/[Golf](/Serveurs/Golf) |
|
| 34 | + |
|
| 35 | +# Configuration |
|
| 36 | + |
|
| 37 | +:warning: La configuration fait l'objet d'un versionnage sur le [dépôt git](lien vers le dépôt git associé). |
|
| 38 | + |
|
| 39 | +On peut modifier le service avec cette configuration, les détails sont sur la [doc de Gollum](https://github.com/gollum/gollum/wiki). Il y a deux fichiers, `custom.css` et `custom.js` qui permettent d'injecter du *css* et du *js* pour améliorer l'aspect du site. |
|
| 40 | + |
|
| 41 | +Pour soucis de préserver un versionnage propre du code, modifier la configuration sur le dépôt. |
|
| 42 | + |
|
| 43 | +Aller voir les [détails de mise en place de Gollum sur Sméagol](/Serveurs/Smeagol) pour voir comment est installé le service et comment *puller* des modifications. |
|
| 44 | + |
|
| 45 | + |
|
| 46 | +# Lien utiles |
|
| 47 | + |
|
| 48 | +Listes de lien utiles, dans l'ordre : |
|
| 49 | +- [Smeagol](/Serveurs/Smagol) |
|
| 50 | +- [Page Github gollum](https://github.com/gollum/gollum) |
|
| 51 | + |
|
| 52 | +# Historique |
|
| 53 | + |
|
| 54 | +- Mise en place initiale par Théo Jacquin en 2017 |