What would you like to be added:
A lot of yardstick commands accept something like DESCRIPTION or ID, but it's not obvious what this string is. Example:
❯ yardstick label explore --help
Usage: yardstick label explore [OPTIONS] DESCRIPTION
interact with an label results for a single image scan
Options:
-y, --year-max-limit TEXT max year to include in comparison (relative
to the CVE ID)
-c, --derive-year-from-cve-only
only use the CVE ID year-max-limit
--help Show this message and exit.
In this case, DESCRIPTION is really a result set UUID obtained by running yardstick result list and looking for the image+tool combo the user is interested in. But nothing about DESCRIPTION makes it obvious what to pass in our how to get it.
Why is this needed:
The use of generic parameter names like ID and DESCRIPTION in the docs makes it very hard to come up to speed in yardstick.
Additional context:
What would you like to be added:
A lot of yardstick commands accept something like
DESCRIPTIONorID, but it's not obvious what this string is. Example:In this case,
DESCRIPTIONis really a result set UUID obtained by runningyardstick result listand looking for the image+tool combo the user is interested in. But nothing aboutDESCRIPTIONmakes it obvious what to pass in our how to get it.Why is this needed:
The use of generic parameter names like
IDandDESCRIPTIONin the docs makes it very hard to come up to speed in yardstick.Additional context: