From 5e094e74cc03da47bf9e575b813bb80d16eef3bd Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:18:52 +0000 Subject: [PATCH] backport of commit b2ea296816866855ba3a10879d88342544ebf932 --- website/content/docs/commands/aliases/create.mdx | 2 +- website/content/docs/commands/aliases/index.mdx | 2 +- website/content/docs/commands/aliases/read.mdx | 2 +- website/content/docs/commands/auth-methods/delete.mdx | 2 +- website/content/docs/commands/auth-methods/index.mdx | 2 +- website/content/docs/commands/auth-methods/read.mdx | 2 +- website/content/docs/commands/auth-tokens/delete.mdx | 2 +- website/content/docs/commands/auth-tokens/read.mdx | 2 +- website/content/docs/commands/billing/monthly-active-users.mdx | 2 +- website/content/docs/commands/credential-libraries/index.mdx | 2 +- website/content/docs/commands/credential-libraries/read.mdx | 2 +- website/content/docs/commands/credential-stores/index.mdx | 2 +- website/content/docs/commands/credential-stores/read.mdx | 2 +- website/content/docs/commands/credentials/index.mdx | 2 +- website/content/docs/commands/credentials/read.mdx | 2 +- website/content/docs/commands/groups/read.mdx | 2 +- website/content/docs/commands/host-catalogs/index.mdx | 2 +- website/content/docs/commands/host-catalogs/read.mdx | 2 +- website/content/docs/commands/host-sets/read.mdx | 2 +- website/content/docs/commands/hosts/read.mdx | 2 +- website/content/docs/commands/managed-groups/read.mdx | 2 +- website/content/docs/commands/policies/read.mdx | 2 +- website/content/docs/commands/read.mdx | 2 +- website/content/docs/commands/roles/read.mdx | 2 +- website/content/docs/commands/scopes/read.mdx | 2 +- website/content/docs/commands/session-recordings/read.mdx | 2 +- website/content/docs/commands/sessions/read.mdx | 2 +- website/content/docs/commands/storage-buckets/read.mdx | 2 +- website/content/docs/commands/targets/read.mdx | 2 +- website/content/docs/commands/users/read.mdx | 2 +- website/content/docs/commands/workers/index.mdx | 2 +- website/content/docs/commands/workers/read.mdx | 2 +- 32 files changed, 32 insertions(+), 32 deletions(-) diff --git a/website/content/docs/commands/aliases/create.mdx b/website/content/docs/commands/aliases/create.mdx index cad59204fd..875f8b6f4e 100644 --- a/website/content/docs/commands/aliases/create.mdx +++ b/website/content/docs/commands/aliases/create.mdx @@ -2,7 +2,7 @@ layout: docs page_title: aliases create - Command description: >- - The "aliases create" command creates a new alias for a target resource. + The "aliases create" command creates a new alias resource for a target. --- # aliases create diff --git a/website/content/docs/commands/aliases/index.mdx b/website/content/docs/commands/aliases/index.mdx index 0d67a69b01..16faba53db 100644 --- a/website/content/docs/commands/aliases/index.mdx +++ b/website/content/docs/commands/aliases/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: aliases - Command description: >- - The "aliases" command performs operations on alias resources. + The "aliases" command performs operations on alias resources. An alias is a globally unique, DNS-like string that is associated with a destination resource. --- # aliases diff --git a/website/content/docs/commands/aliases/read.mdx b/website/content/docs/commands/aliases/read.mdx index 48d1ff103a..d6dad0f8f5 100644 --- a/website/content/docs/commands/aliases/read.mdx +++ b/website/content/docs/commands/aliases/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: aliases read - Command description: >- - The "aliases read" command reads the details of an alias resource with a given ID. + The "aliases read" command retrieves the details of an alias resource with a given ID. --- # aliases read diff --git a/website/content/docs/commands/auth-methods/delete.mdx b/website/content/docs/commands/auth-methods/delete.mdx index bed4ccfcbf..120888fa04 100644 --- a/website/content/docs/commands/auth-methods/delete.mdx +++ b/website/content/docs/commands/auth-methods/delete.mdx @@ -2,7 +2,7 @@ layout: docs page_title: auth-methods delete - Command description: >- - The "auth-methods delete" command deletes an existing auth method resource with the given ID. + The "auth-methods delete" command deletes an existing auth method resource. --- # auth-methods delete diff --git a/website/content/docs/commands/auth-methods/index.mdx b/website/content/docs/commands/auth-methods/index.mdx index d94cdd9a1e..6b01fccb12 100644 --- a/website/content/docs/commands/auth-methods/index.mdx +++ b/website/content/docs/commands/auth-methods/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: auth-methods - Command description: >- - The "auth-methods" command performs operations on Boundary authentication method resources. + The "auth-methods" command performs operations on Boundary authentication method resources. Auth methods let users authenticate to Boundary. --- # auth-methods diff --git a/website/content/docs/commands/auth-methods/read.mdx b/website/content/docs/commands/auth-methods/read.mdx index 39e9a6d05d..507c44fd1d 100644 --- a/website/content/docs/commands/auth-methods/read.mdx +++ b/website/content/docs/commands/auth-methods/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: auth-methods read - Command description: >- - The "auth-methods read" command reads the details for an auth method resource with the given ID. + The "auth-methods read" command retrieves the details for an auth method resource with the given ID. --- # auth-methods read diff --git a/website/content/docs/commands/auth-tokens/delete.mdx b/website/content/docs/commands/auth-tokens/delete.mdx index 6e084d6463..9447eb26bf 100644 --- a/website/content/docs/commands/auth-tokens/delete.mdx +++ b/website/content/docs/commands/auth-tokens/delete.mdx @@ -2,7 +2,7 @@ layout: docs page_title: auth-tokens delete - Command description: >- - The "auth-tokens delete" command deletes an auth token resource with the given ID. + The "auth-tokens delete" command deletes an existing auth token resource with the given ID. --- # auth-tokens delete diff --git a/website/content/docs/commands/auth-tokens/read.mdx b/website/content/docs/commands/auth-tokens/read.mdx index 93ae1a5206..d7711bcb71 100644 --- a/website/content/docs/commands/auth-tokens/read.mdx +++ b/website/content/docs/commands/auth-tokens/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: auth-tokens read - Command description: >- - The "auth-tokens read" command reads the details for an auth token resource with the given ID. + The "auth-tokens read" command retrieves the details for an auth token resource with the given ID. --- # auth-tokens read diff --git a/website/content/docs/commands/billing/monthly-active-users.mdx b/website/content/docs/commands/billing/monthly-active-users.mdx index 23703c72f5..59381c1b95 100644 --- a/website/content/docs/commands/billing/monthly-active-users.mdx +++ b/website/content/docs/commands/billing/monthly-active-users.mdx @@ -2,7 +2,7 @@ layout: docs page_title: billing monthly-active-users - Command description: >- - The "billing monthly-active-users" command retrieves the number of monthly active users during a specified time to help you predict user-based pricing. + The "billing monthly-active-users" command retrieves the number of monthly active users during a specified time period to help you predict user-based pricing. --- # billing monthly-active-users diff --git a/website/content/docs/commands/credential-libraries/index.mdx b/website/content/docs/commands/credential-libraries/index.mdx index 1b03a014c6..048f251883 100644 --- a/website/content/docs/commands/credential-libraries/index.mdx +++ b/website/content/docs/commands/credential-libraries/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credential-libraries - Command description: >- - The "credential-libraries" command performs operations on credential library resources. + The "credential-libraries" command performs operations on credential library resources. Credential libraries provide credentials of the same type and access level. --- # credential-libraries diff --git a/website/content/docs/commands/credential-libraries/read.mdx b/website/content/docs/commands/credential-libraries/read.mdx index 7cd1639fc4..4a348578d3 100644 --- a/website/content/docs/commands/credential-libraries/read.mdx +++ b/website/content/docs/commands/credential-libraries/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credential-libraries read - Command description: >- - The "credential-libraries read" command reads the details of a credential library for a given credential library ID. + The "credential-libraries read" command retrieves the details of a credential library for a given credential library ID. --- # credential-libraries read diff --git a/website/content/docs/commands/credential-stores/index.mdx b/website/content/docs/commands/credential-stores/index.mdx index 1a92fa0cec..a62ed23031 100644 --- a/website/content/docs/commands/credential-stores/index.mdx +++ b/website/content/docs/commands/credential-stores/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credential-stores - Command description: >- - The "credential-stores" command performs operations on credential store resources. + The "credential-stores" command performs operations on credential store resources. Credential stores can manage credentials of differing types and access levels. --- # credential-stores diff --git a/website/content/docs/commands/credential-stores/read.mdx b/website/content/docs/commands/credential-stores/read.mdx index 7ea2f81416..b52072fa3b 100644 --- a/website/content/docs/commands/credential-stores/read.mdx +++ b/website/content/docs/commands/credential-stores/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credential-stores read - Command description: >- - The "credential-stores read" command reads the details of a credential store resource with a given ID. + The "credential-stores read" command retrieves the details of a credential store resource with a given ID. --- # credential-stores read diff --git a/website/content/docs/commands/credentials/index.mdx b/website/content/docs/commands/credentials/index.mdx index 17ec2e02ad..ad553b2d68 100644 --- a/website/content/docs/commands/credentials/index.mdx +++ b/website/content/docs/commands/credentials/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credentials - Command description: >- - The "credentials" command performs operations on Boundary credential resources. + The "credentials" command performs operations on Boundary credential resources. Credentials contain secrets that bind an identity to a set of permissions. --- # credentials diff --git a/website/content/docs/commands/credentials/read.mdx b/website/content/docs/commands/credentials/read.mdx index 1dc6a6a8a4..2a7a096f1c 100644 --- a/website/content/docs/commands/credentials/read.mdx +++ b/website/content/docs/commands/credentials/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: credentials read - Command description: >- - The "credentials read" command reads the details of an existing credential resource given its ID. + The "credentials read" command retrieves the details of an existing credential resource given its ID. --- # credentials read diff --git a/website/content/docs/commands/groups/read.mdx b/website/content/docs/commands/groups/read.mdx index 0851f207ec..ab28848b2c 100644 --- a/website/content/docs/commands/groups/read.mdx +++ b/website/content/docs/commands/groups/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: groups read - Command description: >- - The "groups read" command reads the details of an existing group resource for a given ID. + The "groups read" command retrieves the details of an existing group resource for a given ID. --- # groups read diff --git a/website/content/docs/commands/host-catalogs/index.mdx b/website/content/docs/commands/host-catalogs/index.mdx index 919f49c9b9..c8c27c6476 100644 --- a/website/content/docs/commands/host-catalogs/index.mdx +++ b/website/content/docs/commands/host-catalogs/index.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: host-catalogs - Command -description: |- +description: >- The "host-catalogs" command performs operations on Boundary host catalog resources. Host catalogs contain hosts and host sets. --- diff --git a/website/content/docs/commands/host-catalogs/read.mdx b/website/content/docs/commands/host-catalogs/read.mdx index d1221c42b6..283748d02e 100644 --- a/website/content/docs/commands/host-catalogs/read.mdx +++ b/website/content/docs/commands/host-catalogs/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: host-catalogs read - Command description: >- - The "host-catalogs read" command reads host catalog information for a host catalog resource with a given ID. + The "host-catalogs read" command retrieves host catalog information for a host catalog resource with a given ID. --- # host-catalogs read diff --git a/website/content/docs/commands/host-sets/read.mdx b/website/content/docs/commands/host-sets/read.mdx index 54746f8d4a..880cb7897c 100644 --- a/website/content/docs/commands/host-sets/read.mdx +++ b/website/content/docs/commands/host-sets/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: host-sets read - Command description: >- - The "host-sets read" command reads the details of an existing host set resource for the given ID. + The "host-sets read" command retrieves the details of an existing host set resource for the given ID. --- # host-sets read diff --git a/website/content/docs/commands/hosts/read.mdx b/website/content/docs/commands/hosts/read.mdx index 09da3bd082..98680dfc03 100644 --- a/website/content/docs/commands/hosts/read.mdx +++ b/website/content/docs/commands/hosts/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: hosts read - Command description: >- - The "hosts read" command reads details about a host resource with a given ID. + The "hosts read" command retrieves details about a host resource with a given ID. --- # hosts read diff --git a/website/content/docs/commands/managed-groups/read.mdx b/website/content/docs/commands/managed-groups/read.mdx index cb78d5a6af..f011817502 100644 --- a/website/content/docs/commands/managed-groups/read.mdx +++ b/website/content/docs/commands/managed-groups/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: managed-groups read - Command description: >- - The "managed-groups read" command reads the details of a managed group resource with a given ID. + The "managed-groups read" command retrieves the details of a managed group resource with a given ID. --- # managed-groups read diff --git a/website/content/docs/commands/policies/read.mdx b/website/content/docs/commands/policies/read.mdx index 46cae5913f..2d8e11aa76 100644 --- a/website/content/docs/commands/policies/read.mdx +++ b/website/content/docs/commands/policies/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: policies read - Command description: >- - The "policies read" command read the details of an existing policy resource with a given ID. + The "policies read" command retrieves the details of an existing policy resource with a given ID. --- # policies read diff --git a/website/content/docs/commands/read.mdx b/website/content/docs/commands/read.mdx index f5c73d6603..7ce9273dd4 100644 --- a/website/content/docs/commands/read.mdx +++ b/website/content/docs/commands/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: read - Command description: >- - The "read" command reads details about existing Boundary resources using the resource's ID. + The "read" command retrieves details about existing Boundary resources using the resource's ID. --- # read diff --git a/website/content/docs/commands/roles/read.mdx b/website/content/docs/commands/roles/read.mdx index b31acb5dc8..5bb120de1e 100644 --- a/website/content/docs/commands/roles/read.mdx +++ b/website/content/docs/commands/roles/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: roles read - Command description: >- - The "roles read" command reads the details of a role resource with a given ID. + The "roles read" command retrieves the details of a role resource with a given ID. --- # roles read diff --git a/website/content/docs/commands/scopes/read.mdx b/website/content/docs/commands/scopes/read.mdx index 5fa609072b..f704f94880 100644 --- a/website/content/docs/commands/scopes/read.mdx +++ b/website/content/docs/commands/scopes/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: scopes read - Command description: >- - The "scopes read" command reads the details about a scope resource using its given ID. + The "scopes read" command retrieves the details about a scope resource using its given ID. --- # scopes read diff --git a/website/content/docs/commands/session-recordings/read.mdx b/website/content/docs/commands/session-recordings/read.mdx index dabc3a22d2..4e11439b96 100644 --- a/website/content/docs/commands/session-recordings/read.mdx +++ b/website/content/docs/commands/session-recordings/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: session-recordings read - Command description: >- - The "session-recordings read" command reads the details of a session recording resource with the given ID. + The "session-recordings read" command retrieves the details of a session recording resource with the given ID. --- # session-recordings read diff --git a/website/content/docs/commands/sessions/read.mdx b/website/content/docs/commands/sessions/read.mdx index 528f46fd87..6ceae26592 100644 --- a/website/content/docs/commands/sessions/read.mdx +++ b/website/content/docs/commands/sessions/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: sessions read - Command description: >- - The "sessions read" command reads the details of a session resources with the given ID. + The "sessions read" command retrieves the details of a session resources with the given ID. --- # sessions read diff --git a/website/content/docs/commands/storage-buckets/read.mdx b/website/content/docs/commands/storage-buckets/read.mdx index 43dab13a41..68704a470d 100644 --- a/website/content/docs/commands/storage-buckets/read.mdx +++ b/website/content/docs/commands/storage-buckets/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: storage-buckets read - Command description: >- - The "storage-buckets read" command reads the details of an existing storage bucket resource with the given ID. + The "storage-buckets read" command retrieves the details of an existing storage bucket resource with the given ID. --- # storage-buckets read diff --git a/website/content/docs/commands/targets/read.mdx b/website/content/docs/commands/targets/read.mdx index 511c134976..24c81ae733 100644 --- a/website/content/docs/commands/targets/read.mdx +++ b/website/content/docs/commands/targets/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: targets read - Command description: >- - The "targets read" command reads the details of a target resource with a given ID. + The "targets read" command retrieves the details of a target resource with a given ID. --- # targets read diff --git a/website/content/docs/commands/users/read.mdx b/website/content/docs/commands/users/read.mdx index d1acd328b0..297c04bea9 100644 --- a/website/content/docs/commands/users/read.mdx +++ b/website/content/docs/commands/users/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: users read - Command description: >- - The `users read` command reads the details about a user resource for the given user ID. + The `users read` command retrieves the details about a user resource for the given user ID. --- # users read diff --git a/website/content/docs/commands/workers/index.mdx b/website/content/docs/commands/workers/index.mdx index 4ae68b6497..191267ff0d 100644 --- a/website/content/docs/commands/workers/index.mdx +++ b/website/content/docs/commands/workers/index.mdx @@ -2,7 +2,7 @@ layout: docs page_title: workers - Command description: >- - The "workers" command performs operations on Boundary worker resources. + The "workers" command performs operations on Boundary worker resources. Workers are primarily used as network proxies. --- # workers diff --git a/website/content/docs/commands/workers/read.mdx b/website/content/docs/commands/workers/read.mdx index 0bb7680d57..d55ee916ec 100644 --- a/website/content/docs/commands/workers/read.mdx +++ b/website/content/docs/commands/workers/read.mdx @@ -2,7 +2,7 @@ layout: docs page_title: workers read - Command description: >- - The "workers read" command reads the details of a worker resource with a given ID. + The "workers read" command retrieves the details of a worker resource with a given ID. --- # workers read