Using "old skool" Free tools to easily publish API documentation
Channel: LinuxConfAu 2018 - Sydney, Australia
Date: 2018-01-23

Alec Clews, Alec Clews

http://lca2018.linux.org.au/schedule/presentation/120/

API developers need to frequently push good quality documents to their users. Just throwing an API specification onto a website if not good enough and will make life very hard for other developers.

This talk will focus on how to create and publish documentation quickly and easily as part of the development process. Using free tools and hosting services, plus some time to set up a docs "build" system you can make edits fast and easy, so that the documentation is more likely to be kept up to date and be useful.

This talk was given at Linux.conf.au 2018 (LCA2018) which was held on 22-26 January 2018 in Sydney Australia.

linux.conf.au is a conference about the Linux operating system, and all aspects of the thriving ecosystem of Free and Open Source Software that has grown up around it. Run since 1999, in a different Australian or New Zealand city each year, by a team of local volunteers, LCA invites more than 500 people to learn from the people who shape the future of Open Source. For more information on the conference see https://linux.conf.au/

#linux.conf.au #linux #foss #opensource