Documenter mon projet open-source rapidement

Documenter mon projet open-source rapidement

Je reçois beaucoup de questions sur les outils à utiliser. J’ai décidé d’y répondre ici.

Comment documenter de façon économique un projet open-source, fait sur le temps libre ?

Les générateurs statiques sont très efficaces, et en version hébergée pour vous, il n’y a pas, en 2020, tant de solutions que cela. Mes recherches ont été faciles.

En fait, j’ai identifié 4 solutions pratiques qui supportent le Markdown :

  • Github Pages : un Jekyll rattaché à vos projets hébergés sur Github
  • Gitlab Pages : à vous de choisir le générateur statique qui vous convient.
  • ReadTheDocs (gratuit pour les projets open-source) : choisissez entre deux parfums, un Sphinx ou un MkDocs, pour utiliser le format de fichier qui vous convient le mieux.
  • Gitbook (gratuit pour les projets open-source) : solution propre, l’équipe est à Lyon.

[evenement] Compte-Rendu des JDLL, Lyon

JDLL 2014 logo

JDLL 2014


J’ai participé aux JDLL pour soutenir l’événement et pour donner un coup de main au Hackerspace sur la tenue de leur stand. J’ai même pris la liberté d’assister à quelques conférences.

Voici ce que j’en ai retenu :

  • Blender : création d’objets et impression en 3D

    par Matthieu Dupont de Dinechin

    La présentation a été sur les possibilités. L’exemple qui m’a vraiment plu a été la démonstration d’une interface de Blender créée pour une journée dans un musée. La contrainte était de laisser des enfants imprimer une maison qu’ils auraient créée en 3D. L’idée a été de créer un Paramétreur de maison : nombre de fenêtres, pente du toit, longueur, courbure de la maison, etc. et de laisser chacun personnaliser sa maison.
    Voir le résultat sur : http://chantierlibre.org/2013/10/12/folle-journee-de-larchitecture-2013-53-maquettes-differentes-en-une-journee/

  • Création de jeux video : cadre personnel, pédagogique et parental

    par Sébastien Navarro

    Si on veut s’impliquer dans les jeux vidéo de ses enfants, on peut passer par la co-création de jeu avec eux. Cela a plusieurs avantages : passer un moment avec son enfant, créer et s’approprier un jeu vidéo, et également au niveau pédagogique montrer qu’on peut fabriquer soi-même quelque chose !
    Les questions des mères présentes dans la salle me conduisent à penser qu’un Coding Goûter spécial Mamans devrait voir le jour.

  • Les bases du design et de l’ergonomie pour les développeurs par un développeur

    par Franck Rousseau

    Cette conférence était un peu courte, le sujet méritait qu’on en parle. Cette intervention rappelait les fondamentaux du design, la réflexion sur le contenu : quel impact, quelle quantité, quel disposition étaient les plus adaptés au web. J’ai apprécié les exemples de l’utilité d’une grille sur un vrai site, en réalignant les contenus, la légère différence induite était déjà appréciable.
    Le mot clef du speaker était : alignez vos éléments !

  • Comment enseigner Internet aux enfants et aux adultes

    par Adrian Gaudebert

    Je suis impliquée dans l’enseignement de la programmation aux enfants, et je l’ai été pour les adultes. Et là, on venait nous parler de nos familles qu’on dépanne si souvent, et qui continuent à être un peu embrouillés dans les métaphores. Comment peut-on les aider, en étant informaticiens à prendre confiance et à répandre le savoir autour d’eux ?

  • Associations et logiciels libres

    par Laurent Costy

    Je me suis largement trompée sur cette conférence. J’espérais qu’on me présente un outillage de logiciels libres dédiées aux associations, il s’agissait en réalité d’un parallèle entre les valeurs du libre et les valeurs de l’éducation populaire. C’était intéressant mais pas ce que j’étais venue chercher.

 

De retour du FOSDEM 2012

Le week-end passé, j’étais à Bruxelles, pour le FOSDEM (Free and Open Source Developers European Meeting). Rappelons que cet événement est gratuit et libre d’accès. Le FOSDEM a lieu sur un campus universitaire et rassemble depuis plus de 10 ans des développeurs et assimilés pour les faire échanger. L’an dernier, il y a eu 4000 visiteurs, qui sont venus pour assister à des conférences, des ateliers, passer des certifications Linux (LPI) ou certifier leurs clefs PGP.

logo FOSDEM

Cette année, un nouveau bâtiment a été investi, dédié aux stands de projets OpenSource, il y avait 2 bars et 3 friteries pour se restaurer. L’an dernier, j’avais passé mon tour, l’année précédente, ma boîte de vitesse avait passé son tour (biélette qui lache) et mon précédent FOSDEM remontait à il y a déjà 3 ans.

Le trajet pour y aller a été épique, car notre voiture de location n’était ni équipée de pneus neige, ni fournie avec des chaînes ou chaussettes. Je remercie Grincheux de sa passion pour le pilotage en conditions difficiles, qui nous a menés à bon port, malgré la fatigue, les « ilôts » et les « risques de file » typiquement belges. En effet, avec 5cm de neige qui tient tombés en 2h de temps, l’arrivée à Bruxelles a été épique. (Pour vous donner une idée, notre véhicule driftait au lieu d’aller tout droit, et nous avons bien eu peur de nous payer une collision avec le trottoir ou un autre véhicule, dans une petite ville, et de retour sur autoroute, un camion patinait et reculait dans la pente au lieu d’avancer, tant il glissait, assez impressionnant).

Une fois sur place, nous avons donné un coup de main aux Volunteers. Cela donne droit à un joli tee-shirt orange vif, des missions de la plus haute importance (j’ai accroché des banderoles, porté des valises, guidé un nombre innombrable de visiteurs à travers le campus) et vous répondez sans cesse à des questions car tout le monde vous interpelle.

Il faut avouer qu’en échange, vous avez droit à du café à volonté, un bon pour vous gaver de frites le midi et que les gens sont aimables avec vous (on m’a laissé passer dans la file à la caféteria).

Je n’ai suivi que trois conférences, la keynote de bienvenue et deux tracks de la salle Open Source Game Development. C’était bien intéressant, et voici le résumé :

  • Composition over inheritance
  • Refactoring needs time, more time
  • et j’y ai découvert deux choses :
    • WorldForge the original open-source MMORPG project, dating back to 1997
    • Unknown Horizons : an open source real-time economy simulation game with strategy elements in an isometric 2D engine

En fait, cet événement est assez énorme, des contributeurs de vos projets préférés y sont présents, certains sont même sur des stands. Sur les stands, vous pouvez acheter des goodies (mugs, tee-shirt) ou des livres, ou tout simplement, poser des questions. Les conférenciers vont de simple passionnés à des experts dans leur domaine, voire des stars du monde libre. Les lightning talks permettent de découvrir des projets rapidement ; le bar permet de laisser traîner ses oreilles et nouer des échanges avec des développeurs de tous horizons.

Et si vous êtes timide, la veille au soir (le vendredi soir) vous pouvez aller tâter le terrain au Beer Event avec un choix de 25 sortes de bières pression, et le reste en bouteilles.

edit : Julia Buchner vous explique quel équipement emporter.

Alors, l’an prochain, vous y allez aussi ?

Blog Day : les 5 blogs que je vous recommande

Blog Day 2009

A l’occasion du Blog Day 2009, je me propose de vous recommander 5 blogs que j’apprécie. C’est l’occasion pour moi de les remercier de leur production et de leur enthousiasme.

Ergonomie web, Ruby on Rails et Architecture de l’information (T37.net) : le blog de Frédéric de Villamil

Je ne me souviens même plus comment je l’ai découvert, quoi qu’il en soit, je lis tous les billets publiés sur ce blog. La version anglaise existe aussi depuis peu, aucune raison de bouder ce blog.

edit: J’ai oublié de mentionner pourquoi je vous le recommande. Tous les billets sont rédigés avec soin,  apportant une réflexion soit sur une méthodologie, une manière de faire, un choix politique ou un outil. Avec F. De Villamil, j’ai découvert plein d’idées, j’ai dû réfléchir et j’ai fini par ouvrir moi-même un blog.

Clochix, geek libriste

Sur le blog de Clochix, vous lirez des billets techniques et aboutis, par un geek timide et libriste. Tous ses billets m’ont appris quelque chose, soit par la technique décrite que je ne connaissais pas, soit par la démarche présentée, soit par la découverte d’un nouvel outil.

Si vous êtes un peu techno-addict et que vous misez sur le logiciel libre, c’est Clochix qu’il faut aller lire.

Travailleurs Du Web : le blog de Babozor, geek, barbu, cycliste et fier de l’être

Babozor possède une réelle énergie et une envie de faire bouger les choses, il a monté son blog pour réfléchir sur les métiers liés au web, il a même lancé un TDWCamp, et depuis, il est devenu CTO, toujours dans le web, a lancé une émission de bidouilleurs (hackers) : La Grotte du Barbu.

Babozor est entier et c’est pour cela qu’on s’attache à ce blog. Ses billets proposent autant des réflexions sur les métiers liés au web, des réflexions sur comment aller mieux (concilier vie pro/perso/passions) que des tests d’outils ou des débats politiques.

Le blog de Julien Pauli expert PHP sur Developpez.com

Ex-collègue, Julien est passionné et très pointu sur PHP, le Zend Framework et depuis quelque temps, Apache. Il veut tout savoir, passe du temps à jouer avec la SPL (Standard PHP Library), à dévorer des livres d’informatiques, et de temps en temps, il déballe un billet sur son blog.

La lecture de ses articles de blog, mais aussi tutoriels sur Developpez.com vous enrichira forcément.

Et en dernier, j’hésite entre trois blogs, car mon aggrégateur de flux me les signale comme ceux que je lis le plus complètement…je vais donc vous parler des trois (et ainsi je cite mes sources).

La Ferme du Web

Découverts parce qu’ils parlaient de Symfony, ces petits gars sont branchés en permanence sur des Forges et dégottent plein d’outils opensource, relatifs au développement web. Ils rédigent eux mêmes leurs articles.

J’aime donc découvrir les potentiels futurs outils qui m’aideront à bosser sur des projets web, et leur tutoriel sur Symfony est très intéressant et complète parfaitement la documentation officielle.

J’aimerais aussi mentionner :

tototoolco

Le nom imprononçable de ce blog ne doit pas vous rebuter. Il s’avère que je lis 100% des billets publié sur ce blog, selon Google Reader.

En plus, il fait partie des blogs que je lisais avant l’avènement du Flux de Syndication (béni-soit-il) et que j’ai fini par retrouver. J’apprécie ses billets sur l’Utilisabilité et ses trouvailles autour du web, toujours pertinentes.

FredZone

Bien qu’il aborde beaucoup de sujets qui ne m’intéressent pas (trop fashion), les trouvailles de Fred ainsi que le ton détendu de ses billets me garantissent toujours un certain émerveillement.

Si vous avez envie de savoir tous les blogs que je suis, ma liste de syndication (mise à jour) est toujours au même endroit.

Aujourd’hui c’est le Thank A Dev Day !

Qu’est-ce que c’est ?

il s’agit d’une journée pour exprimer sa gratitude à un développeur OpenSource pour un logiciel qu’il a créé.

Comment ça marche ?

C’est simple, choisissez l’appli OpenSource que vous préférez, trouvez les coordonnées du développeur et envoyez lui un mail avec le tag [TADD] dans lequel vous lui expliquez pourquoi vous appréciez son logiciel.

En savoir plus : http://thankadev.wordpress.com

Expérience Diigo : ajouter des notes à un contenu

Après la lecture d’un article très long, je me suis mis à le surligner, en ajoutant, de ci, de là, mes notes.
Cela donne un résultat intéressant, surtout que d’autres utilisateurs ont fait des sélections dans ce contenu.

On rentre dans les conditions extrêmes, vu la taille du texte initial. Surtout que j’ai également annoté certains commentaires.

Allez donc explorer la chose et me dire si vous avez compris le sujet, s’il vous plaît.

Coup de pub pour mes collègues

Au quotidien, je côtoie surtout mes stagiaires, qui changent chaque semaine et mes collègues.

J’avais envie de leur rendre hommage, en leur faisant un petit coup de pub.

Bon on a donc,

Les autres n’ont pas de blog, mais ils n’en pensent pas moins.

Le Web2.0 est mort, allons à la suite

Alors, c’est officiel, LE site le plus social TechCrunch, annonce la mort du web2.0.
Evidemment, en bonne blogueuse du web2.0, je suis une fashion-mouton-victim, aussi je change le nom de ce blog, et pour coller à l’esprit de mon Maître (il va être surpris de l’être), qui avait depuis longtemps senti cette problématique de récupération du nom , je passe le nom du blog en OpenSource et médias sociaux.

En plus, cela fera un TB de plus à l’article de TC.

Evidemment, cela passe par la modification de la superbe image en bandeau, qui permet à mes nombreux fans de me reconnaître de visu, lors des soirées mondaines que je fréquente.

Bon, une fois qu’on a dit que le web2.0 n’était que cendres. Qu’en reste-t-il ?

Des sites web

Il reste des tas de sites web, où l’utilisateur est central, où il crée le contenu, fait sa loi, et remplit des profils de données précieuses pour les marketeurs. J’en veux pour preuve un des derniers site que j’ai testé : ULike (notez les selon vos goûts et découvrez qui sont vos jumeaux parmi les autres membres).

Le prétexte de ce site est de vous proposer ce que vous pourriez aimer, en s’appuyant sur vos goûts actuels. L’interface est claire et moderne, avec des polices en corps 28, beaucoup d’espace blanc autour de vignettes. Le système de notation de ses favoris est simple, régi par un code couleur antique (vert-orange-rouge).

Bref, ces profils permettront de faire une publicité très bien ciblée, on peut déjà remarquer la présence de publicités incitatives pour amazon, discrètement, mais judicieusement placées sous la boîte de notation.

Des utilisateurs

Il reste aussi des internautes de plus en plus nombreux, qui ont commencé par se faire une page MySpace ou un compte Facebook, et se sont habitués à recevoir des données en temps quasi-réel sur l’activité de leurs pairs.

Ces mêmes internautes apprennent de plus en plus à étiqueter l’information de manière non-hiérarchique, à cliquer sur les petites icônes affriolantes qui permettent de mémoriser les favoris ou sur les petits triangles prometteurs d’un contenu plus complet une fois déplié.

Récemment, j’ai vu à la TV un épisode de South Park dans lequel Internet était arrêté. De ce manque de ressource s’ensuivait une panique terrible. Au delà de la satire de cette série d’animation, je me suis vue me poser la question « Et si cela m’arrivait ?« .
L’addiction à Internet est une réalité pour de plus en plus d’entre nous, et sans aller jusqu’à cette addiction, on peut parler de la confiance qu’on met dans Internet, par exemple pour Wikipédia, qui remplace petit à petit les recherches en bibliothèque.

Des techniques

Il reste des tas de frameworks Ajax ou simplement Javascript, qui vont permettre aux sites à venir d’être toujours plus interactifs, il reste aussi Silverlight et Flex. Tous ces outils techniques ont permis à Javascript et ActionScript (donc à de nombreux développeurs web) de se remettre au goût du jour.
Les technologies sont de plus en plus ciblées sur la gestion des entrées/sorties, et de la sécurité, sur le cache pour réduire la charge serveur.
Si on ne sait pas encore comment vont se répartir les différentes technologies citées ci-avant, on sent déjà avec le HTML5 en préparation que les sites web seront de plus en plus ciblés sur les visiteurs (tranche d’âge, expertise, terminal mobile ou non, etc.).

Bref, le web2.0 est terminé pour les levées de fond, mais Internet et la partie site web, autant que les IM ont évolué et continuent chaque jour, par effet de club, à toucher de plus en plus de personnes.

NB : Je reste sur ma position concernant le mythe de l’Internet comme Agora, puisque l’Agora n’était accessible qu’aux hommes libres (exit les femmes, et les esclaves).