doctl*: add option placeholders (#16437)

Author: Managor

pages/common/doctl-account.md

@@ -5,11 +5,11 @@
 
 - Display account info:
 
-`doctl account get`
+`doctl account {{[g|get]}}`
 
 - Show the hourly API limit, progress towards it, and when the rate limit resets:
 
-`doctl account ratelimit`
+`doctl account {{[rl|ratelimit]}}`
 
 - Display help:
 

pages/common/doctl-apps.md

@@ -5,32 +5,32 @@
 
 - Create an app:
 
-`doctl apps create`
+`doctl {{[a|apps]}} {{[c|create]}}`
 
 - Create a deployment for a specific app:
 
-`doctl apps create-deployment {{app_id}}`
+`doctl {{[a|apps]}} {{[cd|create-deployment]}} {{app_id}}`
 
 - Delete an app interactively:
 
-`doctl apps delete {{app_id}}`
+`doctl {{[a|apps]}} {{[d|delete]}} {{app_id}}`
 
 - Get an app:
 
-`doctl apps get`
+`doctl {{[a|apps]}} {{[g|get]}}`
 
 - List all apps:
 
-`doctl apps list`
+`doctl {{[a|apps]}} {{[ls|list]}}`
 
 - List all deployments from a specific app:
 
-`doctl apps list-deployments {{app_id}}`
+`doctl {{[a|apps]}} {{[lsd|list-deployments]}} {{app_id}}`
 
 - Get logs from a specific app:
 
-`doctl apps logs {{app_id}}`
+`doctl {{[a|apps]}} {{[l|logs]}} {{app_id}}`
 
 - Update a specific app with a given app spec:
 
-`doctl apps update {{app_id}} --spec {{path/to/spec.yml}}`
+`doctl {{[a|apps]}} {{[u|update]}} {{app_id}} --spec {{path/to/spec.yml}}`

pages/common/doctl-auth.md

@@ -9,7 +9,7 @@
 
 - List authentication contexts (API tokens):
 
-`doctl auth list`
+`doctl auth {{[ls|list]}}`
 
 - Switch contexts (API tokens):
 

pages/common/doctl-balance.md

@@ -5,12 +5,12 @@
 
 - Get balance of the account associated with the current context:
 
-`doctl balance get`
+`doctl balance {{[g|get]}}`
 
 - Get the balance of an account associated with an access token:
 
-`doctl balance get {{[-t|--access-token]}} {{access_token}}`
+`doctl balance {{[g|get]}} {{[-t|--access-token]}} {{access_token}}`
 
 - Get the balance of an account associated with a specified context:
 
-`doctl balance get --context`
+`doctl balance {{[g|get]}} --context`

pages/common/doctl-compute-droplet.md

@@ -5,12 +5,12 @@
 
 - Create a droplet:
 
-`doctl compute droplet create --region {{region}} --image {{os_image}} --size {{vps_type}} {{droplet_name}}`
+`doctl compute {{[d|droplet]}} {{[c|create]}} --region {{region}} --image {{os_image}} --size {{vps_type}} {{droplet_name}}`
 
 - Delete a droplet:
 
-`doctl compute droplet delete {{droplet_id|droplet_name}}`
+`doctl compute {{[d|droplet]}} {{[d|delete]}} {{droplet_id|droplet_name}}`
 
 - List droplets:
 
-`doctl compute droplet list`
+`doctl compute {{[d|droplet]}} {{[ls|list]}}`

pages/common/doctl-databases-db.md

@@ -5,20 +5,20 @@
 
 - Run a `doctl databases db` command with an access token:
 
-`doctl databases db {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} db {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve the name of the given database hosted in the given database cluster:
 
-`doctl databases db get {{database_id}} {{database_name}}`
+`doctl {{[d|databases]}} db {{[g|get]}} {{database_id}} {{database_name}}`
 
 - List existing databases hosted within a given database cluster:
 
-`doctl databases db list {{database_id}}`
+`doctl {{[d|databases]}} db {{[ls|list]}} {{database_id}}`
 
 - Create a database with the given name in the given database cluster:
 
-`doctl databases db create {{database_id}} {{database_name}}`
+`doctl {{[d|databases]}} db {{[c|create]}} {{database_id}} {{database_name}}`
 
 - Delete the database with the given name in the given database cluster:
 
-`doctl databases db delete {{database_id}} {{database_name}}`
+`doctl {{[d|databases]}} db {{[rm|delete]}} {{database_id}} {{database_name}}`

pages/common/doctl-databases-firewalls.md

@@ -5,16 +5,16 @@
 
 - Run a `doctl databases firewalls` command with an access token:
 
-`doctl databases firewalls {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[fw|firewalls]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve a list of firewall rules for a given database:
 
-`doctl databases firewalls list`
+`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[ls|list]}}`
 
 - Add a database firewall rule to a given database:
 
-`doctl databases firewalls append {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}`
+`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[a|append]}} {{database_id}} --rule {{droplet|k8s|ip_addr|tag|app}}:{{value}}`
 
 - Remove a firewall rule for a given database:
 
-`doctl databases firewalls remove {{database_id}} {{rule_uuid}}`
+`doctl {{[d|databases]}} {{[fw|firewalls]}} {{[rm|remove]}} {{database_id}} {{rule_uuid}}`

pages/common/doctl-databases-maintenance-window.md

@@ -5,12 +5,12 @@
 
 - Run a `doctl databases maintenance-window` command with an access token:
 
-`doctl databases maintenance-window {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve details about a database cluster's maintenance windows:
 
-`doctl databases maintenance-window get {{database_id}}`
+`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{[g|get]}} {{database_id}}`
 
 - Update the maintenance window for a database cluster:
 
-`doctl databases maintenance-window update {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}`
+`doctl {{[d|databases]}} {{[mw|maintenance-window]}} {{[u|update]}} {{database_id}} --day {{day_of_the_week}} --hour {{hour_in_24_hours_format}}`

pages/common/doctl-databases-options.md

@@ -5,20 +5,20 @@
 
 - Run a `doctl databases options` command with an access token:
 
-`doctl databases options {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[o|options]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve a list of the available database engines:
 
-`doctl databases options engines`
+`doctl {{[d|databases]}} {{[o|options]}} {{[eng|engines]}}`
 
 - Retrieve a list of the available regions for a given database engine:
 
-`doctl databases options regions --engine {{pg|mysql|redis|mongodb}}`
+`doctl {{[d|databases]}} {{[o|options]}} {{[r|regions]}} --engine {{pg|mysql|redis|mongodb}}`
 
 - Retrieve a list of the available slugs for a given database engine:
 
-`doctl databases options slugs --engine {{pg|mysql|redis|mongodb}}`
+`doctl {{[d|databases]}} {{[o|options]}} {{[s|slugs]}} --engine {{pg|mysql|redis|mongodb}}`
 
 - Retrieve a list of the available versions for a given database engine:
 
-`doctl databases options versions --engine {{pg|mysql|redis|mongodb}}`
+`doctl {{[d|databases]}} {{[o|options]}} {{[v|versions]}} --engine {{pg|mysql|redis|mongodb}}`

pages/common/doctl-databases-pool.md

@@ -5,20 +5,20 @@
 
 - Run a `doctl databases pool` command with an access token:
 
-`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve information about a database connection pool:
 
-`doctl databases pool get {{database_id}} {{pool_name}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{[g|get]}} {{database_id}} {{pool_name}}`
 
 - List connection pools for a database cluster:
 
-`doctl databases pool list {{database_id}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{[ls|list]}} {{database_id}}`
 
 - Create a connection pool for a database:
 
-`doctl databases pool create {{database_id}} {{pool_name}} --db {{new_pool_name}} --size {{pool_size}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{[c|create]}} {{database_id}} {{pool_name}} --db {{new_pool_name}} --size {{pool_size}}`
 
 - Delete a connection pool for a database:
 
-`doctl databases pool create {{database_id}} {{pool_name}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{[c|create]}} {{database_id}} {{pool_name}}`

pages/common/doctl-databases-replica.md

@@ -5,20 +5,20 @@
 
 - Run a `doctl databases replica` command with an access token:
 
-`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[p|pool]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve information about a read-only database replica:
 
-`doctl databases replica get {{database_id}} {{replica_name}}`
+`doctl {{[d|databases]}} {{[r|replica]}} {{[g|get]}} {{database_id}} {{replica_name}}`
 
 - Retrieve list of read-only database replicas:
 
-`doctl databases replica list {{database_id}}`
+`doctl {{[d|databases]}} {{[r|replica]}} {{[ls|list]}} {{database_id}}`
 
 - Create a read-only database replica:
 
-`doctl databases replica create {{database_id}} {{replica_name}}`
+`doctl {{[d|databases]}} {{[r|replica]}} {{[c|create]}} {{database_id}} {{replica_name}}`
 
 - Delete a read-only database replica:
 
-`doctl databases replica delete {{database_id}} {{replica_name}}`
+`doctl {{[d|databases]}} {{[r|replica]}} {{[rm|delete]}} {{database_id}} {{replica_name}}`

pages/common/doctl-databases-sql-mode.md

@@ -5,12 +5,12 @@
 
 - Run a `doctl databases sql-mode` command with an access token:
 
-`doctl databases sql-mode {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Get a MySQL database cluster's SQL modes:
 
-`doctl databases sql-mode get {{database_id}}`
+`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{[g|get]}} {{database_id}}`
 
 - Overwrite a MySQL database cluster's SQL modes to the specified modes:
 
-`doctl databases sql-mode set {{database_id}} {{sql_mode_1 sql_mode_2 ...}}`
+`doctl {{[d|databases]}} {{[sm|sql-mode]}} {{[s|set]}} {{database_id}} {{sql_mode_1 sql_mode_2 ...}}`

pages/common/doctl-databases-user.md

@@ -5,28 +5,28 @@
 
 - Run a `doctl databases user` command with an access token:
 
-`doctl databases user {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Retrieve details about a database user:
 
-`doctl databases user get {{database_id}} {{user_name}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[g|get]}} {{database_id}} {{user_name}}`
 
 - Retrieve a list of database users for a given database:
 
-`doctl databases user list {{database_id}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[ls|list]}} {{database_id}}`
 
 - Reset the auth password for a given user:
 
-`doctl databases user reset {{database id}} {{user_name}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[rs|reset]}} {{database id}} {{user_name}}`
 
 - Reset the MySQL auth plugn for a given user:
 
-`doctl databases user reset {{database_id}} {{user_name}} {{caching_sha2_password|mysql_native_password}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[rs|reset]}} {{database_id}} {{user_name}} {{caching_sha2_password|mysql_native_password}}`
 
 - Create a user in the given database with a given username:
 
-`doctl databases user create {{database_id}} {{user_name}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[c|create]}} {{database_id}} {{user_name}}`
 
 - Delete a user from the given database with the given username:
 
-`doctl databases user delete {{database_id}} {{user_name}}`
+`doctl {{[d|databases]}} {{[u|user]}} {{[rm|delete]}} {{database_id}} {{user_name}}`

pages/common/doctl-databases.md

@@ -5,20 +5,20 @@
 
 - Run a `doctl databases` command with an access token:
 
-`doctl databases {{command}} {{[-t|--access-token]}} {{access_token}}`
+`doctl {{[d|databases]}} {{command}} {{[-t|--access-token]}} {{access_token}}`
 
 - Get details for a database cluster:
 
-`doctl databases get`
+`doctl {{[d|databases]}} {{[g|get]}}`
 
 - List your database clusters:
 
-`doctl databases list`
+`doctl {{[d|databases]}} {{[ls|list]}}`
 
 - Create a database cluster:
 
-`doctl databases create {{database_name}}`
+`doctl {{[d|databases]}} {{[c|create]}} {{database_name}}`
 
 - Delete a cluster:
 
-`doctl databases delete {{database_id}}`
+`doctl {{[d|databases]}} {{[rm|delete]}} {{database_id}}`

pages/common/doctl-kubernetes-cluster.md

@@ -5,24 +5,24 @@
 
 - Create a Kubernetes cluster:
 
-`doctl kubernetes cluster create --count {{3}} --region {{nyc1}} --size {{s-1vcpu-2gb}} --version {{latest}} {{cluster_name}}`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[c|create]}} --count {{3}} --region {{nyc1}} --size {{s-1vcpu-2gb}} --version {{latest}} {{cluster_name}}`
 
 - List all Kubernetes clusters:
 
-`doctl kubernetes cluster list`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[ls|list]}}`
 
 - Fetch and save the kubeconfig:
 
-`doctl kubernetes cluster kubeconfig save {{cluster_name}}`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[cfg|kubeconfig]}} {{[s|save]}} {{cluster_name}}`
 
 - Check for available upgrades:
 
-`doctl kubernetes cluster get-upgrades {{cluster_name}}`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[gu|get-upgrades]}} {{cluster_name}}`
 
 - Upgrade a cluster to a new Kubernetes version:
 
-`doctl kubernetes cluster upgrade {{cluster_name}}`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} upgrade {{cluster_name}}`
 
 - Delete a cluster:
 
-`doctl kubernetes cluster delete {{cluster_name}}`
+`doctl {{[k|kubernetes]}} {{[c|cluster]}} {{[d|delete]}} {{cluster_name}}`

pages/common/doctl-kubernetes-options.md

@@ -5,12 +5,12 @@
 
 - List regions that support Kubernetes clusters:
 
-`doctl kubernetes options regions`
+`doctl {{[k|kubernetes]}} {{[o|options]}} {{[r|regions]}}`
 
 - List machine sizes that can be used in a Kubernetes cluster:
 
-`doctl kubernetes options sizes`
+`doctl {{[k|kubernetes]}} {{[o|options]}} {{[s|sizes]}}`
 
 - List Kubernetes versions that can be used with DigitalOcean clusters:
 
-`doctl kubernetes options versions`
+`doctl {{[k|kubernetes]}} {{[o|options]}} {{[v|versions]}}`

pages/common/doctl-serverless.md

@@ -5,16 +5,16 @@
 
 - Connect local serverless support to a functions namespace:
 
-`doctl serverless connect`
+`doctl {{[sls|serverless]}} connect`
 
 - Deploy a functions project to your functions namespace:
 
-`doctl serverless deploy`
+`doctl {{[sls|serverless]}} deploy`
 
 - Obtain metadata of a functions project:
 
-`doctl serverless get-metadata`
+`doctl {{[sls|serverless]}} get-metadata`
 
 - Provide information about serverless support:
 
-`doctl serverless status`
+`doctl {{[sls|serverless]}} status`