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

openstack-{help, image, server, volume}: add page #15843

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dwalex
Copy link

@dwalex dwalex commented Mar 3, 2025

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@CLAassistant
Copy link

CLAassistant commented Mar 3, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Mar 3, 2025
@MachiavelliII MachiavelliII changed the title Openstack: add pages for subcommands help, image, server, and volume. openstack-help, openstack-image, openstack-server, openstack-volume: add page Mar 3, 2025
@Managor
Copy link
Collaborator

Managor commented Mar 4, 2025

#10885

@Managor Managor changed the title openstack-help, openstack-image, openstack-server, openstack-volume: add page openstack-{help, image, server, volume}: add page Mar 4, 2025
@Managor Managor mentioned this pull request Mar 4, 2025
10 tasks

`openstack --help`

- Description of a particular command:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Description of a particular command:
- Display description of a particular command:


- List available images:

`openstack image list [--public | --private | --community | --shared | --all] [--long]`
Copy link
Collaborator

@Managor Managor Mar 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refer to the style guide on how to format placeholders in tldr pages

https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#placeholder-syntax

Here for example I would disregard all the options and just put openstack image list. If you want to provide an example with the other options, you can create another example. Be explicit. Full documentation is for the man pages.


- Start server(s):

`openstack server start {{instance_id}} [{{instance_id}} ...]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`openstack server start {{instance_id}} [{{instance_id}} ...]`
`openstack server start {{instance_id1 instance_id2 ...}}`

See https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#grouping-placeholders


- Delete image(s):

`openstack image delete {{image_id}} [{{image_id}} ...]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`openstack image delete {{image_id}} [{{image_id}} ...]`
`openstack image delete {{image_id1 image_id2 ...}}`


- Stop server:

`openstack server stop {{instance_id}} [{{instance_id}} ...]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`openstack server stop {{instance_id}} [{{instance_id}} ...]`
`openstack server stop {{instance_id1 instance_id2 ...}}`


- Delete server(s):

`openstack server delete {{instance_id}} [{{instance_id}} ...]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`openstack server delete {{instance_id}} [{{instance_id}} ...]`
`openstack server delete {{instance_id1 instance_id2 ...}}`


- Delete volumes(s):

`openstack volume delete {{volume_id}} [{{volume_id}} ...]`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`openstack volume delete {{volume_id}} [{{volume_id}} ...]`
`openstack volume delete {{volume_id1 volume_id2 ...}}`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants