docs(release): add synopsis and examples to release commands
Description
Resolves the release family findings from the style guide audit in
#8263 (closed).
- Adds
Long(Synopsis) fields to thereleaseparent command and therelease listsubcommand, and adds an Examples section torelease list. - Adds a Synopsis note to
release createexplaining that the--publish-to-catalogflag is experimental and not ready for production use. - Fixes the
release upload --assets-linksflag description so the trailing period falls outside the inline code span.
Each Synopsis is additive and does not repeat the Short description.
The release parent command's help test was updated to match the
rendered Synopsis (Cobra renders Long in place of Short once Long
is set).
Commands updated:
releaserelease listrelease createrelease upload
Content follows the documentation style guide and the GitLab CLI (glab) documentation style guide.
Related issues and merge requests
Documentation
If this MR adds or updates CLI command documentation, follow the conventions in the
GitLab CLI (glab) documentation style guide,
run make gen-docs, and commit the updated files in docs/source/.