Azure / Azure/Azure-Verified-Modules

[Question/Feedback]: Publish versioned module README as documentation

Open
#959 3 comments 2 reactions 0 assignees View on GitHub
Language: Bicep :muscle: Needs: Triage :mag: Status: In Triage :mag: Type: Question/Feedback :raising_hand:
Dominant language
PowerShell
Stars
580
Forks
161
Avg merge
11h 3m
Merged PRs (30d)
15

Description

### Check for previous/existing GitHub issues

- [X] I have checked for previous/existing GitHub issues

### Description

# Feature request

Publish versioned module/resource READMEs as documentation.

# Context

Bicep module for App Service Plan is v0.2 in GitHub, but newest in Bicep registry is 0.1.1. Thus the README in the GitHub repo (for v0.2) does not apply for the newest version available from Container Registry (v0.1.1).

*

Even the simplest example is broken now, in v0.2.0 vs. v0.1.1.

So please do like Bicep / ARM documentation ( https://learn.microsoft.com/en-us/azure/templates/microsoft.web/serverfarms?pivots=deployment-language-bicep ): Publish versioned documentation tied to a resource module for easier lookup.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the versioned module at avm/res/web/serverfarm with its Bicep registry version 0.1.1 and the Azure ARM documentation example linked in the issue. Define the documentation entry point and versioning approach; done means users can find README content matching the exact module version, including a working example.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.