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

Uniform command descriptions' format #57

Merged
merged 9 commits into from
Feb 5, 2024
2 changes: 1 addition & 1 deletion docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ stackit [flags]

* [stackit auth](./stackit_auth.md) - Provides authentication functionality
* [stackit config](./stackit_config.md) - CLI configuration options
* [stackit curl](./stackit_curl.md) - Execute an authenticated HTTP request to an endpoint
* [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ stackit auth [flags]
### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit auth activate-service-account](./stackit_auth_activate-service-account.md) - Activate service account authentication
* [stackit auth login](./stackit_auth_login.md) - Login to the STACKIT CLI
* [stackit auth activate-service-account](./stackit_auth_activate-service-account.md) - Authenticates using a service account
* [stackit auth login](./stackit_auth_login.md) - Logs in to the STACKIT CLI

4 changes: 2 additions & 2 deletions docs/stackit_auth_activate-service-account.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit auth activate-service-account

Activate service account authentication
Authenticates using a service account

### Synopsis

Activate authentication using service account credentials.
Authenticates to the CLI using service account credentials.
Subsequent commands will be authenticated using the service account credentials provided.
For more details on how to configure your service account, check our Authentication guide at https://github.com/stackitcloud/stackit-cli/blob/main/AUTHENTICATION.md.

Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_auth_login.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit auth login

Login to the STACKIT CLI
Logs in to the STACKIT CLI

### Synopsis

Login to the STACKIT CLI.
Logs in to the STACKIT CLI using a user account.

```
stackit auth login [flags]
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ stackit config [flags]
### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit config list](./stackit_config_list.md) - List the current CLI configuration values
* [stackit config set](./stackit_config_set.md) - Set CLI configuration options
* [stackit config unset](./stackit_config_unset.md) - Unset CLI configuration options
* [stackit config list](./stackit_config_list.md) - Lists the current CLI configuration values
* [stackit config set](./stackit_config_set.md) - Sets CLI configuration options
* [stackit config unset](./stackit_config_unset.md) - Unsets CLI configuration options

4 changes: 2 additions & 2 deletions docs/stackit_config_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit config list

List the current CLI configuration values
Lists the current CLI configuration values

### Synopsis

List the current CLI configuration values.
Lists the current CLI configuration values.

```
stackit config list [flags]
Expand Down
8 changes: 4 additions & 4 deletions docs/stackit_config_set.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## stackit config set

Set CLI configuration options
Sets CLI configuration options

### Synopsis

Set CLI configuration options.
All of the configuration options can be set using an environment variable, which takes precedence over what is configured.
Sets CLI configuration options.
All of the configuration options can be set using an environment variable, which takes precedence over what is configured.
The environment variable is the name of the flag, with underscores ("_") instead of dashes ("-") and the "STACKIT" prefix.
Example: to set the project ID you can set the environment variable STACKIT_PROJECT_ID
Example: to set the project ID you can set the environment variable STACKIT_PROJECT_ID.

```
stackit config set [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_config_unset.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit config unset

Unset CLI configuration options
Unsets CLI configuration options

### Synopsis

Unset CLI configuration options.
Unsets CLI configuration options.

```
stackit config unset [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_curl.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit curl

Execute an authenticated HTTP request to an endpoint
Executes an authenticated HTTP request to an endpoint

### Synopsis

Execute an HTTP request to an endpoint, using the authentication provided by the CLI.
Executes an HTTP request to an endpoint, using the authentication provided by the CLI.

```
stackit curl URL [flags]
Expand Down
8 changes: 4 additions & 4 deletions docs/stackit_dns_record-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ stackit dns record-set [flags]
### SEE ALSO

* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit dns record-set create](./stackit_dns_record-set_create.md) - Create a DNS record set
* [stackit dns record-set delete](./stackit_dns_record-set_delete.md) - Delete a DNS record set
* [stackit dns record-set describe](./stackit_dns_record-set_describe.md) - Get details of a DNS record set
* [stackit dns record-set create](./stackit_dns_record-set_create.md) - Creates a DNS record set
* [stackit dns record-set delete](./stackit_dns_record-set_delete.md) - Deletes a DNS record set
* [stackit dns record-set describe](./stackit_dns_record-set_describe.md) - Shows details of a DNS record set
* [stackit dns record-set list](./stackit_dns_record-set_list.md) - List DNS record sets
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Update a DNS record set
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Updates a DNS record set

4 changes: 2 additions & 2 deletions docs/stackit_dns_record-set_create.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns record-set create

Create a DNS record set
Creates a DNS record set

### Synopsis

Create a DNS record set.
Creates a DNS record set.

```
stackit dns record-set create [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_record-set_delete.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns record-set delete

Delete a DNS record set
Deletes a DNS record set

### Synopsis

Delete a DNS record set.
Deletes a DNS record set.

```
stackit dns record-set delete RECORD_SET_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_record-set_describe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns record-set describe

Get details of a DNS record set
Shows details of a DNS record set

### Synopsis

Get details of a DNS record set.
Shows details of a DNS record set.

```
stackit dns record-set describe RECORD_SET_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_record-set_update.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns record-set update

Update a DNS record set
Updates a DNS record set

### Synopsis

Update a DNS record set. Performs a partial update, i.e., fields not provided are kept unchanged.
Updates a DNS record set.

```
stackit dns record-set update RECORD_SET_ID [flags]
Expand Down
8 changes: 4 additions & 4 deletions docs/stackit_dns_zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ stackit dns zone [flags]
### SEE ALSO

* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit dns zone create](./stackit_dns_zone_create.md) - Create a DNS zone
* [stackit dns zone delete](./stackit_dns_zone_delete.md) - Delete a DNS zone
* [stackit dns zone describe](./stackit_dns_zone_describe.md) - Get details of a DNS zone
* [stackit dns zone create](./stackit_dns_zone_create.md) - Creates a DNS zone
* [stackit dns zone delete](./stackit_dns_zone_delete.md) - Deletes a DNS zone
* [stackit dns zone describe](./stackit_dns_zone_describe.md) - Shows details of a DNS zone
* [stackit dns zone list](./stackit_dns_zone_list.md) - List DNS zones
* [stackit dns zone update](./stackit_dns_zone_update.md) - Update a DNS zone
* [stackit dns zone update](./stackit_dns_zone_update.md) - Updates a DNS zone

4 changes: 2 additions & 2 deletions docs/stackit_dns_zone_create.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns zone create

Create a DNS zone
Creates a DNS zone

### Synopsis

Create a DNS zone.
Creates a DNS zone.

```
stackit dns zone create [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_zone_delete.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns zone delete

Delete a DNS zone
Deletes a DNS zone

### Synopsis

Delete a DNS zone.
Deletes a DNS zone.

```
stackit dns zone delete ZONE_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_zone_describe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns zone describe

Get details of a DNS zone
Shows details of a DNS zone

### Synopsis

Get details of a DNS zone.
Shows details of a DNS zone.

```
stackit dns zone describe ZONE_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_dns_zone_update.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns zone update

Update a DNS zone
Updates a DNS zone

### Synopsis

Update a DNS zone. Performs a partial update, i.e., fields not provided are kept unchanged.
Updates a DNS zone.

```
stackit dns zone update ZONE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ stackit mongodbflex [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit mongodbflex instance](./stackit_mongodbflex_instance.md) - Provides functionality for MongoDB Flex instances
* [stackit mongodbflex options](./stackit_mongodbflex_options.md) - List MongoDB Flex options
* [stackit mongodbflex options](./stackit_mongodbflex_options.md) - Lists MongoDB Flex options
* [stackit mongodbflex user](./stackit_mongodbflex_user.md) - Provides functionality for MongoDB Flex users

10 changes: 5 additions & 5 deletions docs/stackit_mongodbflex_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ stackit mongodbflex instance [flags]
### SEE ALSO

* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit mongodbflex instance create](./stackit_mongodbflex_instance_create.md) - Create a MongoDB Flex instance
* [stackit mongodbflex instance delete](./stackit_mongodbflex_instance_delete.md) - Delete a MongoDB Flex instance
* [stackit mongodbflex instance describe](./stackit_mongodbflex_instance_describe.md) - Get details of a MongoDB Flex instance
* [stackit mongodbflex instance list](./stackit_mongodbflex_instance_list.md) - List all MongoDB Flex instances
* [stackit mongodbflex instance update](./stackit_mongodbflex_instance_update.md) - Update a MongoDB Flex instance
* [stackit mongodbflex instance create](./stackit_mongodbflex_instance_create.md) - Creates a MongoDB Flex instance
* [stackit mongodbflex instance delete](./stackit_mongodbflex_instance_delete.md) - Deletes a MongoDB Flex instance
* [stackit mongodbflex instance describe](./stackit_mongodbflex_instance_describe.md) - Shows details of a MongoDB Flex instance
* [stackit mongodbflex instance list](./stackit_mongodbflex_instance_list.md) - Lists all MongoDB Flex instances
* [stackit mongodbflex instance update](./stackit_mongodbflex_instance_update.md) - Updates a MongoDB Flex instance

4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_instance_create.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex instance create

Create a MongoDB Flex instance
Creates a MongoDB Flex instance

### Synopsis

Create a MongoDB Flex instance.
Creates a MongoDB Flex instance.

```
stackit mongodbflex instance create [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_instance_delete.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex instance delete

Delete a MongoDB Flex instance
Deletes a MongoDB Flex instance

### Synopsis

Delete a MongoDB Flex instance.
Deletes a MongoDB Flex instance.

```
stackit mongodbflex instance delete INSTANCE_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_instance_describe.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex instance describe

Get details of a MongoDB Flex instance
Shows details of a MongoDB Flex instance

### Synopsis

Get details of a MongoDB Flex instance.
Shows details of a MongoDB Flex instance.

```
stackit mongodbflex instance describe INSTANCE_ID [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_instance_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex instance list

List all MongoDB Flex instances
Lists all MongoDB Flex instances

### Synopsis

List all MongoDB Flex instances.
Lists all MongoDB Flex instances.

```
stackit mongodbflex instance list [flags]
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_mongodbflex_instance_update.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex instance update

Update a MongoDB Flex instance
Updates a MongoDB Flex instance

### Synopsis

Update a MongoDB Flex instance.
Updates a MongoDB Flex instance.

```
stackit mongodbflex instance update INSTANCE_ID [flags]
Expand All @@ -23,7 +23,7 @@ stackit mongodbflex instance update INSTANCE_ID [flags]
### Options

```
--acl strings List of IP networks in CIDR notation which are allowed to access this instance (default [])
--acl strings Lists of IP networks in CIDR notation which are allowed to access this instance (default [])
--backup-schedule string Backup schedule
--cpu int Number of CPUs
--flavor-id string ID of the flavor
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_options.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex options

List MongoDB Flex options
Lists MongoDB Flex options

### Synopsis

List MongoDB Flex options (flavors, versions and storages for a given flavor)
Lists MongoDB Flex options (flavors, versions and storages for a given flavor)
Pass one or more flags to filter what categories are shown.

```
Expand Down
12 changes: 6 additions & 6 deletions docs/stackit_mongodbflex_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ stackit mongodbflex user [flags]
### SEE ALSO

* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit mongodbflex user create](./stackit_mongodbflex_user_create.md) - Create a MongoDB Flex user
* [stackit mongodbflex user delete](./stackit_mongodbflex_user_delete.md) - Delete a MongoDB Flex user
* [stackit mongodbflex user describe](./stackit_mongodbflex_user_describe.md) - Get details of a MongoDB Flex user
* [stackit mongodbflex user list](./stackit_mongodbflex_user_list.md) - List all MongoDB Flex users of an instance
* [stackit mongodbflex user reset-password](./stackit_mongodbflex_user_reset-password.md) - Reset the password of a MongoDB Flex user
* [stackit mongodbflex user update](./stackit_mongodbflex_user_update.md) - Update a MongoDB Flex user
* [stackit mongodbflex user create](./stackit_mongodbflex_user_create.md) - Creates a MongoDB Flex user
* [stackit mongodbflex user delete](./stackit_mongodbflex_user_delete.md) - Deletes a MongoDB Flex user
* [stackit mongodbflex user describe](./stackit_mongodbflex_user_describe.md) - Shows details of a MongoDB Flex user
* [stackit mongodbflex user list](./stackit_mongodbflex_user_list.md) - Lists all MongoDB Flex users of an instance
* [stackit mongodbflex user reset-password](./stackit_mongodbflex_user_reset-password.md) - Resets the password of a MongoDB Flex user
* [stackit mongodbflex user update](./stackit_mongodbflex_user_update.md) - Updates a MongoDB Flex user

4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_user_create.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex user create

Create a MongoDB Flex user
Creates a MongoDB Flex user

### Synopsis

Create a MongoDB Flex user.
Creates a MongoDB Flex user.
The password is only visible upon creation and cannot be retrieved later.
Alternatively, you can reset the password and access the new one by running:
$ stackit mongodbflex user reset-password --instance-id <INSTANCE_ID> --user-id <USER_ID>
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_mongodbflex_user_delete.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit mongodbflex user delete

Delete a MongoDB Flex user
Deletes a MongoDB Flex user

### Synopsis

Delete a MongoDB Flex user by ID. You can get the IDs of users for an instance by running:
Deletes a MongoDB Flex user by ID. You can get the IDs of users for an instance by running:
$ stackit mongodbflex user list --instance-id <INSTANCE_ID>

```
Expand Down
Loading
Loading