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

Out-DocumentationForPolicyAssignments does not generate split tables for Category documentation #757

Closed
mrwalters1988 opened this issue Sep 27, 2024 · 4 comments · Fixed by #763
Assignees
Labels
bug Something isn't working

Comments

@mrwalters1988
Copy link

Describe the bug
When running Build-PolicyDocumentation, there is a feature that documents the resources under a documentAllAssignments config, it will generate policy documents for each category. It is meant to add two tables. The first table is the Policy Effects. The second table should be the policy parameters.

It applies both, but combines them as a single table, making it rather difficult to parse through.

To Reproduce
Steps to reproduce the behavior:

Run Build-PolicyDocumentation using documentAllAssignments config

Expected behavior
A clear and concise description of what you expected to happen.

There should be an additional markdown header and table header segment added to the markdown.
This looks like it should be implemented in the code for out-DocumentationForPolicyAssignments at line 448.

Screenshots
image

EPAC Version
10.6.0

@mrwalters1988 mrwalters1988 added the bug Something isn't working label Sep 27, 2024
@anwather
Copy link
Collaborator

@apybar - is this one you can take a look at please?

@apybar apybar self-assigned this Sep 30, 2024
@apybar
Copy link
Collaborator

apybar commented Sep 30, 2024

@mrwalters1988 - Fixed. Default moving forward there will be an additional markdown header and table header segment added to each of the Services markdown (as long as a Policy Parameter exist).

Will be available in 10.6.1 - I will close this issue upon the release.

@mrwalters1988
Copy link
Author

@apybar can you point me to a commit or branch to update the code locally in the meantime?

@anwather
Copy link
Collaborator

anwather commented Oct 2, 2024

I will push out the new version hopefully in the next hour

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants