Building a web catalogue for private Bicep registries

 
Norwegian Intermediate DevOps

Documentation: Often the least favorite aspect of coding, especially for those of us working with Bicep in cloud engineering. Yet, what if there were ways to not just simplify, but actually enjoy the process of creating documentation for your Bicep code? Join us as we delve into the journey of building a web catalog for your private Bicep registry. We will begin with an introduction to the public registry for Bicep modules and then look at why you would still consider a private registry. From there, we dive into the advanced techniques of leveraging PSDocs for generating in-depth documentation for your Bicep modules. We will then demonstrate how to consolidate these markdown files into a cohesive catalog using MKDocs, incorporating Material design for an enhanced visual appeal. Our focus will be on hands-on demonstration, enabling you to directly apply these insights and techniques to your projects and workflows. This practical approach will cover a range of tools, including Azure, Bicep, PowerShell, GitHub Actions, PSDocs, and MKDocs, but the knowlegde can be used with a different stack as well. Target audience: IT Engineers, DevOps Engineers

Speaker

Simen Østensen

Devoteam M Cloud, Senior Cloud & DevOps Engineer

With a background in Economics and Computer Science, my academic path led me to a deep interest in the technological and practical sides of technology. I quickly transitioned my focus towards the cloud, diving into Azure’s vast capabilities. Now, I dedicate my work to innovating within Azure, employing a code-first approach to everything I do in the cloud. Outside of work, my passion for technology continues as I enjoy exploring a variety of projects, always keen to expand my horizons and apply new ideas.

Code of Conduct

We seek to provide a respectful, friendly, professional experience for everyone, regardless of gender, sexual orientation, physical appearance, disability, age, race or religion. We do not tolerate any behavior that is harassing or degrading to any individual, in any form. The Code of Conduct will be enforced.

Who does this Code of Conduct apply to?

All live stream organizers using the Global Azure brand and Global Azure speakers are responsible for knowing and abiding by these standards. Each speaker who wishes to submit through our Call for Presentations needs to read and accept the Code of Conduct. We encourage every organizer and attendee to assist in creating a welcoming and safe environment. Live stream organizers are required to inform and enforce the Code of Conduct if they accept community content to their stream.

Where can I get help?

If you are being harassed, notice that someone else is being harassed, or have any other concerns, report it. Please report any concerns, suspicious or disruptive activity or behavior directly to any of the live stream organizers, or directly to the Global Azure admins at team@globalazure.net. All reports to the Global admin team will remain confidential.

Code of Conduct for local live streams

We expect local organizers to set up and enforce a Code of Conduct for all Global Azure live stream.

A good template can be found at https://confcodeofconduct.com/, including internationalized versions at https://github.com/confcodeofconduct/confcodeofconduct.com. An excellent version of a Code of Conduct, not a template, is built by the DDD Europe conference at https://dddeurope.com/2020/coc/.