Terraform Cloud Project Bootcamp with Andrew Brown — Journal TOC and Major Version (for good documentation)
This article is part of my Terraform journy with the Terraform Bootcamp by Andrew Brown and Bayko Brown with Chris Williams and Shala (Gifted Lane).
My wild career shift and adventure into Cloud Computing continues with Andrew Brown, and I highly, highly recommend you to come join us if you are interested. Check out Andrews’ all free youtube learning contents. You can also buy some paid courses here to support their good cause.
In this short video, we restructured the giant README.md file into more smaller chunks so it’s easier to understand the structure:
- Simpler
README.md - Weekly journals in journal folder
- Weekly journal with Table of Content (TOC)
You can compared the difference by comparing the new documentation against the old version.
If you find documenting too daunting a task, you can generate out the TOC with ease using this handy tool. The output is not always 100% correct or as you want it, but it helps you speed up with your documentation. Good documentation is of paramount importance as a cloud engineer or any other similar roles in the IT space. As we work in team, not only your team mates but also possibly more people outside your team might have to follow or work with your code. So be sure to hone your skills in good documentation so people can do what you have done just by following your written guide even when you are not right there to help them (check out this video above on expectations for Cloud Engineers).
