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.
buidav
commented
1 month ago
💡 Summary
Tweak the documentation to encourage the usage of the
MergeJsonflag.Motivation and context
The
MergeJsonflag 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.