cisagov / ScubaGear

Automation to assess the state of your M365 tenant against CISA's baselines
https://www.cisa.gov/resources-tools/services/secure-cloud-business-applications-scuba-project
Creative Commons Zero v1.0 Universal
1.65k stars 221 forks source link

Highly encourage use of MergeJson flag in the documentation #1286

Closed adhilto closed 1 month ago

adhilto commented 2 months ago

💡 Summary

Tweak the documentation to encourage the usage of the MergeJson flag.

Motivation and context

The MergeJson flag adds valuable output to ScubaGear, specifically a complete, machine-readable (json) version of the output. Depending on when #1205 can be completed, it may be valuable to highlight this flag to the users so they can start getting that output now.

Implementation notes

Adding a note to relevant sections of the documention and adding the -MergeJson flag in our Invoke-SCuBA examples will do the trick. (See https://github.com/cisagov/ScubaGear/pull/1281#pullrequestreview-2258260722).

Acceptance criteria

The documentation highlights the MergeJson flag OR #1205 is complete.

buidav commented 1 month ago

Solved in #1316