Azure / Azure/ResourceModules

[Feature Request]: Create a PoC for "Examples in readmes should allow modification of title and description"

Open
#1,979 4 comments 0 reactions 0 assignees View on GitHub
[cat] modules [cat] needs further discussion enhancement
Dominant language
PowerShell
Stars
737
Forks
436
Avg merge
10d 7h
Merged PRs (30d)
1

Description

### Description

Current module examples in readmes get titles from folder names in the modules .test folder.

Following how documentations is for PowerShell cmdlets, the examples have both title and descriptions next to the copy/pastable snippets. We should add automation to allow a test case/example to be adjustable with a custom title and description.

Test cases could also be written with contexts/scenarios in mind.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.