Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update config help text #254

Merged
merged 1 commit into from
Mar 27, 2024
Merged

fix: Update config help text #254

merged 1 commit into from
Mar 27, 2024

Conversation

marofke
Copy link
Contributor

@marofke marofke commented Mar 27, 2024

What was the problem/requirement? (What/Why)

Our CLI config help text (i.e. deadline config -h) was missing telemetry opt out information.

What was the solution? (How)

Update the help text (we're just using a big comment block), also made the formatting look better. I chose not to include some other config settings that aren't necessary to show to the user (imo).

What is the impact of this change?

Customers that use the CLI are more aware of their config options.

How was this change tested?

Previous:

deadline config
Usage: deadline config [OPTIONS] COMMAND [ARGS]...

  Manage AWS Deadline Cloud's workstation configuration.

  The available AWS Deadline Cloud settings are:

  defaults.aws_profile_name:     The default AWS profile to use for AWS
  Deadline Cloud commands.

  defaults.farm_id:     The default farm ID to use for job submissions or CLI
  operations.

  defaults.queue_id:     The default queue ID to use for job submissions or
  CLI operations.

  settings.storage_profile_id:     The storage profile that this workstation
  conforms to. It specifies     where shared file systems are mounted, and
  where named job attachments     should go.

  settings.job_history_dir:     The directory in which to create new job
  bundles for     submitting to AWS Deadline Cloud, to produce a history of
  job submissions.

  settings.auto_accept:     Flag to automatically confirm any confirmation
  prompts

  settings.log_level:     Setting to change the log level. Must be one of
  ["ERROR", "WARNING", "INFO", "DEBUG"]

  defaults.job_attachments_file_system:     Setting to determine if
  attachments are copied on to workers before a job executes     or fetched in
  realtime. Must be one of ["COPIED", "VIRTUAL"]

Options:
  -h, --help  Show this message and exit.

Commands:
  get   Gets an AWS Deadline Cloud workstation configuration setting.
  gui   Open the workstation configuration settings GUI.
  set   Sets an AWS Deadline Cloud workstation configuration setting.
  show  Show AWS Deadline Cloud's current workstation configuration...

Now:

deadline config
Usage: deadline config [OPTIONS] COMMAND [ARGS]...

  Manage AWS Deadline Cloud's workstation configuration.

  The available AWS Deadline Cloud settings are:

  defaults.aws_profile_name:

      The default AWS profile to use for AWS Deadline Cloud commands. Set to
      '' to use the default credentials. Other settings are saved with the
      profile.

  defaults.farm_id:

      The default farm ID to use for job submissions or CLI operations.

  defaults.queue_id:

      The default queue ID to use for job submissions or CLI operations.

  settings.storage_profile_id:

      The storage profile that this workstation conforms to. It specifies
      where shared file systems are mounted, and where named job attachments
      should go.

  defaults.job_id:

      The Job ID to use by default. This gets updated by job submission so is
      normally the most recently submitted job.

  settings.job_history_dir:

      The directory in which to create new job bundles for submitting to AWS
      Deadline Cloud, to produce a history of job submissions.

  settings.auto_accept:

      Flag to automatically confirm any confirmation prompts.

  settings.log_level:

      Setting to change the log level. Must be one of ["ERROR", "WARNING",
      "INFO", "DEBUG"]

  defaults.job_attachments_file_system:

      Setting to determine if attachments are copied on to workers before a
      job executes     or fetched in realtime. Must be one of ["COPIED",
      "VIRTUAL"]

  telemetry.opt_out:

      Flag to specify opting out of telemetry data collection.

Options:
  -h, --help  Show this message and exit.

Commands:
  get   Gets an AWS Deadline Cloud workstation configuration setting.
  gui   Open the workstation configuration settings GUI.
  set   Sets an AWS Deadline Cloud workstation configuration setting.
  show  Show AWS Deadline Cloud's current workstation configuration.

Was this change documented?

The change IS the documentation

Is this a breaking change?

No

@marofke marofke requested a review from a team as a code owner March 27, 2024 21:33
Signed-off-by: Caden Marofke <marofke@amazon.com>
@marofke marofke enabled auto-merge (squash) March 27, 2024 21:40
@marofke marofke merged commit 98b14c7 into mainline Mar 27, 2024
18 checks passed
@marofke marofke deleted the marofke/config-help-text branch March 27, 2024 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants