Review input variable descriptions

vburckhardt commented 5 months ago

Some confusions - not an exhaustive list - may be worth a review with @SirSpidey :

Indicate when an input refers to an existing resource. Prefix the variable name with existing_ if possible. This will help distinguish between resource created by the DA and existing resources that are prereq to run the DA
Indicate where some variables are related - eg: some variables enable to take either the crn, id, or guid.
Avoid some acronyms that are not obvious to most users - eg: PAT.
...

By submitting this issue, you agree to follow our Code of Conduct

huayuenh commented 3 months ago

padraic-edwards commented 1 month ago

Will be addressing this in an upcoming release, reducing the number of optional properties, grouping related variables and improving descriptions.

terraform-ibm-modules / terraform-ibm-devsecops-alm