A Practical Introduction to Docs-As-Code
Room 8 | Mon 13 Jan | 1:30 p.m.–2:10 p.m.
Presented by
-
Alec Clews
@alecthegeek
https://alecthegeek.github.io/
Alec is an IT geek who currently works as the integration manager at PaperCut Software in Melbourne. He uses many Free software tools to create and manage developer API resources for people around the world.
He started using Linux 0.98p17 from three floppy disk images downloaded from Compuserve in the early '90s
Alec Clews
@alecthegeek
https://alecthegeek.github.io/
Abstract
This talk presents a short introduction to "Docs As Code" as an approach for developers to create and manage project documentation. The majority of the talk is dedicated to showing a small demonstration project that provides a practical overview of how Docs-As-Code can work.
At the end of the talk attendees will have some practical suggestions on how they might implement Docs-As-Code on their own projects.
Tools discussed include:
* Sphinx
* GitLab CI/CD Pipeline (and other GitLab features)
* Docker
* GNU Make
* Various text linting tools
* Pandoc
Linux Australia: http://mirror.linux.org.au/pub/linux.conf.au/2020/room_8/Monday/A_Practical_Introduction_to_DocsAsCode.webm
YouTube: https://www.youtube.com/watch?v=QqgaX8JFyB8
This talk presents a short introduction to "Docs As Code" as an approach for developers to create and manage project documentation. The majority of the talk is dedicated to showing a small demonstration project that provides a practical overview of how Docs-As-Code can work. At the end of the talk attendees will have some practical suggestions on how they might implement Docs-As-Code on their own projects. Tools discussed include: * Sphinx * GitLab CI/CD Pipeline (and other GitLab features) * Docker * GNU Make * Various text linting tools * Pandoc Linux Australia: http://mirror.linux.org.au/pub/linux.conf.au/2020/room_8/Monday/A_Practical_Introduction_to_DocsAsCode.webm YouTube: https://www.youtube.com/watch?v=QqgaX8JFyB8