docs icon indicating copy to clipboard operation
docs copied to clipboard

Add output references for CLI commands that list output

Open lzdanski opened this issue 2 years ago • 2 comments

Issue Type

Missing content for an existing feature

Links to Affected Docs

  • [x] https://docs.astronomer.io/astro/cli/astro-deployment-airflow-variable-list
  • [x] https://docs.astronomer.io/astro/cli/astro-deployment-connection-list
  • [x] https://docs.astronomer.io/astro/cli/astro-deployment-pool-list
  • [x] https://docs.astronomer.io/astro/cli/astro-organization-team-list
  • [ ] https://docs.astronomer.io/astro/cli/astro-deployment-variable-list
  • [ ] https://docs.astronomer.io/astro/cli/astro-organization-token-list
  • [ ] https://docs.astronomer.io/astro/cli/astro-workspace-token-list

Completed

https://github.com/astronomer/docs/pull/2842

  • [x] https://docs.astronomer.io/astro/cli/astro-context-list
  • [x] https://docs.astronomer.io/astro/cli/astro-deployment-list
  • [x] https://docs.astronomer.io/astro/cli/astro-organization-list
  • [x] https://docs.astronomer.io/astro/cli/astro-organization-user-list
  • [x] https://docs.astronomer.io/astro/cli/astro-workspace-list
  • [x] https://docs.astronomer.io/astro/cli/astro-workspace-user-list

The Issue or Context

These commands list outputs with information that can be used for scripting other processes. It's beneficial to users to be refer to a table that has a description and definition of these outputs and the data type of each.

Fix or Proposed Change

Add a section Output to each page that is similar to https://docs.astronomer.io/astro/cli/astro-workspace-team-list#output

Additional Notes

  • https://github.com/astronomer/docs/issues/2750

Required Reviewers

No response

lzdanski avatar Sep 11 '23 16:09 lzdanski