re: Documentation automation VIEW POST


Nearly all of Microsoft's documentation is fully automated this way.

As I understand it, the documentation is one of the largest repositories hosted on GitHub (it lived there even before the aquisition).

The public can contribute with pull requests and track issues. The documents are all markdown format and a full-automated build process compiles these into the SEO-friendly website. We use the built-in GitHub features to review and comment on submissions and have tags that automate parts of the process like excluding work in progress until it's approved for release. There is also a process to generate other formats like PDF, which is what I did for a free eBook about serverless I hosted on the platform.

You can read the details here if you're interested.


Hi Jeremy,
This is very useful and oriented to what I was looking for. Thank you for bringing it in.
Do you have details about the process to generate other formats?

code of conduct - report abuse