docs: improve glab cli command docs 1

Brendan Lynchrequested to merge
8263-improve-glab-cli-command-docs into main

Description

This merge request improves the documentation and help text for GitLab's command-line tool's CI/CD features. The changes make the documentation more detailed and user-friendly by:

  • Enhanced description*: Added clearer explanations of what each command does, replacing brief one-liners with comprehensive descriptions that explain the purpose and functionality.
  • Better examples**: Expanded the example sections to show multiple ways to use commands, including how to cancel single or multiple pipelines/jobs using different input formats (comma-separated, space-separated in quotes).
  • Improved command syntax: Updated command usage patterns to show that multiple IDs can be passed as arguments, making it clearer how to perform bulk operations.
  • Clearer flag descriptions: Rewrote help text for the --dry-run flag to be more descriptive, explaining that it shows what would be canceled without actually doing it.
  • Added context: Included information about deprecated command aliases and provided guidance on which commands to use instead.

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/.

Merge request reports