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

Allow option to show .bicepparam example rather than JSON parameters #267

Open
Mantene opened this issue Aug 16, 2023 · 3 comments
Open

Comments

@Mantene
Copy link

Mantene commented Aug 16, 2023

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

We have switched over to using .bicep templates and .bicepparam files for parameters and gotten away from ARM/JSON. However, when the README.md file is generated, it only provides the JSON parameters file example.

Describe the solution you'd like

We would like PSDocs to provide a .bicepparam example instead of JSON when .bicepparam files are present or when a switch is passed.

Describe alternatives you've considered

We have tried to get the Set-ModuleReadMe.ps1 tool that is used in the CARML, but we don't seem to be able to get it to work at the moment.

@github-actions
Copy link

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

@Mantene
Copy link
Author

Mantene commented Feb 7, 2024

Is this repository no longer maintained?

@BernieWhite
Copy link
Member

Thanks @Mantene for your interest in PSDocs. Sorry we haven't been responsive on this.

We have plans to uplift PSDocs to address some challenges for Bicep users, but no immediate timeline for these.

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

2 participants