Skip to content

exo*: add pages #16405

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

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

Conversation

davidlazch
Copy link

  • 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):

@github-actions github-actions bot added mass changes Changes that affect multiple pages. 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 May 7, 2025
@tldr-bot
Copy link

tldr-bot commented May 7, 2025

The build for this PR failed with the following error(s):

pages/common/exo-dbaas.md:
Error: Parse error on line 4:
...om/community/dbaas/>- List available D
-----------------------^
Expecting 'END_INFORMATION_LINK_URL', got 'NEWLINE'
pages/common/exo-dbaas.md:4: TLDR011 Page never contains more than a single empty line
pages/common/exo-iam.md:
Error: Parse error on line 4:
....com/community/iam/>- List all of the 
-----------------------^
Expecting 'END_INFORMATION_LINK_URL', got 'NEWLINE'
pages/common/exo-iam.md:4: TLDR011 Page never contains more than a single empty line
pages/common/exo-storage.md:
Error: Parse error on line 4:
.../community/storage/>- Create a new SOS
-----------------------^
Expecting 'END_INFORMATION_LINK_URL', got 'NEWLINE'
pages/common/exo-storage.md:4: TLDR011 Page never contains more than a single empty line

Please fix the error(s) and push again.

@Managor Managor changed the title exo*: Add page and alias pages exo*: add pages May 8, 2025
@Managor
Copy link
Collaborator

Managor commented May 8, 2025

Not sure what you meant by alias pages.


- Create a Debian based Compute instance with a disk size of 10GB:

`exo compute instance create --disk-size 10 {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute instance create --disk-size 10 {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`
`exo compute instance create --disk-size {{10}} {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's explicitly stated in the description that the command will create a 10 GB disk so I don't see a placeholder as necessary.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should standardize this. #16411

Copy link
Member

Choose a reason for hiding this comment

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

Given that most software usually has there own scheme for inputting size e.g.

{{size}}{{unit}}

or like this one seemingly

{{size_in_gigabytes}}

and so on, its probably not worth the annoyance of it, there are just edge cases

(also p.s. could probably change {{10}} to be {{size_in_gigabytes}} albeit verbose)

Copy link
Author

Choose a reason for hiding this comment

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

I've marked the disk sizes as placeholders everywhere as I can see that there could be confusion behind this.

Copy link
Member

@CleanMachine1 CleanMachine1 left a comment

Choose a reason for hiding this comment

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

Great PR!

@davidlazch
Copy link
Author

Not sure what you meant by alias pages.

Found it a bit unclear for the naming convention when there are mass changes for a single command along with its sub commands.

In the templates, as I've understood, if its a sub command of a command its an alias page:

  • For a new page addition: ls: add page, docker-container-rm: add alias page

@sebastiaanspeck
Copy link
Member

sebastiaanspeck commented May 8, 2025

Not sure what you meant by alias pages.

Found it a bit unclear for the naming convention when there are mass changes for a single command along with its sub commands.

In the templates, as I've understood, if its a sub command of a command its an alias page:

  • For a new page addition: ls: add page, docker-container-rm: add alias page

An alias page is a page like this: https://github.com/tldr-pages/tldr/blob/main/pages/common/docker-container-rm.md?plain=1. It tells the user it should look to docker rm. For a subcommand (like docker rm) the title would be docker rm: add page. Hope this clarifies things

@Managor
Copy link
Collaborator

Managor commented May 8, 2025

Correction: docker-rm: add page The title reflects the filename.

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

Please replace all {{<digits}} with <digits> if the exact same number is mentioned in the description of the example


- Create a 20GB Block Storage Volume:

`exo compute block-storage create {{volume_name}} --size {{20}} {{[-z|--zone]}} {{zone}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute block-storage create {{volume_name}} --size {{20}} {{[-z|--zone]}} {{zone}}`
`exo compute block-storage create {{volume_name}} --size 20 {{[-z|--zone]}} {{zone}}`


- Update an existing Block Storage Volume with a new name and a new volume size of 30GB:

`exo compute block-storage update {{volume_name|id}} --size {{30}} --name {{new_name}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute block-storage update {{volume_name|id}} --size {{30}} --name {{new_name}}`
`exo compute block-storage update {{volume_name|id}} --size 30 --name {{new_name}}`


- Create a Debian based Compute instance with a disk size of 10GB:

`exo compute instance create --disk-size {{10}} {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute instance create --disk-size {{10}} {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`
`exo compute instance create --disk-size 10 {{instance_name}} {{[-z|--zone]}} {{zone}} --template '{{Linux Debian 12 (Bookworm) 64-bit}}'`


- Resize the disk size of a Compute instance to 20GB:

`exo compute instance resize-disk {{instance_name|id}} {{20}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute instance resize-disk {{instance_name|id}} {{20}}`
`exo compute instance resize-disk {{instance_name|id}} 20`


- Generate a Kubernetes kubeconfig file for an SKS cluster that expires in 1800 seconds:

`exo compute sks kubeconfig {{cluster_name|id}} {{user}} --ttl {{1800}} {{[-z|--zone]}} {{zone}}`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`exo compute sks kubeconfig {{cluster_name|id}} {{user}} --ttl {{1800}} {{[-z|--zone]}} {{zone}}`
`exo compute sks kubeconfig {{cluster_name|id}} {{user}} --ttl 1800 {{[-z|--zone]}} {{zone}}`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mass changes Changes that affect multiple pages. 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.

5 participants