Skip to content

Commit 4897784

Browse files
joaopalethcsa73
joaopalet
and
hcsa73
authored
Uniform command descriptions' format (#57)
* Uniform all command descriptions * Generate updated docs * Adjustments after review * All command descriptions use descriptive form * Adjust missing descriptions * Update internal/cmd/mongodbflex/user/reset-password/reset_password.go Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com> * Update internal/cmd/project/member/remove/remove.go Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com> * Update internal/cmd/organization/member/remove/remove.go Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com> * Update docs --------- Co-authored-by: Henrique Santos <118177985+hcsa73@users.noreply.github.com>
1 parent 42723d0 commit 4897784

File tree

186 files changed

+391
-386
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

186 files changed

+391
-386
lines changed

‎docs/stackit.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ stackit [flags]
2727

2828
* [stackit auth](./stackit_auth.md) - Provides authentication functionality
2929
* [stackit config](./stackit_config.md) - CLI configuration options
30-
* [stackit curl](./stackit_curl.md) - Execute an authenticated HTTP request to an endpoint
30+
* [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint
3131
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
3232
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
3333
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch

‎docs/stackit_auth.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Provides authentication functionality
44

55
### Synopsis
66

7-
Provides authentication functionality
7+
Provides authentication functionality.
88

99
```
1010
stackit auth [flags]
@@ -28,6 +28,6 @@ stackit auth [flags]
2828
### SEE ALSO
2929

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

‎docs/stackit_auth_activate-service-account.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit auth activate-service-account
22

3-
Activate service account authentication
3+
Authenticates using a service account
44

55
### Synopsis
66

7-
Activate authentication using service account credentials.
7+
Authenticates to the CLI using service account credentials.
88
Subsequent commands will be authenticated using the service account credentials provided.
99
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.
1010

‎docs/stackit_auth_login.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit auth login
22

3-
Login to the STACKIT CLI
3+
Logs in to the STACKIT CLI
44

55
### Synopsis
66

7-
Login to the STACKIT CLI
7+
Logs in to the STACKIT CLI using a user account.
88

99
```
1010
stackit auth login [flags]

‎docs/stackit_config.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ CLI configuration options
44

55
### Synopsis
66

7-
CLI configuration options
7+
CLI configuration options.
88

99
```
1010
stackit config [flags]
@@ -28,7 +28,7 @@ stackit config [flags]
2828
### SEE ALSO
2929

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

‎docs/stackit_config_list.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit config list
22

3-
List the current CLI configuration values
3+
Lists the current CLI configuration values
44

55
### Synopsis
66

7-
List the current CLI configuration values
7+
Lists the current CLI configuration values.
88

99
```
1010
stackit config list [flags]

‎docs/stackit_config_set.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
## stackit config set
22

3-
Set CLI configuration options
3+
Sets CLI configuration options
44

55
### Synopsis
66

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

1212
```
1313
stackit config set [flags]

‎docs/stackit_config_unset.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit config unset
22

3-
Unset CLI configuration options
3+
Unsets CLI configuration options
44

55
### Synopsis
66

7-
Unset CLI configuration options
7+
Unsets CLI configuration options.
88

99
```
1010
stackit config unset [flags]

‎docs/stackit_curl.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## stackit curl
22

3-
Execute an authenticated HTTP request to an endpoint
3+
Executes an authenticated HTTP request to an endpoint
44

55
### Synopsis
66

7-
Execute an HTTP request to an endpoint, using the authentication provided by the CLI
7+
Executes an HTTP request to an endpoint, using the authentication provided by the CLI.
88

99
```
1010
stackit curl URL [flags]

‎docs/stackit_dns.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Provides functionality for DNS
44

55
### Synopsis
66

7-
Provides functionality for DNS
7+
Provides functionality for DNS.
88

99
```
1010
stackit dns [flags]

0 commit comments

Comments
 (0)