Contribution guide Generate module readme

As per the module design structure, every module in the CARML library requires a ReadMe markdown file documenting the set of deployable resource types, input and output parameters and a set of relevant template references from the official Azure Resource Reference documentation.

The ReadMe generator utility aims to simplify contributing to the CARML library, as it supports creating the module ReadMe markdown file from scratch or updating it.

---

Navigation

• Location
• How it works
• How to use it

---

Location

You can find the script under /utilities/tools/Set-ModuleReadMe.ps1

How it works

1. Using the provided template path, the script first converts it to ARM/JSON if necessary (i.e., if a path to a Bicep file was provided)
2. If the intended readMe file does not yet exist in the expected path, it is generated with a skeleton (with e.g., a generated header name)
3. The script then goes through all sections defined as SectionsToRefresh (by default all) and refreshes the sections' content (for example, for the Parameters) based on the values in the ARM/JSON Template. It detects sections by their header and always regenerates the full section.
4. Once all are refreshed, the current ReadMe file is overwritten. Note: The script can be invoked combining the WhatIf and Verbose switches to just receive an console-output of the updated content.

How to use it

For details on how to use the function, please refer to the script's local documentation.

Note: The script must be loaded ('dot-sourced') before the function can be invoked.