Revamp Parameters.md

[adhilto]

Prerequisites

• This issue has an informative and human-readable title.

💡 Summary

Add more details and examples to the Parameters.md page.

Motivation and context

Consider our md page: https://github.com/cisagov/ScubaGoggles/blob/main/docs/usage/Parameters.md. It's almost just the output of scubagoggles gws -h verbatim.

Now consider ScubaGear's equivalent page: https://github.com/cisagov/ScubaGear/blob/main/docs/configuration/parameters.md.

It has so much information that would be helpful for users.

Implementation notes

I recommend the following:

• Structure our page similar to ScubaGear
• Include examples for each parameter
• Include a table for each parameter with the following: Optional, Datatype, and Default. Note that we don't need the "Config File" entry ScubaGear has because literally all the CLI args for ScubaGoggles can be specified in a config file, while that is not the case for ScubaGear.
• Where appropriate, add to the existing descriptions for each parameter with any additional considerations that would be helpful for the users.

Acceptance criteria

• Structure has been updated
• Examples are included for each param
• Tables for each param as described above are included
• Parameter descriptions include additional discussion where appropriate

[ahuynhECS]

comment from PR #870; incorporate this description into Parameters.md

"This field is used to assign the local file path to a YAML formatted configuration file to be run with ScubaGoggles. Configuration file fields can be used in place of command-line parameters. Additional parameters and variables not available on the command line can also be included in the file that will be provided to the tool for use in specific tests.
config: [YAML-config-file]"

[FollyBeachGurl]

Keeping in the backlog for now - team will revisit for S3 planning.