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

Rewrite CLI documentation #493

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Conversation

Callum027
Copy link
Contributor

@Callum027 Callum027 commented Jul 31, 2024

  • Combine the Linux/macOS CLI and Windows CLI documentation pages into a single page, using grouped tabs to allow the user to select their platform and method for installing the packages.
  • Add documentation for installing catalystcloud-client instead of the individual OpenStack client packages.
  • Add documentation for using pipx to install catalystcloud-client.
  • Rewrite the CLI documentation so that it is up to date and correct.
  • Add a list of available commands within the openstack command that are supported by Catalyst Cloud.
  • Update all CLI documentation references to point to the new page, and clean up some of the notes about requiring an OpenRC file to be sourced before proceeding.
  • Update the API endpoint lists to reflect changes in our APIs over time.
  • Other minor documentation improvements aligning with the above changes.

Callum Dickinson added 3 commits July 30, 2024 19:30
* Combine the Linux/macOS CLI and Windows CLI documentation pages into a single page, using grouped tabs to allow the user to select their platform and method for installing the packages.
* Add documentation for installing `catalystcloud-client` instead of the individual OpenStack client packages.
* Add documentation for using `pipx` to install `catalystcloud-client`.
* Rewrite the CLI documentation so that it is up to date and correct.
* Add a list of available commands within the `openstack` command that are supported by Catalyst Cloud.
* Update all CLI documentation references to point to the new page, and clean up some of the notes about requiring an OpenRC file to be sourced before proceeding.
@Callum027 Callum027 requested a review from adrianjarvis July 31, 2024 05:52
@Callum027 Callum027 self-assigned this Jul 31, 2024
@Callum027 Callum027 removed the request for review from adrianjarvis August 1, 2024 04:21
@Callum027 Callum027 marked this pull request as draft August 18, 2024 22:09
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.

1 participant