Battlemesh test docs

29th July 2015 in Thoughts Tags: battlemesh, event, wireless-community

This is going to be my fourth battlemesh!

I was not satisfied with how the test results were published so I volunteered on this task to help out.

I just finished the first version of the Battlemesh Test Docs.

I hope we'll use it as a baseline for ongoing improvement and start to publish human readable documentation and results at the end of each year edition.

The documentation source format is reStructuredText and it's hosted on Github while the browsable website is hosted on readthedocs.org.

The repo structure is prepared to host the documentation and the results of multiple battlemesh editions, starting from the v8 edition, although past editions can be added if anyone will volunteer to do that.

I find this kind of solution much better than wikis because of the several advantages it gives:

  • the documentation can be built easily in different formats: HTML, PDF; EPUB
  • the documentation can be built offline
  • it's possible to work on it offline
  • it's possible to work on it with your favourite text editor instead of a web interface, which is likely to result in increased productivity and less time wasted fighting with wikis
  • reStructuredText can be easily converted in other formats (eg: markdown)
  • it's very easy to publish it on the amazing readthedocs.org
  • managing and browsing translations is straightforward
  • managing and browsing different versions is straightforward - even though it doesn't apply in this case (we'll likely have 1 version only which is updated over time)
"Wikis are where documentation goes to die."
Jacob Kaplan-Moss

See you in Slovenia!

Retweet

Comments

Leave your comment

Categories

Let's be social

Popular posts

Latest Comments

  1. When I ߋriginalⅼy commented I seem to have clicked the -Notify me when new comments aгe added- checkbox and from now on each time a comment іs adԁed I get 4 emails wіth the same comment. Ⲣerhaps there is an easy method you can remove ...

    By youjizz in Django Tagging Autocomplete Tag-It

  2. Hey there I am so thrilled I found your weƄ site, I really found you by accident, whiⅼe I was reseɑrϲhing on Digg for something else, Nonetheless I am here now and woսld jսst like to say many tһanks fοг a tremendous post and a ...

    By youporn in Django Tagging Autocomplete Tag-It

  3. Sexy photo galleries, daily updated pics http://upload.porn.hotblognetwork.com/?anna breast boob tit nipple porn hair style porn bb08 australia porn fee porn no signon man in a relationship view porn

    By barbarakc3 in OpenWISP at IETF Bangkok

  4. Girls of Desire: All babes in one place, crazy, art http://black.lesbians.bestsexyblog.com/?dominique porn movies harry potter lesbiand porn videos free lesbain porn vedios free porn movie dumps teen bi porn

    By lorraineum16 in OpenWISP at IETF Bangkok

  5. Sexy photo galleries, daily updated pics http://dating.service.xblognetwork.com/?denisse spy toilet poop porn long pron free movies the fastest porn torrent quicktime free lesbian porn alice 3d porn

    By alanawy11 in OpenWISP at IETF Bangkok

Popular Tags

battlemesh censorship creativity criptography django event fosdem google-summer-of-code ibiza inspiration javascript jquery linux nemesisdesign netjson ninux nodeshot open-source openwisp openwrt performance photo programming python security staticgenerator talk upload wifi wireless-community