2012-12-16-gollum-comme-wiki-personnel.org (3688B)
1 #+title: Gollum comme Wiki personnel 2 #+date: <2012-12-16 Sun> 3 #+filetags: wiki golum github personnel 4 #+setupfile: ../templates/post.org 5 6 * Introduction 7 8 Il y a environ 4 mois j'ai eu un accident de vélo ; un traumatisme 9 crânien, des brulures sur la face, quelques points de sutures, un doigt 10 cassé et une hernie discale m'ont cloué (et me clou encore) plus que 11 d'habitude sur ma chaise de bureau. Le bon côté des choses, c'est que 12 cela m'a permit de me poser et de réfléchir une bonne façon d'être 13 efficace et organiser, au travail et à la maison :-). 14 15 Une des principales /action/ que j'ai pris est d'utiliser un wiki local 16 et synchronisé sur /tout/ mes PCs. Le /format/ wiki est assez adapté à 17 une prise de note et à la création de contenu plus complet (comme des 18 [[http://shortbrain.org][articles]] ou de la documentation pour des 19 projets en cours). Les conditions étaient les suivantes : 20 21 - Facilité de mise en place. 22 - Pas de base de données. 23 - /Merging/ facile ([[http://git-scm.com][git]] /rules my world/). 24 - [[http://daringfireball.net/projects/markdown/][Markdown]] comme 25 syntaxe, car utilisé à peu près partout (blogs, articles, READMEs, 26 documentations). 27 - Éditable à partir d'une interface web ou de mon éditeur favoris. 28 29 L'outil qui remplit presque toutes ces conditions s'appelle 30 [[https://github.com/github/gollum][gollum]]. C'est un moteur wiki, 31 écris en ruby, qui se base sur un repository 32 [[http://git-scm.com][git]]. Il est développer par l'équipe de 33 [[http://github.com][Github]] et c'est celui qui est utilisé par les 34 pages wiki là-bas. Il permet d'utiliser à peu près n'importe quel 35 syntaxe (dont 36 [[https://github.com/github/github-flavored-markdown][github-markdown]] 37 qui est assez proche de celle de 38 [[http://johnmacfarlane.net/pandoc][pandoc]]). Par ailleurs, comme il se 39 base sur [[http://git-scm.com][git]], les points /"pas de base de 40 données"/, /"merging facile"/ et /"éditable également à partir de mon 41 éditeur favoris"/ sont toutes remplies. 42 43 Avec [[https://github.com/github/gollum][Gollum]] vous avez un wiki 44 markdown décentralisé, éditable via une interface web ou via votre 45 éditeur favoris. 46 47 * Mise en place 48 :PROPERTIES: 49 :CUSTOM_ID: mise-en-place 50 :END: 51 52 La mise en place est relativement simple ; après tout dépend du besoin 53 que vous avez. L'installation se fait par [[file:rubygems.org][RubyGem]] 54 ou en clonant le repository. 55 56 {{< highlight bash >}} # Installation de gollum et du format markdown de 57 github $ gem install gollum gitub-markdown {{< /highlight >}} 58 59 Si vous n'utilisez pas [[https://github.com/sstephenson/rbenv][rbenv]] 60 ou [[https://rvm.io/][rvm]] il est probable qu'il faille lancer la 61 commande en root ou utiliser sudo. 62 63 Ensuite, il suffit de lancer 64 [[https://github.com/github/gollum][Gollum]] dans un dossier qui est un 65 repository git ; le tour est joué 66 67 {{< highlight bash >}} # J'ulitise ~/desktop/wiki pour mon wiki $ cd 68 ~/desktop/wiki && gollum {{< /highlight >}} 69 70 L'idée finale est d'automatiser deux choses : 71 72 1. Le démarrage de gollum 73 2. La synchronisation du repository avec les différents autres /remotes/ 74 75 Suivant le système d'exploitation et/ou la distribution utilisées, il y 76 a énormément de possibilité d'effectuer cette automatisation. Dans mon 77 cas, j'ai une [[http://debian.org][Debian]] assez light, avec surtout 78 plein de scripts. Je démarre donc 79 [[https://github.com/github/gollum][Gollum]] au démarrage de ma session 80 grâce à une script qui est lancé dans la foulée du gestionnaire de 81 fenêtre. La synchronisation se fait grâce à une tâche planifiée /cron/ 82 qui est "distribué" sur chacune de mes machines. 83 84 /C'est tout pour le moment/ ;-).