A behind-the-scenes look at technical writing for open-source software. We connect with writers and other doc experts to hear their stories about overcoming challenges, working on special projects, and learning new methods.
This episode is a video demo, which you can see here on spotify or vimeo.
Chris Metz is a freelance solutions architect and tech writer with cloud and emerging technologies based in Danville, California, near the San Francisco Bay Area.
In "A brief demonstration of Mermaid.js," Chris shows us how to use Mermaid.js to add diagrams to your documentation.
Chris recently added the Diagram Guide to the Kubernetes.io website, where he is a regular contributor.
To me, this diagrams-as-code has several benefits:
It separates the content of the diagrams from how they are presented, which means that all your diagrams have a consistent look.
The search results will include your diagrams when you edit and search your docs.
Writers and developers can directly create diagrams without using specialized tools or creating asset files that get lost.
Jim Angel volunteers as a Kubernetes Member/Contributor and Cloud-Native Ambassador and leader in the Kubernetes Docs SIG. Here, he shares his personal story of getting into tech, localizing the Kubernetes docs, and leadership opportunities.
Tim Bannister is a technical lead for the Kubernetes.io documentation special interest group and a consultant at The Scale Factory. Here he talks about contributing to the Kubernetes.io documentation and joining the documentation special interest group (SIG).
For Podcast notes, visit https://rolfe.blog/2021/12/23/podcast-episode-tim-bannister-on-contributing-to-the-kubernetes-io-documentation/