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

SuppressDocumentation doesn't do anything because Export-AzPolicyResources doesn't document resources #756

Closed
mrwalters1988 opened this issue Sep 27, 2024 · 2 comments · Fixed by #763
Assignees
Labels
wontfix This will not be worked on

Comments

@mrwalters1988
Copy link

Describe the bug
Running Export-AzPolicyResources should generate documentation. It currently does not.

To Reproduce
Steps to reproduce the behavior:
Run:
Export-AzPolicyResources -OutputFolder ./outputTest -IncludeChildScopes -mode export -InputPacSelector "epac-main"

Then run:
Export-AzPolicyResources -OutputFolder ./outputTest -IncludeChildScopes -mode export -InputPacSelector "epac-main" -SuppressDocumentation

The output will be identical.
Expected behavior
Export-AzPolicyResources should generate documentation.

EPAC Version
Version of EPAC module you are using.
10.6.0

@mrwalters1988 mrwalters1988 added the bug Something isn't working label Sep 27, 2024
@anwather anwather self-assigned this Sep 30, 2024
@anwather anwather added wontfix This will not be worked on and removed bug Something isn't working labels Sep 30, 2024
@mrwalters1988
Copy link
Author

@anwather any explanation as to why this is a wontfix?

If this is something you're not fixing, should documentation be update to state that Export-AZPolicyResources doesn't document resources?

@anwather
Copy link
Collaborator

anwather commented Oct 2, 2024

Hi I've got a PR pending to update this function and the documentation. Discussed and we don't believe that generating the documentation during an export is of any value. If required you can generate documentation as part of the normal process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants