score-spec / docs

Docs for Score Specification.
https://docs.score.dev/docs/
Apache License 2.0
6 stars 12 forks source link

[feature request] Document the `score-* resources` commands in CLI docs #125

Open mathieu-benoit opened 1 month ago

mathieu-benoit commented 1 month ago

On the pages below, we are missing the score-* resources commands in CLI docs

For reference: score-compose --help:

Available Commands:
  check-version Assert that the version of score-compose matches the required constraint
  completion    Generate the autocompletion script for the specified shell
  generate      Convert one or more Score files into a Docker compose manifest
  help          Help about any command
  init          Initialise a new score-compose project with local state directory and score file
  resources     Subcommands related to provisioned resources

score-compose resources --help:

Subcommands related to provisioned resources

Usage:
  score-compose resources [command]

Available Commands:
  get-outputs Return the resource outputs
  list        List the resource uids

Flags:
  -h, --help   help for resources

Global Flags:
      --quiet           Mute any logging output
  -v, --verbose count   Increase log verbosity and detail by specifying this flag one or more times

Use "score-compose resources [command] --help" for more information about a command.
JP-sDEV commented 1 month ago

Hi could I take on this documentation task?

mathieu-benoit commented 1 month ago

Yes please, thanks!