Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to generate multiple versions of IaC module documentation #316

Open
neok-g opened this issue Sep 9, 2024 · 1 comment
Open

How to generate multiple versions of IaC module documentation #316

neok-g opened this issue Sep 9, 2024 · 1 comment

Comments

@neok-g
Copy link

neok-g commented Sep 9, 2024

Is your feature request related to a problem? Please describe.

We are using Azure template specs for our bicep modules. We generate documentation for our template specs with PSDocs and the results are published in an Azure DevOps code wiki. Template specs support multiple versions. However our documentation only contains the latest version and developers might not always use the latest version of a template spec.

In our bicep files we include the following metadata.

metadata name = 'ts-servicebusnamespace'
metadata description = 'Creates an servicebus namespace'
metadata version = '2024-10-01'

Describe the solution you'd like

If we would like to document multiple versions of a template spec should we create multiple bicep files let say:
servicenamespace-2024-08-01.bicep
servicenamespace-2024-09-01.bicep
servicenamespace-2024-10-01.bicep

Or how can we achieve something similar as with Microsoft's Bicep documentation e.g. https://learn.microsoft.com/en-us/azure/templates/microsoft.eventhub/2024-01-01/namespaces?pivots=deployment-language-bicep

Describe alternatives you've considered

Additional context

Copy link

github-actions bot commented Sep 9, 2024

Thanks for raising your first issue, the team appreciates the time you have taken 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant