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_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides authentication functionality

### Synopsis

Provides authentication functionality
Provides authentication functionality.

```
stackit auth [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_auth_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Login to the STACKIT CLI

### Synopsis

Login to the STACKIT CLI
Login to the STACKIT CLI.

```
stackit auth login [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ CLI configuration options

### Synopsis

CLI configuration options
CLI configuration options.

```
stackit config [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_config_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List the current CLI configuration values

### Synopsis

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

```
stackit config list [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_config_unset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Unset CLI configuration options

### Synopsis

Unset CLI configuration options
Unset CLI configuration options.

```
stackit config unset [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_curl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Execute an authenticated HTTP request to an endpoint

### Synopsis

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

```
stackit curl URL [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for DNS

### Synopsis

Provides functionality for DNS
Provides functionality for DNS.

```
stackit dns [flags]
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_dns_record-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for DNS record set

### Synopsis

Provides functionality for DNS record set
Provides functionality for DNS record set.

```
stackit dns record-set [flags]
Expand All @@ -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) - Creates a DNS record set
* [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 list](./stackit_dns_record-set_list.md) - List DNS record sets
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Updates a DNS record set
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Update 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

Creates a DNS record set
Create a DNS record set

### Synopsis

Creates a DNS record set
Create a DNS record set.

```
stackit dns record-set create [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns_record-set_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Delete a DNS record set

### Synopsis

Delete a DNS record set
Delete a DNS record set.

```
stackit dns record-set delete RECORD_SET_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns_record-set_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get details of a DNS record set

### Synopsis

Get details of a DNS record set
Get 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

Updates a DNS record set
Update a DNS record set

### Synopsis

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

```
stackit dns record-set update RECORD_SET_ID [flags]
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_dns_zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for DNS zones

### Synopsis

Provides functionality for DNS zones
Provides functionality for DNS zones.

```
stackit dns zone [flags]
Expand All @@ -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) - Creates a DNS zone
* [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 list](./stackit_dns_zone_list.md) - List DNS zones
* [stackit dns zone update](./stackit_dns_zone_update.md) - Updates a DNS zone
* [stackit dns zone update](./stackit_dns_zone_update.md) - Update 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

Creates a DNS zone
Create a DNS zone

### Synopsis

Creates a DNS zone
Create a DNS zone.

```
stackit dns zone create [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns_zone_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Delete a DNS zone

### Synopsis

Delete a DNS zone
Delete a DNS zone.

```
stackit dns zone delete ZONE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns_zone_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get details of a DNS zone

### Synopsis

Get details of a DNS zone
Get 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

Updates a DNS zone
Update a DNS zone

### Synopsis

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

```
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 @@ -4,7 +4,7 @@ Provides functionality for MongoDB Flex

### Synopsis

Provides functionality for MongoDB Flex
Provides functionality for MongoDB Flex.

```
stackit mongodbflex [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for MongoDB Flex instances

### Synopsis

Provides functionality for MongoDB Flex instances
Provides functionality for MongoDB Flex instances.

```
stackit mongodbflex instance [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex_instance_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Delete a MongoDB Flex instance

### Synopsis

Delete a MongoDB Flex instance
Delete a MongoDB Flex instance.

```
stackit mongodbflex instance delete INSTANCE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex_instance_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get details of a MongoDB Flex instance

### Synopsis

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

```
stackit mongodbflex instance describe INSTANCE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex_instance_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List all MongoDB Flex instances

### Synopsis

List all MongoDB Flex instances
List all MongoDB Flex instances.

```
stackit mongodbflex instance list [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_mongodbflex_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for MongoDB Flex users

### Synopsis

Provides functionality for MongoDB Flex users
Provides functionality for MongoDB Flex users.

```
stackit mongodbflex user [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for OpenSearch

### Synopsis

Provides functionality for OpenSearch
Provides functionality for OpenSearch.

```
stackit opensearch [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for OpenSearch credentials

### Synopsis

Provides functionality for OpenSearch credentials
Provides functionality for OpenSearch credentials.

```
stackit opensearch credentials [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_credentials_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Create credentials for an OpenSearch instance

### Synopsis

Create credentials (username and password) for an OpenSearch instance
Create credentials (username and password) for an OpenSearch instance.

```
stackit opensearch credentials create [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_credentials_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Delete credentials of an OpenSearch instance

### Synopsis

Delete credentials of an OpenSearch instance
Delete credentials of an OpenSearch instance.

```
stackit opensearch credentials delete CREDENTIALS_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_credentials_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List all credentials' IDs for an OpenSearch instance

### Synopsis

List all credentials' IDs for an OpenSearch instance
List all credentials' IDs for an OpenSearch instance.

```
stackit opensearch credentials list [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_opensearch_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality for OpenSearch instances

### Synopsis

Provides functionality for OpenSearch instances
Provides functionality for OpenSearch instances.

```
stackit opensearch instance [flags]
Expand Down Expand Up @@ -32,5 +32,5 @@ stackit opensearch instance [flags]
* [stackit opensearch instance delete](./stackit_opensearch_instance_delete.md) - Delete an OpenSearch instance
* [stackit opensearch instance describe](./stackit_opensearch_instance_describe.md) - Get details of an OpenSearch instance
* [stackit opensearch instance list](./stackit_opensearch_instance_list.md) - List all OpenSearch instances
* [stackit opensearch instance update](./stackit_opensearch_instance_update.md) - Updates an OpenSearch instance
* [stackit opensearch instance update](./stackit_opensearch_instance_update.md) - Update an OpenSearch instance

2 changes: 1 addition & 1 deletion docs/stackit_opensearch_instance_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Delete an OpenSearch instance

### Synopsis

Delete an OpenSearch instance
Delete an OpenSearch instance.

```
stackit opensearch instance delete INSTANCE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_instance_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get details of an OpenSearch instance

### Synopsis

Get details of an OpenSearch instance
Get details of an OpenSearch instance.

```
stackit opensearch instance describe INSTANCE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_instance_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List all OpenSearch instances

### Synopsis

List all OpenSearch instances
List all OpenSearch instances.

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

Updates an OpenSearch instance
Update an OpenSearch instance

### Synopsis

Updates an OpenSearch instance
Update an OpenSearch instance.

```
stackit opensearch instance update INSTANCE_ID [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_opensearch_plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ List all OpenSearch service plans

### Synopsis

List all OpenSearch service plans
List all OpenSearch service plans.

```
stackit opensearch plans [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Provides functionality regarding organizations
### Synopsis

Provides functionality regarding organizations.
An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service
An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service.

```
stackit organization [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_organization_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality regarding organization members

### Synopsis

Provides functionality regarding organization members
Provides functionality regarding organization members.

```
stackit organization member [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_organization_member_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Remove a member from an organization.

Remove a member from an organization.
A member is a combination of a subject (user, service account or client) and a role.
The subject is usually email address for users or name in case of clients
The subject is usually email address for users or name in case of clients.

```
stackit organization member remove SUBJECT [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_organization_role.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Provides functionality regarding organization roles

### Synopsis

Provides functionality regarding organization roles
Provides functionality regarding organization roles.

```
stackit organization role [flags]
Expand Down
Loading
Loading