[Request] Add the ability to export the report in markdown format

[matthieupetite]

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

My request is not related to a problem but is more an enhancement. A lot of devops prefer to use in code documenation process to have it directly in their IDE such as VSCode with markdow previewer. I could be a very nice feature to have this in ari by exporting all the excel table in markdown table.

Describe the solution you'd like Add an exporter to mardown next to excel one

Additional context Add any other context or screenshots about the feature request here.

[matthieupetite]

If you had to develop that feature what will be your advise ? I wonder if I can take on me the work and make a PR

[Claudio-Merola]

Hey @matthieupetite

That is not an easy task considering how the script is build today.

At the moment the script is split in 3 big phases (Extraction, Processing, Reporting).

Extraction is a synchronous operation that brings the Resource Graph from Azure to a Powershell Variable, the Processing is asynchronous and uses several different files (we call them resource modules) to process the different resource types (one file for each resource type), the Reporting is synchronous and uses the same files to create the Excel sheets for each resource type.

I believe the easiest way to do it would be to create a separate function to run after the Extraction to start a different process (powershell job) to do a side processing/reporting in markdown format

[ruaan-deysel]

@matthieupetite you can try running this tool and see if it converts the content in excel file to markdown

https://github.com/microsoft/markitdown

[github-actions[bot]]

This Issue is stale and may be automatically close soon.