Skip to content

Review each @CliCommand (annotation) to ensure the command specifies “help” (attribute) #17

Open
@gregturn

Description

@gregturn

As suggested by @jxblum:

  • Include a brief summary of the commands actions and expected outcome.
  • Optionally, include a link referring to additional (external) documentation used to supplement the help information with additional details, such as how to respond in a failure case.

“Contextual-based help” will potentially go a long way in adequately documenting the build/release process in order to help guide SD veterans and newcomers, alike, navigate a build and release process across environments.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions