ditaa
Dessiner des diagrammes en ascii art, c'est sympa. Enfin, c'est comme la ligne de commande, certains ne comprennent pas que l'on puisse rester avec des outils qui paraissent aussi rustiques mais pour d'autres, c'est juste impensable de faire autrement.
Heureusement, il existe ditaa, un outil sous licence GPL qui permet de créer des images à partir de diagrammes en ascii art, permettant ainsi de réconcilier les deux populations.
DocumentUp
Écrire une documentation agréable, jolie et pratique à utiliser n'est pas une tâche simple. Mark Phillips a recensé une liste de documentations remarquables sur ces critères, beautiful-docs, pour vous inspirer si vous le souhaitez. Si vous souhaitez vous lancer dans l'écriture d'une telle documentation, je vous souhaite bon courage et sachez que le résultat en vaudra très certainement la peine.
Mais pour les gens qui, comme moi, ne s'en sentent pas la motivation ou ne souhaitent pas prendre le temps de faire ça, il existe aussi une solution de facilité : DocumentUp. Cet outil, sous licence MIT, prend un fichier README depuis un dépôt github et le transforme en une page web structurée, offrant ainsi une documentation pour votre projet dont vous n'aurez pas à rougir.
À noter que le site web de DocumentUp est généré avec DocumentUp et est donc un bel exemple d'utilisation de DocumentUp.
Sensu
Sensu se veut une solution moderne de monitoring sous licence MIT, apte à travailler dans des infrastructures élastiques. Sonian, la société qui a développé Sensu, travaillait avec Nagios mais ils n'en étaient pas totalement satisfaits. Utilisant Chef et Puppet pour faire varier le nombre de serveurs et leurs rôles, ils étaient particulièrement gênés par certaines limitations de Nagios comme devoir déclarer l'intégralité des serveurs au démarrage.
Sensu est écrit en Ruby avec le framework EventMachine. Il utilise un message queue RabbitMQ pour la communication entre le tableau de bord et les sondes. Ses fichiers de configuration sont écrits en JSON et Sensu utilise Redis comme base de données pour des données transitoires.
Il est possible d'utiliser des greffons Nagios pour les sondes et d'envoyer des métriques à différents backends dont Graphite.
Aller plus loin
- Le site officiel de ditaa (978 clics)
- Le site officiel de DocumentUp (1215 clics)
- La liste de documentations beautiful-docs (580 clics)
- Le site officiel de Sensu (486 clics)
- Démarrer avec Sensu (183 clics)
- Billet de blog d'introduction à Sensu (112 clics)
# Le Format Ditaa
Posté par zonder . Évalué à 4.
Le Format utilisé en natif pas Ditaa est le plus lisible que j'ai jamais vu.
[^] # Re: Le Format Ditaa
Posté par cosmocat . Évalué à 4.
Et un format idéal pour archiver dans un contrôleur de code source!
# Merci!
Posté par weeber (site web personnel) . Évalué à 3. Dernière modification le 10 février 2012 à 22:48.
Merci pour m'avoir fait connaitre ces outils, en particulier ditaa, c'est un approche intéressante pour faire des diagrammes.
DocumentUp produit facilement un résultat très joli (c'est important ;)!)
Par contre dommage que ditta ne permette pas de générer des images vectorielles.
# Ditaa
Posté par ymorin . Évalué à 5.
ditaa
, j'adore !Je vais encore passer pour un vieux geek auprès de mes collègues, moi ! :-)
Ceci dit, il serait génial d'utiliser
ditaa
comme greffon à un WiKi. Pour faire des rendus de schémas dans mes pages de WiKi, j'en chie un peu... Avecditaa
, ça donnerait super !Bon, yapuka... Comme si j'avais pas assez de trucs à faire comme ça, moi... ;-)
Hop,
Moi.
[^] # Re: Ditaa
Posté par ymorin . Évalué à 4.
Bon, c'est cool, ça existe déjà pour
dokuwiki
( que j'utilise, ça tombe bien ! )Hop,
Moi (tout excité).
[^] # Re: Ditaa
Posté par Sytoka Modon (site web personnel) . Évalué à 0.
Enfin, c'est du java alors dans un wiki, ca va ramer fort ;-)
[^] # Re: Ditaa
Posté par devnewton 🍺 (site web personnel) . Évalué à 2.
Pourquoi ne pas utiliser le langage DOT de graphviz?
Pour tes collègues, tu génères des images et pour toi tu génères du ascii art (avec http://search.cpan.org/~tels/Graph-Easy/bin/graph-easy).
Le post ci-dessus est une grosse connerie, ne le lisez pas sérieusement.
# Du DocumentUp en ReST
Posté par Florence Birée (site web personnel) . Évalué à 2.
Ce DocumentUp me fais penser à un bout de code que j'ai commit récemment : RstForge, qui produit un site web pour un logiciel à partir de fichiers reStructuredText (le format textuel des docs de Python), avec une intégration à Ditz pour la gestion des bugs.
Bon, la css est moins belle que DocumentUp, mais par contre ça s'installe sur son serveur à soi, ce qui ne semble pas être le cas de DocumentUp (et je trouve dommage de dépendre ainsi d'un service externe, juste pour faire une bête traduction de fichiers textes).
[^] # Re: Du DocumentUp en ReST
Posté par Bruno Michel (site web personnel) . Évalué à 3.
DocumentUp conseille par défaut de passer par leur service parce que c'est plus simple, mais si tu veux l'installer sur ton serveur, rien ne t'en empêche, c'est juste une application node.js.
[^] # Re: Du DocumentUp en ReST
Posté par Florence Birée (site web personnel) . Évalué à 1.
Je me doute bien, mais c'est franchement pas mis en avant sur leur site web.
# ditaa et Org-mode (Emacs)
Posté par Bastien . Évalué à 1.
A noter qu'il est très facile d'intégrer des schémas ditaa à un document écrit avec Org-mode.
Voir http://doc.norang.ca/org-mode.html
Sur github, vous pouvez aussi utiliser README.org qui comprend la syntaxe Org et produit une page HTML idoine.
Suivre le flux des commentaires
Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.