Skip to content

Module readmes - Add an example section on how to use the module #1227

@MariusStorhaug

Description

@MariusStorhaug

Description

When consuming a module to create a solution, we would achieve even more acceleration by providing examples written in bicep which can be copy/pasted over to a solution.

To achieve this we should investigate if we should/could automate getting the examples into the readme from either a separate .example folder with specific example files or using the new files for validation deployments (POC in progress). Headers for the different examples should then come from some metadata field in said file, maybe even with a description of the example it self.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions