From d88092f1cde426e500e5238774b4cb941a6835be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88kc=CC=A7e=20Go=CC=88k=20Klingel?= Date: Thu, 23 May 2024 08:36:02 +0200 Subject: [PATCH 1/4] update command descriptions --- docs/stackit.md | 8 ++++---- docs/stackit_auth.md | 4 ++-- docs/stackit_auth_activate-service-account.md | 2 +- docs/stackit_auth_login.md | 2 +- docs/stackit_dns_record-set.md | 2 +- docs/stackit_dns_record-set_list.md | 4 ++-- docs/stackit_dns_zone.md | 2 +- docs/stackit_dns_zone_list.md | 4 ++-- docs/stackit_object-storage.md | 4 ++-- docs/stackit_object-storage_bucket.md | 2 +- docs/stackit_object-storage_credentials-group.md | 2 +- docs/stackit_object-storage_credentials.md | 2 +- docs/stackit_object-storage_disable.md | 2 +- docs/stackit_object-storage_enable.md | 2 +- docs/stackit_organization.md | 8 ++++---- docs/stackit_organization_member.md | 6 +++--- docs/stackit_organization_member_add.md | 2 +- docs/stackit_organization_member_list.md | 2 +- docs/stackit_organization_member_remove.md | 2 +- docs/stackit_organization_role.md | 6 +++--- docs/stackit_organization_role_list.md | 2 +- docs/stackit_project.md | 8 ++++---- docs/stackit_project_create.md | 2 +- docs/stackit_project_delete.md | 2 +- docs/stackit_project_describe.md | 2 +- docs/stackit_project_list.md | 2 +- docs/stackit_project_member.md | 6 +++--- docs/stackit_project_member_add.md | 2 +- docs/stackit_project_member_list.md | 2 +- docs/stackit_project_member_remove.md | 2 +- docs/stackit_project_role.md | 6 +++--- docs/stackit_project_role_list.md | 2 +- docs/stackit_project_update.md | 2 +- docs/stackit_service-account.md | 4 ++-- docs/stackit_service-account_key.md | 4 ++-- docs/stackit_service-account_key_create.md | 2 +- docs/stackit_service-account_key_delete.md | 2 +- docs/stackit_service-account_key_describe.md | 2 +- docs/stackit_service-account_key_list.md | 2 +- docs/stackit_service-account_key_update.md | 2 +- docs/stackit_service-account_token.md | 4 ++-- docs/stackit_service-account_token_create.md | 2 +- docs/stackit_service-account_token_list.md | 2 +- docs/stackit_service-account_token_revoke.md | 2 +- internal/cmd/auth/auth.go | 4 ++-- internal/cmd/dns/record-set/list/list.go | 4 ++-- internal/cmd/dns/zone/list/list.go | 4 ++-- internal/cmd/object-storage/object_storage.go | 4 ++-- internal/cmd/organization/member/member.go | 4 ++-- internal/cmd/organization/organization.go | 4 ++-- internal/cmd/organization/role/role.go | 4 ++-- internal/cmd/project/member/member.go | 4 ++-- internal/cmd/project/project.go | 4 ++-- internal/cmd/project/role/role.go | 4 ++-- internal/cmd/service-account/key/key.go | 4 ++-- internal/cmd/service-account/token/token.go | 4 ++-- 56 files changed, 92 insertions(+), 92 deletions(-) diff --git a/docs/stackit.md b/docs/stackit.md index 5d8cc339e..0e4dd7b7d 100644 --- a/docs/stackit.md +++ b/docs/stackit.md @@ -27,7 +27,7 @@ stackit [flags] ### SEE ALSO * [stackit argus](./stackit_argus.md) - Provides functionality for Argus -* [stackit auth](./stackit_auth.md) - Provides authentication functionality +* [stackit auth](./stackit_auth.md) - Provides functionality for authentication * [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options * [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint * [stackit dns](./stackit_dns.md) - Provides functionality for DNS @@ -35,11 +35,11 @@ stackit [flags] * [stackit logme](./stackit_logme.md) - Provides functionality for LogMe * [stackit mariadb](./stackit_mariadb.md) - Provides functionality for MariaDB * [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage * [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch -* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations +* [stackit organization](./stackit_organization.md) - Provides functionality for organizations * [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects * [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ * [stackit redis](./stackit_redis.md) - Provides functionality for Redis * [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager diff --git a/docs/stackit_auth.md b/docs/stackit_auth.md index 00211ca7f..06849f2fa 100644 --- a/docs/stackit_auth.md +++ b/docs/stackit_auth.md @@ -1,10 +1,10 @@ ## stackit auth -Provides authentication functionality +Provides functionality for authentication ### Synopsis -Provides authentication functionality. +Provides functionality for authentication. ``` stackit auth [flags] diff --git a/docs/stackit_auth_activate-service-account.md b/docs/stackit_auth_activate-service-account.md index c7f83a103..16bccbbe1 100644 --- a/docs/stackit_auth_activate-service-account.md +++ b/docs/stackit_auth_activate-service-account.md @@ -48,5 +48,5 @@ stackit auth activate-service-account [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Provides authentication functionality +* [stackit auth](./stackit_auth.md) - Provides functionality for authentication diff --git a/docs/stackit_auth_login.md b/docs/stackit_auth_login.md index e1f41a63e..c2638ebca 100644 --- a/docs/stackit_auth_login.md +++ b/docs/stackit_auth_login.md @@ -35,5 +35,5 @@ stackit auth login [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Provides authentication functionality +* [stackit auth](./stackit_auth.md) - Provides functionality for authentication diff --git a/docs/stackit_dns_record-set.md b/docs/stackit_dns_record-set.md index 33816f70f..241199be6 100644 --- a/docs/stackit_dns_record-set.md +++ b/docs/stackit_dns_record-set.md @@ -32,6 +32,6 @@ stackit dns record-set [flags] * [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 list](./stackit_dns_record-set_list.md) - Lists DNS record sets * [stackit dns record-set update](./stackit_dns_record-set_update.md) - Updates a DNS record set diff --git a/docs/stackit_dns_record-set_list.md b/docs/stackit_dns_record-set_list.md index 4b6e7654d..738c77f14 100644 --- a/docs/stackit_dns_record-set_list.md +++ b/docs/stackit_dns_record-set_list.md @@ -1,10 +1,10 @@ ## stackit dns record-set list -List DNS record sets +Lists DNS record sets ### Synopsis -List DNS record sets. Successfully deleted record sets are not listed by default. +Lists DNS record sets. Successfully deleted record sets are not listed by default. ``` stackit dns record-set list [flags] diff --git a/docs/stackit_dns_zone.md b/docs/stackit_dns_zone.md index 2d484e5e6..cd1bef180 100644 --- a/docs/stackit_dns_zone.md +++ b/docs/stackit_dns_zone.md @@ -32,6 +32,6 @@ stackit dns zone [flags] * [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 list](./stackit_dns_zone_list.md) - Lists DNS zones * [stackit dns zone update](./stackit_dns_zone_update.md) - Updates a DNS zone diff --git a/docs/stackit_dns_zone_list.md b/docs/stackit_dns_zone_list.md index 92c527c00..099a67cf2 100644 --- a/docs/stackit_dns_zone_list.md +++ b/docs/stackit_dns_zone_list.md @@ -1,10 +1,10 @@ ## stackit dns zone list -List DNS zones +Lists DNS zones ### Synopsis -List DNS zones. Successfully deleted zones are not listed by default. +Lists DNS zones. Successfully deleted zones are not listed by default. ``` stackit dns zone list [flags] diff --git a/docs/stackit_object-storage.md b/docs/stackit_object-storage.md index 676bc3110..5d7def58c 100644 --- a/docs/stackit_object-storage.md +++ b/docs/stackit_object-storage.md @@ -1,10 +1,10 @@ ## stackit object-storage -Provides functionality regarding Object Storage +Provides functionality for Object Storage ### Synopsis -Provides functionality regarding Object Storage. +Provides functionality for Object Storage. ``` stackit object-storage [flags] diff --git a/docs/stackit_object-storage_bucket.md b/docs/stackit_object-storage_bucket.md index b8d8df4b6..54a2cfdf8 100644 --- a/docs/stackit_object-storage_bucket.md +++ b/docs/stackit_object-storage_bucket.md @@ -28,7 +28,7 @@ stackit object-storage bucket [flags] ### SEE ALSO -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage * [stackit object-storage bucket create](./stackit_object-storage_bucket_create.md) - Creates an Object Storage bucket * [stackit object-storage bucket delete](./stackit_object-storage_bucket_delete.md) - Deletes an Object Storage bucket * [stackit object-storage bucket describe](./stackit_object-storage_bucket_describe.md) - Shows details of an Object Storage bucket diff --git a/docs/stackit_object-storage_credentials-group.md b/docs/stackit_object-storage_credentials-group.md index 3c028ed12..30db660a7 100644 --- a/docs/stackit_object-storage_credentials-group.md +++ b/docs/stackit_object-storage_credentials-group.md @@ -28,7 +28,7 @@ stackit object-storage credentials-group [flags] ### SEE ALSO -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage * [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials * [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group that holds Object Storage access credentials * [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups that hold Object Storage access credentials diff --git a/docs/stackit_object-storage_credentials.md b/docs/stackit_object-storage_credentials.md index de61b0195..6d602dd20 100644 --- a/docs/stackit_object-storage_credentials.md +++ b/docs/stackit_object-storage_credentials.md @@ -28,7 +28,7 @@ stackit object-storage credentials [flags] ### SEE ALSO -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage * [stackit object-storage credentials create](./stackit_object-storage_credentials_create.md) - Creates credentials for an Object Storage credentials group * [stackit object-storage credentials delete](./stackit_object-storage_credentials_delete.md) - Deletes credentials of an Object Storage credentials group * [stackit object-storage credentials list](./stackit_object-storage_credentials_list.md) - Lists all credentials for an Object Storage credentials group diff --git a/docs/stackit_object-storage_disable.md b/docs/stackit_object-storage_disable.md index 0699e5249..e386c006f 100644 --- a/docs/stackit_object-storage_disable.md +++ b/docs/stackit_object-storage_disable.md @@ -35,5 +35,5 @@ stackit object-storage disable [flags] ### SEE ALSO -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage diff --git a/docs/stackit_object-storage_enable.md b/docs/stackit_object-storage_enable.md index 441997bd6..6bf93bb80 100644 --- a/docs/stackit_object-storage_enable.md +++ b/docs/stackit_object-storage_enable.md @@ -35,5 +35,5 @@ stackit object-storage enable [flags] ### SEE ALSO -* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage +* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage diff --git a/docs/stackit_organization.md b/docs/stackit_organization.md index 2c3091969..49190bd3b 100644 --- a/docs/stackit_organization.md +++ b/docs/stackit_organization.md @@ -1,10 +1,10 @@ ## stackit organization -Provides functionality regarding organizations +Provides functionality for organizations ### Synopsis -Provides functionality regarding organizations. +Provides functionality for organizations. An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service. ``` @@ -30,6 +30,6 @@ stackit organization [flags] ### SEE ALSO * [stackit](./stackit.md) - Manage STACKIT resources using the command line -* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members -* [stackit organization role](./stackit_organization_role.md) - Provides functionality regarding organization roles +* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members +* [stackit organization role](./stackit_organization_role.md) - Provides functionality for organization roles diff --git a/docs/stackit_organization_member.md b/docs/stackit_organization_member.md index e7651ee04..8762e1f23 100644 --- a/docs/stackit_organization_member.md +++ b/docs/stackit_organization_member.md @@ -1,10 +1,10 @@ ## stackit organization member -Provides functionality regarding organization members +Provides functionality for organization members ### Synopsis -Provides functionality regarding organization members. +Provides functionality for organization members. ``` stackit organization member [flags] @@ -28,7 +28,7 @@ stackit organization member [flags] ### SEE ALSO -* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations +* [stackit organization](./stackit_organization.md) - Provides functionality for organizations * [stackit organization member add](./stackit_organization_member_add.md) - Adds a member to an organization * [stackit organization member list](./stackit_organization_member_list.md) - Lists members of an organization * [stackit organization member remove](./stackit_organization_member_remove.md) - Removes a member from an organization diff --git a/docs/stackit_organization_member_add.md b/docs/stackit_organization_member_add.md index 46f7dedf0..51ba0c8f4 100644 --- a/docs/stackit_organization_member_add.md +++ b/docs/stackit_organization_member_add.md @@ -41,5 +41,5 @@ stackit organization member add SUBJECT [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members +* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members diff --git a/docs/stackit_organization_member_list.md b/docs/stackit_organization_member_list.md index 2f3772038..d360aab08 100644 --- a/docs/stackit_organization_member_list.md +++ b/docs/stackit_organization_member_list.md @@ -45,5 +45,5 @@ stackit organization member list [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members +* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members diff --git a/docs/stackit_organization_member_remove.md b/docs/stackit_organization_member_remove.md index f164052b8..6aea0d7d8 100644 --- a/docs/stackit_organization_member_remove.md +++ b/docs/stackit_organization_member_remove.md @@ -43,5 +43,5 @@ stackit organization member remove SUBJECT [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members +* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members diff --git a/docs/stackit_organization_role.md b/docs/stackit_organization_role.md index e95f20a39..0958d4096 100644 --- a/docs/stackit_organization_role.md +++ b/docs/stackit_organization_role.md @@ -1,10 +1,10 @@ ## stackit organization role -Provides functionality regarding organization roles +Provides functionality for organization roles ### Synopsis -Provides functionality regarding organization roles. +Provides functionality for organization roles. ``` stackit organization role [flags] @@ -28,6 +28,6 @@ stackit organization role [flags] ### SEE ALSO -* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations +* [stackit organization](./stackit_organization.md) - Provides functionality for organizations * [stackit organization role list](./stackit_organization_role_list.md) - Lists roles and permissions of an organization diff --git a/docs/stackit_organization_role_list.md b/docs/stackit_organization_role_list.md index 9f2f9b491..92029b97b 100644 --- a/docs/stackit_organization_role_list.md +++ b/docs/stackit_organization_role_list.md @@ -43,5 +43,5 @@ stackit organization role list [flags] ### SEE ALSO -* [stackit organization role](./stackit_organization_role.md) - Provides functionality regarding organization roles +* [stackit organization role](./stackit_organization_role.md) - Provides functionality for organization roles diff --git a/docs/stackit_project.md b/docs/stackit_project.md index 5c30842c4..656bdc903 100644 --- a/docs/stackit_project.md +++ b/docs/stackit_project.md @@ -1,10 +1,10 @@ ## stackit project -Provides functionality regarding projects +Provides functionality for projects ### Synopsis -Provides functionality regarding projects. +Provides functionality for projects. A project is a container for resources which is the service that you can purchase from STACKIT. ``` @@ -34,7 +34,7 @@ stackit project [flags] * [stackit project delete](./stackit_project_delete.md) - Deletes a STACKIT project * [stackit project describe](./stackit_project_describe.md) - Shows details of a STACKIT project * [stackit project list](./stackit_project_list.md) - Lists STACKIT projects -* [stackit project member](./stackit_project_member.md) - Provides functionality regarding project members -* [stackit project role](./stackit_project_role.md) - Provides functionality regarding project roles +* [stackit project member](./stackit_project_member.md) - Provides functionality for project members +* [stackit project role](./stackit_project_role.md) - Provides functionality for project roles * [stackit project update](./stackit_project_update.md) - Updates a STACKIT project diff --git a/docs/stackit_project_create.md b/docs/stackit_project_create.md index b3168ab91..80854fec7 100644 --- a/docs/stackit_project_create.md +++ b/docs/stackit_project_create.md @@ -41,5 +41,5 @@ stackit project create [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects diff --git a/docs/stackit_project_delete.md b/docs/stackit_project_delete.md index 03566109f..1d0965561 100644 --- a/docs/stackit_project_delete.md +++ b/docs/stackit_project_delete.md @@ -38,5 +38,5 @@ stackit project delete [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects diff --git a/docs/stackit_project_describe.md b/docs/stackit_project_describe.md index 24f145174..943187839 100644 --- a/docs/stackit_project_describe.md +++ b/docs/stackit_project_describe.md @@ -42,5 +42,5 @@ stackit project describe [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects diff --git a/docs/stackit_project_list.md b/docs/stackit_project_list.md index c968bef0c..496319415 100644 --- a/docs/stackit_project_list.md +++ b/docs/stackit_project_list.md @@ -50,5 +50,5 @@ stackit project list [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects diff --git a/docs/stackit_project_member.md b/docs/stackit_project_member.md index 6cf65e449..58e43a656 100644 --- a/docs/stackit_project_member.md +++ b/docs/stackit_project_member.md @@ -1,10 +1,10 @@ ## stackit project member -Provides functionality regarding project members +Provides functionality for project members ### Synopsis -Provides functionality regarding project members. +Provides functionality for project members. ``` stackit project member [flags] @@ -28,7 +28,7 @@ stackit project member [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects * [stackit project member add](./stackit_project_member_add.md) - Adds a member to a project * [stackit project member list](./stackit_project_member_list.md) - Lists members of a project * [stackit project member remove](./stackit_project_member_remove.md) - Removes a member from a project diff --git a/docs/stackit_project_member_add.md b/docs/stackit_project_member_add.md index b92c1d1e0..e6c8a7a22 100644 --- a/docs/stackit_project_member_add.md +++ b/docs/stackit_project_member_add.md @@ -40,5 +40,5 @@ stackit project member add SUBJECT [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality regarding project members +* [stackit project member](./stackit_project_member.md) - Provides functionality for project members diff --git a/docs/stackit_project_member_list.md b/docs/stackit_project_member_list.md index dbc1b5f06..dd56aec01 100644 --- a/docs/stackit_project_member_list.md +++ b/docs/stackit_project_member_list.md @@ -44,5 +44,5 @@ stackit project member list [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality regarding project members +* [stackit project member](./stackit_project_member.md) - Provides functionality for project members diff --git a/docs/stackit_project_member_remove.md b/docs/stackit_project_member_remove.md index f94e96a04..e23d71a67 100644 --- a/docs/stackit_project_member_remove.md +++ b/docs/stackit_project_member_remove.md @@ -42,5 +42,5 @@ stackit project member remove SUBJECT [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality regarding project members +* [stackit project member](./stackit_project_member.md) - Provides functionality for project members diff --git a/docs/stackit_project_role.md b/docs/stackit_project_role.md index 17551b60d..b532ffd7c 100644 --- a/docs/stackit_project_role.md +++ b/docs/stackit_project_role.md @@ -1,10 +1,10 @@ ## stackit project role -Provides functionality regarding project roles +Provides functionality for project roles ### Synopsis -Provides functionality regarding project roles. +Provides functionality for project roles. ``` stackit project role [flags] @@ -28,6 +28,6 @@ stackit project role [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects * [stackit project role list](./stackit_project_role_list.md) - Lists roles and permissions of a project diff --git a/docs/stackit_project_role_list.md b/docs/stackit_project_role_list.md index 2c34a8727..1517fb69c 100644 --- a/docs/stackit_project_role_list.md +++ b/docs/stackit_project_role_list.md @@ -42,5 +42,5 @@ stackit project role list [flags] ### SEE ALSO -* [stackit project role](./stackit_project_role.md) - Provides functionality regarding project roles +* [stackit project role](./stackit_project_role.md) - Provides functionality for project roles diff --git a/docs/stackit_project_update.md b/docs/stackit_project_update.md index f9e569c8a..c8f8658e5 100644 --- a/docs/stackit_project_update.md +++ b/docs/stackit_project_update.md @@ -44,5 +44,5 @@ stackit project update [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality regarding projects +* [stackit project](./stackit_project.md) - Provides functionality for projects diff --git a/docs/stackit_service-account.md b/docs/stackit_service-account.md index c2fed18c5..4d72ed5e7 100644 --- a/docs/stackit_service-account.md +++ b/docs/stackit_service-account.md @@ -32,7 +32,7 @@ stackit service-account [flags] * [stackit service-account create](./stackit_service-account_create.md) - Creates a service account * [stackit service-account delete](./stackit_service-account_delete.md) - Deletes a service account * [stackit service-account get-jwks](./stackit_service-account_get-jwks.md) - Shows the JWKS for a service account -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys * [stackit service-account list](./stackit_service-account_list.md) - Lists all service accounts -* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality regarding service account tokens +* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality for service account tokens diff --git a/docs/stackit_service-account_key.md b/docs/stackit_service-account_key.md index 40b9c8c26..ad9ad8aae 100644 --- a/docs/stackit_service-account_key.md +++ b/docs/stackit_service-account_key.md @@ -1,10 +1,10 @@ ## stackit service-account key -Provides functionality regarding service account keys +Provides functionality for service account keys ### Synopsis -Provides functionality regarding service account keys. +Provides functionality for service account keys. ``` stackit service-account key [flags] diff --git a/docs/stackit_service-account_key_create.md b/docs/stackit_service-account_key_create.md index 0e33bd90a..0f50cf0df 100644 --- a/docs/stackit_service-account_key_create.md +++ b/docs/stackit_service-account_key_create.md @@ -46,5 +46,5 @@ stackit service-account key create [flags] ### SEE ALSO -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys diff --git a/docs/stackit_service-account_key_delete.md b/docs/stackit_service-account_key_delete.md index c882dc490..aa28e8413 100644 --- a/docs/stackit_service-account_key_delete.md +++ b/docs/stackit_service-account_key_delete.md @@ -36,5 +36,5 @@ stackit service-account key delete KEY_ID [flags] ### SEE ALSO -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys diff --git a/docs/stackit_service-account_key_describe.md b/docs/stackit_service-account_key_describe.md index 21f949d79..58a3b922d 100644 --- a/docs/stackit_service-account_key_describe.md +++ b/docs/stackit_service-account_key_describe.md @@ -36,5 +36,5 @@ stackit service-account key describe KEY_ID [flags] ### SEE ALSO -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys diff --git a/docs/stackit_service-account_key_list.md b/docs/stackit_service-account_key_list.md index c141676ac..811f40454 100644 --- a/docs/stackit_service-account_key_list.md +++ b/docs/stackit_service-account_key_list.md @@ -43,5 +43,5 @@ stackit service-account key list [flags] ### SEE ALSO -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys diff --git a/docs/stackit_service-account_key_update.md b/docs/stackit_service-account_key_update.md index 2c8e2f751..31ec346d6 100644 --- a/docs/stackit_service-account_key_update.md +++ b/docs/stackit_service-account_key_update.md @@ -46,5 +46,5 @@ stackit service-account key update KEY_ID [flags] ### SEE ALSO -* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality regarding service account keys +* [stackit service-account key](./stackit_service-account_key.md) - Provides functionality for service account keys diff --git a/docs/stackit_service-account_token.md b/docs/stackit_service-account_token.md index 03888a32c..7a3a5e066 100644 --- a/docs/stackit_service-account_token.md +++ b/docs/stackit_service-account_token.md @@ -1,10 +1,10 @@ ## stackit service-account token -Provides functionality regarding service account tokens +Provides functionality for service account tokens ### Synopsis -Provides functionality regarding service account tokens. +Provides functionality for service account tokens. ``` stackit service-account token [flags] diff --git a/docs/stackit_service-account_token_create.md b/docs/stackit_service-account_token_create.md index ebca082ca..49797b420 100644 --- a/docs/stackit_service-account_token_create.md +++ b/docs/stackit_service-account_token_create.md @@ -42,5 +42,5 @@ stackit service-account token create [flags] ### SEE ALSO -* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality regarding service account tokens +* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality for service account tokens diff --git a/docs/stackit_service-account_token_list.md b/docs/stackit_service-account_token_list.md index daaa3d06d..e340adadb 100644 --- a/docs/stackit_service-account_token_list.md +++ b/docs/stackit_service-account_token_list.md @@ -45,5 +45,5 @@ stackit service-account token list [flags] ### SEE ALSO -* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality regarding service account tokens +* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality for service account tokens diff --git a/docs/stackit_service-account_token_revoke.md b/docs/stackit_service-account_token_revoke.md index 57c73899f..42a2f5fbb 100644 --- a/docs/stackit_service-account_token_revoke.md +++ b/docs/stackit_service-account_token_revoke.md @@ -38,5 +38,5 @@ stackit service-account token revoke TOKEN_ID [flags] ### SEE ALSO -* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality regarding service account tokens +* [stackit service-account token](./stackit_service-account_token.md) - Provides functionality for service account tokens diff --git a/internal/cmd/auth/auth.go b/internal/cmd/auth/auth.go index cad07aaed..e502fcf56 100644 --- a/internal/cmd/auth/auth.go +++ b/internal/cmd/auth/auth.go @@ -13,8 +13,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "auth", - Short: "Provides authentication functionality", - Long: "Provides authentication functionality.", + Short: "Provides functionality for authentication", + Long: "Provides functionality for authentication.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/dns/record-set/list/list.go b/internal/cmd/dns/record-set/list/list.go index a3a842832..40edbcbec 100644 --- a/internal/cmd/dns/record-set/list/list.go +++ b/internal/cmd/dns/record-set/list/list.go @@ -51,8 +51,8 @@ type inputModel struct { func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "list", - Short: "List DNS record sets", - Long: `List DNS record sets. Successfully deleted record sets are not listed by default.`, + Short: "Lists DNS record sets", + Long: `Lists DNS record sets. Successfully deleted record sets are not listed by default.`, Args: args.NoArgs, Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/dns/zone/list/list.go b/internal/cmd/dns/zone/list/list.go index 49e23a0b0..46d08b31c 100644 --- a/internal/cmd/dns/zone/list/list.go +++ b/internal/cmd/dns/zone/list/list.go @@ -49,8 +49,8 @@ type inputModel struct { func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "list", - Short: "List DNS zones", - Long: `List DNS zones. Successfully deleted zones are not listed by default.`, + Short: "Lists DNS zones", + Long: `Lists DNS zones. Successfully deleted zones are not listed by default.`, Args: args.NoArgs, Example: examples.Build( examples.NewExample( diff --git a/internal/cmd/object-storage/object_storage.go b/internal/cmd/object-storage/object_storage.go index a612598d3..0ba397592 100644 --- a/internal/cmd/object-storage/object_storage.go +++ b/internal/cmd/object-storage/object_storage.go @@ -16,8 +16,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "object-storage", - Short: "Provides functionality regarding Object Storage", - Long: "Provides functionality regarding Object Storage.", + Short: "Provides functionality for Object Storage", + Long: "Provides functionality for Object Storage.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/organization/member/member.go b/internal/cmd/organization/member/member.go index fecdcfc1a..7694fe6ab 100644 --- a/internal/cmd/organization/member/member.go +++ b/internal/cmd/organization/member/member.go @@ -14,8 +14,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "member", - Short: "Provides functionality regarding organization members", - Long: "Provides functionality regarding organization members.", + Short: "Provides functionality for organization members", + Long: "Provides functionality for organization members.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/organization/organization.go b/internal/cmd/organization/organization.go index fb2b6ca57..24bce5e9f 100644 --- a/internal/cmd/organization/organization.go +++ b/internal/cmd/organization/organization.go @@ -15,9 +15,9 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "organization", - Short: "Provides functionality regarding organizations", + Short: "Provides functionality for organizations", Long: fmt.Sprintf("%s\n%s", - "Provides functionality regarding organizations.", + "Provides functionality for organizations.", "An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service.", ), Args: args.NoArgs, diff --git a/internal/cmd/organization/role/role.go b/internal/cmd/organization/role/role.go index 41f87752a..e524d79b2 100644 --- a/internal/cmd/organization/role/role.go +++ b/internal/cmd/organization/role/role.go @@ -12,8 +12,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "role", - Short: "Provides functionality regarding organization roles", - Long: "Provides functionality regarding organization roles.", + Short: "Provides functionality for organization roles", + Long: "Provides functionality for organization roles.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/project/member/member.go b/internal/cmd/project/member/member.go index 38340c1f2..6ab235a68 100644 --- a/internal/cmd/project/member/member.go +++ b/internal/cmd/project/member/member.go @@ -14,8 +14,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "member", - Short: "Provides functionality regarding project members", - Long: "Provides functionality regarding project members.", + Short: "Provides functionality for project members", + Long: "Provides functionality for project members.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/project/project.go b/internal/cmd/project/project.go index b4cf79228..c0df977d3 100644 --- a/internal/cmd/project/project.go +++ b/internal/cmd/project/project.go @@ -20,9 +20,9 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "project", - Short: "Provides functionality regarding projects", + Short: "Provides functionality for projects", Long: fmt.Sprintf("%s\n%s", - "Provides functionality regarding projects.", + "Provides functionality for projects.", "A project is a container for resources which is the service that you can purchase from STACKIT.", ), Args: args.NoArgs, diff --git a/internal/cmd/project/role/role.go b/internal/cmd/project/role/role.go index c32d3d224..8a7f419f4 100644 --- a/internal/cmd/project/role/role.go +++ b/internal/cmd/project/role/role.go @@ -12,8 +12,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "role", - Short: "Provides functionality regarding project roles", - Long: "Provides functionality regarding project roles.", + Short: "Provides functionality for project roles", + Long: "Provides functionality for project roles.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/service-account/key/key.go b/internal/cmd/service-account/key/key.go index 96ec51ae3..969e3df91 100644 --- a/internal/cmd/service-account/key/key.go +++ b/internal/cmd/service-account/key/key.go @@ -16,8 +16,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "key", - Short: "Provides functionality regarding service account keys", - Long: "Provides functionality regarding service account keys.", + Short: "Provides functionality for service account keys", + Long: "Provides functionality for service account keys.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/service-account/token/token.go b/internal/cmd/service-account/token/token.go index af6d363d4..45570ea97 100644 --- a/internal/cmd/service-account/token/token.go +++ b/internal/cmd/service-account/token/token.go @@ -14,8 +14,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "token", - Short: "Provides functionality regarding service account tokens", - Long: "Provides functionality regarding service account tokens.", + Short: "Provides functionality for service account tokens", + Long: "Provides functionality for service account tokens.", Args: args.NoArgs, Run: utils.CmdHelp, } From 0427a9f50d9dff5396a3a2472012292e65920bcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88kc=CC=A7e=20Go=CC=88k=20Klingel?= Date: Thu, 23 May 2024 13:26:27 +0200 Subject: [PATCH 2/4] update descriptions --- docs/stackit.md | 6 +++--- docs/stackit_auth.md | 4 ++-- docs/stackit_auth_activate-service-account.md | 2 +- docs/stackit_auth_login.md | 2 +- docs/stackit_organization.md | 8 ++++---- docs/stackit_organization_member.md | 6 +++--- docs/stackit_organization_member_add.md | 2 +- docs/stackit_organization_member_list.md | 2 +- docs/stackit_organization_member_remove.md | 2 +- docs/stackit_organization_role.md | 6 +++--- docs/stackit_organization_role_list.md | 2 +- docs/stackit_project.md | 6 +++--- docs/stackit_project_create.md | 2 +- docs/stackit_project_delete.md | 2 +- docs/stackit_project_describe.md | 2 +- docs/stackit_project_list.md | 2 +- docs/stackit_project_member.md | 6 +++--- docs/stackit_project_member_add.md | 2 +- docs/stackit_project_member_list.md | 2 +- docs/stackit_project_member_remove.md | 2 +- docs/stackit_project_role.md | 6 +++--- docs/stackit_project_role_list.md | 2 +- docs/stackit_project_update.md | 2 +- internal/cmd/auth/auth.go | 4 ++-- internal/cmd/organization/member/member.go | 4 ++-- internal/cmd/organization/organization.go | 4 ++-- internal/cmd/organization/role/role.go | 4 ++-- internal/cmd/project/member/member.go | 4 ++-- internal/cmd/project/project.go | 2 +- internal/cmd/project/role/role.go | 4 ++-- 30 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/stackit.md b/docs/stackit.md index 0e4dd7b7d..1dd73e8bd 100644 --- a/docs/stackit.md +++ b/docs/stackit.md @@ -27,7 +27,7 @@ stackit [flags] ### SEE ALSO * [stackit argus](./stackit_argus.md) - Provides functionality for Argus -* [stackit auth](./stackit_auth.md) - Provides functionality for authentication +* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI * [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options * [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint * [stackit dns](./stackit_dns.md) - Provides functionality for DNS @@ -37,9 +37,9 @@ stackit [flags] * [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex * [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage * [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch -* [stackit organization](./stackit_organization.md) - Provides functionality for organizations +* [stackit organization](./stackit_organization.md) - Manages organizations * [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects * [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ * [stackit redis](./stackit_redis.md) - Provides functionality for Redis * [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager diff --git a/docs/stackit_auth.md b/docs/stackit_auth.md index 06849f2fa..39bd6c5a8 100644 --- a/docs/stackit_auth.md +++ b/docs/stackit_auth.md @@ -1,10 +1,10 @@ ## stackit auth -Provides functionality for authentication +Authenticates in the STACKIT CLI ### Synopsis -Provides functionality for authentication. +Authenticates in the STACKIT CLI. ``` stackit auth [flags] diff --git a/docs/stackit_auth_activate-service-account.md b/docs/stackit_auth_activate-service-account.md index 16bccbbe1..02e63df04 100644 --- a/docs/stackit_auth_activate-service-account.md +++ b/docs/stackit_auth_activate-service-account.md @@ -48,5 +48,5 @@ stackit auth activate-service-account [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Provides functionality for authentication +* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI diff --git a/docs/stackit_auth_login.md b/docs/stackit_auth_login.md index c2638ebca..623e4a264 100644 --- a/docs/stackit_auth_login.md +++ b/docs/stackit_auth_login.md @@ -35,5 +35,5 @@ stackit auth login [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Provides functionality for authentication +* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI diff --git a/docs/stackit_organization.md b/docs/stackit_organization.md index 49190bd3b..0fefe9cb2 100644 --- a/docs/stackit_organization.md +++ b/docs/stackit_organization.md @@ -1,10 +1,10 @@ ## stackit organization -Provides functionality for organizations +Manages organizations ### Synopsis -Provides functionality for organizations. +Manages organizations. An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service. ``` @@ -30,6 +30,6 @@ stackit organization [flags] ### SEE ALSO * [stackit](./stackit.md) - Manage STACKIT resources using the command line -* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members -* [stackit organization role](./stackit_organization_role.md) - Provides functionality for organization roles +* [stackit organization member](./stackit_organization_member.md) - Manages organization members +* [stackit organization role](./stackit_organization_role.md) - Manages organization roles diff --git a/docs/stackit_organization_member.md b/docs/stackit_organization_member.md index 8762e1f23..496aa4466 100644 --- a/docs/stackit_organization_member.md +++ b/docs/stackit_organization_member.md @@ -1,10 +1,10 @@ ## stackit organization member -Provides functionality for organization members +Manages organization members ### Synopsis -Provides functionality for organization members. +Manages organization members. ``` stackit organization member [flags] @@ -28,7 +28,7 @@ stackit organization member [flags] ### SEE ALSO -* [stackit organization](./stackit_organization.md) - Provides functionality for organizations +* [stackit organization](./stackit_organization.md) - Manages organizations * [stackit organization member add](./stackit_organization_member_add.md) - Adds a member to an organization * [stackit organization member list](./stackit_organization_member_list.md) - Lists members of an organization * [stackit organization member remove](./stackit_organization_member_remove.md) - Removes a member from an organization diff --git a/docs/stackit_organization_member_add.md b/docs/stackit_organization_member_add.md index 51ba0c8f4..0e5a50491 100644 --- a/docs/stackit_organization_member_add.md +++ b/docs/stackit_organization_member_add.md @@ -41,5 +41,5 @@ stackit organization member add SUBJECT [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members +* [stackit organization member](./stackit_organization_member.md) - Manages organization members diff --git a/docs/stackit_organization_member_list.md b/docs/stackit_organization_member_list.md index d360aab08..2263ce2a4 100644 --- a/docs/stackit_organization_member_list.md +++ b/docs/stackit_organization_member_list.md @@ -45,5 +45,5 @@ stackit organization member list [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members +* [stackit organization member](./stackit_organization_member.md) - Manages organization members diff --git a/docs/stackit_organization_member_remove.md b/docs/stackit_organization_member_remove.md index 6aea0d7d8..8c425a22c 100644 --- a/docs/stackit_organization_member_remove.md +++ b/docs/stackit_organization_member_remove.md @@ -43,5 +43,5 @@ stackit organization member remove SUBJECT [flags] ### SEE ALSO -* [stackit organization member](./stackit_organization_member.md) - Provides functionality for organization members +* [stackit organization member](./stackit_organization_member.md) - Manages organization members diff --git a/docs/stackit_organization_role.md b/docs/stackit_organization_role.md index 0958d4096..2a5d2f75a 100644 --- a/docs/stackit_organization_role.md +++ b/docs/stackit_organization_role.md @@ -1,10 +1,10 @@ ## stackit organization role -Provides functionality for organization roles +Manages organization roles ### Synopsis -Provides functionality for organization roles. +Manages organization roles. ``` stackit organization role [flags] @@ -28,6 +28,6 @@ stackit organization role [flags] ### SEE ALSO -* [stackit organization](./stackit_organization.md) - Provides functionality for organizations +* [stackit organization](./stackit_organization.md) - Manages organizations * [stackit organization role list](./stackit_organization_role_list.md) - Lists roles and permissions of an organization diff --git a/docs/stackit_organization_role_list.md b/docs/stackit_organization_role_list.md index 92029b97b..0228eca5c 100644 --- a/docs/stackit_organization_role_list.md +++ b/docs/stackit_organization_role_list.md @@ -43,5 +43,5 @@ stackit organization role list [flags] ### SEE ALSO -* [stackit organization role](./stackit_organization_role.md) - Provides functionality for organization roles +* [stackit organization role](./stackit_organization_role.md) - Manages organization roles diff --git a/docs/stackit_project.md b/docs/stackit_project.md index 656bdc903..7f002da38 100644 --- a/docs/stackit_project.md +++ b/docs/stackit_project.md @@ -1,6 +1,6 @@ ## stackit project -Provides functionality for projects +Manages projects ### Synopsis @@ -34,7 +34,7 @@ stackit project [flags] * [stackit project delete](./stackit_project_delete.md) - Deletes a STACKIT project * [stackit project describe](./stackit_project_describe.md) - Shows details of a STACKIT project * [stackit project list](./stackit_project_list.md) - Lists STACKIT projects -* [stackit project member](./stackit_project_member.md) - Provides functionality for project members -* [stackit project role](./stackit_project_role.md) - Provides functionality for project roles +* [stackit project member](./stackit_project_member.md) - Manages project members +* [stackit project role](./stackit_project_role.md) - Manages project roles * [stackit project update](./stackit_project_update.md) - Updates a STACKIT project diff --git a/docs/stackit_project_create.md b/docs/stackit_project_create.md index 80854fec7..ae6e22723 100644 --- a/docs/stackit_project_create.md +++ b/docs/stackit_project_create.md @@ -41,5 +41,5 @@ stackit project create [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects diff --git a/docs/stackit_project_delete.md b/docs/stackit_project_delete.md index 1d0965561..66b60ed00 100644 --- a/docs/stackit_project_delete.md +++ b/docs/stackit_project_delete.md @@ -38,5 +38,5 @@ stackit project delete [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects diff --git a/docs/stackit_project_describe.md b/docs/stackit_project_describe.md index 943187839..a3976ece6 100644 --- a/docs/stackit_project_describe.md +++ b/docs/stackit_project_describe.md @@ -42,5 +42,5 @@ stackit project describe [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects diff --git a/docs/stackit_project_list.md b/docs/stackit_project_list.md index 496319415..28aa2693b 100644 --- a/docs/stackit_project_list.md +++ b/docs/stackit_project_list.md @@ -50,5 +50,5 @@ stackit project list [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects diff --git a/docs/stackit_project_member.md b/docs/stackit_project_member.md index 58e43a656..c2021638a 100644 --- a/docs/stackit_project_member.md +++ b/docs/stackit_project_member.md @@ -1,10 +1,10 @@ ## stackit project member -Provides functionality for project members +Manages project members ### Synopsis -Provides functionality for project members. +Manages project members. ``` stackit project member [flags] @@ -28,7 +28,7 @@ stackit project member [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects * [stackit project member add](./stackit_project_member_add.md) - Adds a member to a project * [stackit project member list](./stackit_project_member_list.md) - Lists members of a project * [stackit project member remove](./stackit_project_member_remove.md) - Removes a member from a project diff --git a/docs/stackit_project_member_add.md b/docs/stackit_project_member_add.md index e6c8a7a22..105676243 100644 --- a/docs/stackit_project_member_add.md +++ b/docs/stackit_project_member_add.md @@ -40,5 +40,5 @@ stackit project member add SUBJECT [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality for project members +* [stackit project member](./stackit_project_member.md) - Manages project members diff --git a/docs/stackit_project_member_list.md b/docs/stackit_project_member_list.md index dd56aec01..c27436336 100644 --- a/docs/stackit_project_member_list.md +++ b/docs/stackit_project_member_list.md @@ -44,5 +44,5 @@ stackit project member list [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality for project members +* [stackit project member](./stackit_project_member.md) - Manages project members diff --git a/docs/stackit_project_member_remove.md b/docs/stackit_project_member_remove.md index e23d71a67..9c9e46ffe 100644 --- a/docs/stackit_project_member_remove.md +++ b/docs/stackit_project_member_remove.md @@ -42,5 +42,5 @@ stackit project member remove SUBJECT [flags] ### SEE ALSO -* [stackit project member](./stackit_project_member.md) - Provides functionality for project members +* [stackit project member](./stackit_project_member.md) - Manages project members diff --git a/docs/stackit_project_role.md b/docs/stackit_project_role.md index b532ffd7c..b95577866 100644 --- a/docs/stackit_project_role.md +++ b/docs/stackit_project_role.md @@ -1,10 +1,10 @@ ## stackit project role -Provides functionality for project roles +Manages project roles ### Synopsis -Provides functionality for project roles. +Manages project roles. ``` stackit project role [flags] @@ -28,6 +28,6 @@ stackit project role [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects * [stackit project role list](./stackit_project_role_list.md) - Lists roles and permissions of a project diff --git a/docs/stackit_project_role_list.md b/docs/stackit_project_role_list.md index 1517fb69c..6744c4c8c 100644 --- a/docs/stackit_project_role_list.md +++ b/docs/stackit_project_role_list.md @@ -42,5 +42,5 @@ stackit project role list [flags] ### SEE ALSO -* [stackit project role](./stackit_project_role.md) - Provides functionality for project roles +* [stackit project role](./stackit_project_role.md) - Manages project roles diff --git a/docs/stackit_project_update.md b/docs/stackit_project_update.md index c8f8658e5..b057276be 100644 --- a/docs/stackit_project_update.md +++ b/docs/stackit_project_update.md @@ -44,5 +44,5 @@ stackit project update [flags] ### SEE ALSO -* [stackit project](./stackit_project.md) - Provides functionality for projects +* [stackit project](./stackit_project.md) - Manages projects diff --git a/internal/cmd/auth/auth.go b/internal/cmd/auth/auth.go index e502fcf56..e5dee07a8 100644 --- a/internal/cmd/auth/auth.go +++ b/internal/cmd/auth/auth.go @@ -13,8 +13,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "auth", - Short: "Provides functionality for authentication", - Long: "Provides functionality for authentication.", + Short: "Authenticates in the STACKIT CLI", + Long: "Authenticates in the STACKIT CLI.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/organization/member/member.go b/internal/cmd/organization/member/member.go index 7694fe6ab..cf7c515d8 100644 --- a/internal/cmd/organization/member/member.go +++ b/internal/cmd/organization/member/member.go @@ -14,8 +14,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "member", - Short: "Provides functionality for organization members", - Long: "Provides functionality for organization members.", + Short: "Manages organization members", + Long: "Manages organization members.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/organization/organization.go b/internal/cmd/organization/organization.go index 24bce5e9f..3d34090fd 100644 --- a/internal/cmd/organization/organization.go +++ b/internal/cmd/organization/organization.go @@ -15,9 +15,9 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "organization", - Short: "Provides functionality for organizations", + Short: "Manages organizations", Long: fmt.Sprintf("%s\n%s", - "Provides functionality for organizations.", + "Manages organizations.", "An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service.", ), Args: args.NoArgs, diff --git a/internal/cmd/organization/role/role.go b/internal/cmd/organization/role/role.go index e524d79b2..f32189bf5 100644 --- a/internal/cmd/organization/role/role.go +++ b/internal/cmd/organization/role/role.go @@ -12,8 +12,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "role", - Short: "Provides functionality for organization roles", - Long: "Provides functionality for organization roles.", + Short: "Manages organization roles", + Long: "Manages organization roles.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/project/member/member.go b/internal/cmd/project/member/member.go index 6ab235a68..658f6ff7c 100644 --- a/internal/cmd/project/member/member.go +++ b/internal/cmd/project/member/member.go @@ -14,8 +14,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "member", - Short: "Provides functionality for project members", - Long: "Provides functionality for project members.", + Short: "Manages project members", + Long: "Manages project members.", Args: args.NoArgs, Run: utils.CmdHelp, } diff --git a/internal/cmd/project/project.go b/internal/cmd/project/project.go index c0df977d3..ded8f8444 100644 --- a/internal/cmd/project/project.go +++ b/internal/cmd/project/project.go @@ -20,7 +20,7 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "project", - Short: "Provides functionality for projects", + Short: "Manages projects", Long: fmt.Sprintf("%s\n%s", "Provides functionality for projects.", "A project is a container for resources which is the service that you can purchase from STACKIT.", diff --git a/internal/cmd/project/role/role.go b/internal/cmd/project/role/role.go index 8a7f419f4..b460e54b7 100644 --- a/internal/cmd/project/role/role.go +++ b/internal/cmd/project/role/role.go @@ -12,8 +12,8 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "role", - Short: "Provides functionality for project roles", - Long: "Provides functionality for project roles.", + Short: "Manages project roles", + Long: "Manages project roles.", Args: args.NoArgs, Run: utils.CmdHelp, } From 1c781e38406ee5acd6c437999ee58e5e59b88fb0 Mon Sep 17 00:00:00 2001 From: GokceGK <161626272+GokceGK@users.noreply.github.com> Date: Thu, 23 May 2024 13:51:51 +0200 Subject: [PATCH 3/4] Update internal/cmd/auth/auth.go Co-authored-by: Vicente Pinto --- internal/cmd/auth/auth.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/cmd/auth/auth.go b/internal/cmd/auth/auth.go index e5dee07a8..061e5e85e 100644 --- a/internal/cmd/auth/auth.go +++ b/internal/cmd/auth/auth.go @@ -13,7 +13,7 @@ import ( func NewCmd(p *print.Printer) *cobra.Command { cmd := &cobra.Command{ Use: "auth", - Short: "Authenticates in the STACKIT CLI", + Short: "Authenticates the STACKIT CLI", Long: "Authenticates in the STACKIT CLI.", Args: args.NoArgs, Run: utils.CmdHelp, From 0078599632cf7fdee2d796d98d86fd39750d5458 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Go=CC=88kc=CC=A7e=20Go=CC=88k=20Klingel?= Date: Thu, 23 May 2024 13:53:04 +0200 Subject: [PATCH 4/4] update auth docs --- docs/stackit.md | 2 +- docs/stackit_auth.md | 2 +- docs/stackit_auth_activate-service-account.md | 2 +- docs/stackit_auth_login.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/stackit.md b/docs/stackit.md index 1dd73e8bd..26ce39547 100644 --- a/docs/stackit.md +++ b/docs/stackit.md @@ -27,7 +27,7 @@ stackit [flags] ### SEE ALSO * [stackit argus](./stackit_argus.md) - Provides functionality for Argus -* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI +* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI * [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options * [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint * [stackit dns](./stackit_dns.md) - Provides functionality for DNS diff --git a/docs/stackit_auth.md b/docs/stackit_auth.md index 39bd6c5a8..9cf637bb9 100644 --- a/docs/stackit_auth.md +++ b/docs/stackit_auth.md @@ -1,6 +1,6 @@ ## stackit auth -Authenticates in the STACKIT CLI +Authenticates the STACKIT CLI ### Synopsis diff --git a/docs/stackit_auth_activate-service-account.md b/docs/stackit_auth_activate-service-account.md index 02e63df04..18feefe3d 100644 --- a/docs/stackit_auth_activate-service-account.md +++ b/docs/stackit_auth_activate-service-account.md @@ -48,5 +48,5 @@ stackit auth activate-service-account [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI +* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI diff --git a/docs/stackit_auth_login.md b/docs/stackit_auth_login.md index 623e4a264..e839b4997 100644 --- a/docs/stackit_auth_login.md +++ b/docs/stackit_auth_login.md @@ -35,5 +35,5 @@ stackit auth login [flags] ### SEE ALSO -* [stackit auth](./stackit_auth.md) - Authenticates in the STACKIT CLI +* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI