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
436 stars 243 forks source link

Documentation export trimmed down in md #743

Closed tsunami28 closed 2 months ago

tsunami28 commented 2 months ago

Describe the bug Exported md has trimmed values.

To Reproduce Steps to reproduce the behavior: Set the policy that allows 3+ VM SKUs and export documentation.

Expected behavior A clear and concise description of what you expected to happen. Value in csv is fine: "{""compute_allowed_disk_type_skus"":""StandardSSD_LRS"",""StandardSSD_ZRS"",""Premium_LRS"",""Premium_ZRS"",""PremiumV2_LRS""]}" Screenshots image

EPAC Version Version of EPAC module you are using. Latest PS module is imported.

apybar commented 2 months ago

@tsunami28 - This is actually controlled by the markdownMaxParameterLength property in your documentation file. If not set, then default is 42 characters. I am updating the documentation online and examples as well.

See example of my json here:

{
    "documentAssignments": {
        "environmentCategories": [
            {
                "pacEnvironment": "EPAC-PROD",
                "environmentCategory": "EPAC-PROD",
                "scopes": [ 
                    "Management Groups: Contoso-Prod"
                ],
                "representativeAssignments": [
                    {
                        "shortName": "test",
                        "id": "/providers/microsoft.management/managementgroups/4fb849a3-3ff3-4362-af8e-45174cd753dd/providers/microsoft.authorization/policyassignments/test"
                    }
                ]
            }
        ],
        "documentationSpecifications": [
            {
                "fileNameStem": "Azure-Policy-Assignments",
                "environmentCategories": [
                    "EPAC-PROD"
                ],
                "title": "Current list of Azure Policies deployed",
                "markdownAdoWiki": true,
                "markdownMaxParameterLength": 1000, // <------------------------------ THIS IS WHAT YOU NEED TO SET :)
                "markdownAdoWikiConfig": [
                    {
                        "adoOrganization": "EPAC",
                        "adoProject": "EPAC",
                        "adoWiki": "EPAC"
                    }
                ]
            }
        ]
    }
}

If you are documenting assignments using environmentCategories, this should be working on the current release, just set the 'markdownMaxParameterLength' in the 'documentationSpecifications' section to a large number.

If you are using documentAllAssignments , then there currently is a bug however I just resolved it and should be fixed in the next release - I will close this story after the release is published.

Confirming it is not outputting the full length of the parameter if markdownMaxParameterLength is not set - or using documentAllAssignments : image

Bug fixed and should be resolved on next release: image

anwather commented 2 months ago

Fixed in 10.6.0