search

Azure / enterprise-azure-policy-as-code

Enterprise-ready Azure Policy-as-Code (PaC) solution (includes Az DevOps pipeline)
https://azure.github.io/enterprise-azure-policy-as-code/
MIT License
422 stars 230 forks source link

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

Open mrwalters1988 opened 4 days ago

mrwalters1988 commented 4 days ago

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

anwather commented 2 days ago

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

apybar commented 2 days ago

@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 commented 1 hour ago

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