Skip to content

How to generate multiple versions of IaC module documentation #316

@neok-g

Description

@neok-g

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions