During one of my Network Automation workshops one of the attendees said: “Why are you using open-source software? It’s so poorly documented and impossible to set up.”
I totally understood what he was trying to say (I’ve seen too many examples of just read the code approach), but fortunately there are still people who understand the value of documentation.
For starters, Jinja2 and Ansible (the tools I use during hands-on parts of the workshop) have pretty good documentation, and sometimes you get totally surprised by what you see on GitHub. I’ll give you just two recent examples:
- Layer-2 VPN Snabb Switch extension by Alex Gall;
- Macvlan and ipvlan modules for Docker by Brent Salisbury.
So it is possible to have well-documented open-source software assuming the author(s) of the software actually care about their users (and no, I will not start another rant about people spending time on glitzy demos instead of writing usable documentation).
Finally, for some choice comments on other less-documented parts of open source landscape, enjoy this talk by Artur Bergman.