-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
base: main
Are you sure you want to change the base?
exo*: add pages #16405
Conversation
The build for this PR failed with the following error(s):
Please fix the error(s) and push again. |
Not sure what you meant by alias pages. |
pages/common/exo-compute-instance.md
Outdated
|
||
- 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}}'` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}'` |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR!
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:
|
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 |
Correction: |
There was a problem hiding this 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}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}'` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`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}}` |
common
,linux
,osx
,windows
,sunos
,android
, etc.