Session
Publish Your Docs As a Champ
It would not be an exaggeration to say that we do most of our learning by reading some type of documentation. It is hard to over-emphasize how important technical documentation is to minimize headaches while trying to create, build or maintain a piece of software.
Either you are a developer just getting started on a new project, an operations engineer trying get through the deployment process, a support engineer swimming through the ocean of info/reports/logs to find a root cause for the problem in production environment or a manager trying to make sure the entire project is on track, having easy access to correct, complete and up-to-date documentation makes a huge difference.
However, there are few challenges to maintain documentation:
* Nowhere near the code they intend to represent and describe.
* Spread across the projects and tools.
* Searching is the hard part.
* And before we even realize it, the docs goes stale and outdated.
Some of these problems could easily be avoided by managing the docs along with source code, among a lot of options, GitHub Pages seems to the best and easiest way to achieve this, however it brings more challenges with it like building and publishing docs across projects or organizations. Automating this is even more challenging unless we have a set of better process and tools around this.
In this presentation we are going to talk more about various options to publish docs through GitHub pages and how to make your documentation (including service api docs, wikis, blogs, presentations and/or demo videos) live with your source code like a champ.
I plan to demo a working solution to make it easier to maintain and publish documentation in an enterprise that follows agile methodology.
Tools that empower this solution are GitHub Pages, Hugo, GitHub Apps, Jenkins and a few other tools available in an enterprise.
Audience Takeaway:
Maintain documentation without having to worry about where to find it. How to adopt this framework and a set of practices and ideas to start building their own team's high quality technical documentation.

Naresh Rayapati
Staff Software Engineer, DevOps at Citrix. Pragmatic & Passionate Programmer. OSS Contributor.
Overland Park, Kansas, United States
Links
Please note that Sessionize is not responsible for the accuracy or validity of the data provided by speakers. If you suspect this profile to be fake or spam, please let us know.
Jump to top