Azure / Azure/ResourceModules

[Feature Request]: Make it possible to read module doc for a given version of a module

Open
#2,025 0 comments 0 reactions 1 assignee Claimed by @MariusStorhaug View on GitHub
[cat] needs further discussion documentation enhancement hackathon
Dominant language
PowerShell
Stars
737
Forks
436
Avg merge
10d 7h
Merged PRs (30d)
1

Description

### Description

As a solution designer and/or builder, I build my solutions with specific versions of modules. When new functionality is introduced to modules, the readme files for the modules are updated to match the new module version. When adjusting the solution or fixing some interface with modules, I need a way to look at the documentation for the specific versions I am using.

### Requirements

- Make the documentation for previous module versions accessible for consumers in an automated way. Keep focus on the latest version for new consumers of a module. Current should be what is default shown.
- Support for the current supported configurations of CARML as an internalized solution.
- Azure DevOps and GitHub, both in case of automation and making docs available.
- Refrain from increasing management overhead for both the CARML team and internalized teams.
- [Bonus] Available in collaboration with the other stream of making CARML modules consumable directly.

#### Mocks

- [ ] #1442
- [ ] Add attendees POCs here...

#### Nominated POCs

Nominated Mocks as something the team wants to continue POCing.

- [ ] # 1234

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.