Azure / Azure/ResourceModules

[Feature Request]: Version ReadMEs just as modules are versioned PoC

Open
#1,442 3 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

We implement a feature that enables us to version module ReadME files. This is important as the repository will only always contain the 'latest' ReadMe. I.e. you cannot got back and find a ReadMe for a previous module version.

One idea might be to populate a table in the Wiki that links a version with a ReadMe's link at the time of a specific commit (i.e. when a publish was executed). For example

---

### Key Vault
| Version | ReadME | Registry Reference | Template Spec Reference | Azure DevOps Artifact reference |
| - | - | - | - | - |
| `1.0.0` | [link](https://github.com/Azure/ResourceModules/blob/e42b1e9ab499ca63bfc1aca8c8f4cd953e3a759c/arm/Microsoft.KeyVault/vaults/readme.md) | `br/modules:microsoft.keyvault.vaults:1.0.0` | `ts/modules:microsoft.keyvault.vaults:1.0.0` | `https://dev.azure.com/contoso/CARML/_artifacts/feed/ResourceModules/UPack/microsoft.keyvault.vaults/overview/1.0.0` |
| `2.0.0` | [link](https://github.com/Azure/ResourceModules/blob/e42b1e9ab499ca63bfc1aca8c8f4cd953e3a759c/arm/Microsoft.KeyVault/vaults/readme.md) | `br/modules:microsoft.keyvault.vaults:2.0.0` | `ts/modules:microsoft.keyvault.vaults:2.0.0` | `https://dev.azure.com/contoso/CARML/_artifacts/feed/ResourceModules/UPack/microsoft.keyvault.vaults/overview/2.0.0` |

---

This should work in both GitHub and Azure DevOps.

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.