From b442c1fa60c804438e0d3f2734919ee5139d33bf Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Tue, 17 Dec 2024 14:13:18 -0500 Subject: [PATCH] docs: Update meta content - CLI (#5343) * docs: Update meta content - CLI * docs: Edits for consistency * docs: More edits for consistency * Apply batch of suggestions from code review Co-authored-by: Robin Beck * Apply batch suggestions from code review Co-authored-by: Robin Beck * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck --- website/content/docs/commands/accounts/change-password.mdx | 4 ++-- website/content/docs/commands/accounts/create.mdx | 4 ++-- website/content/docs/commands/accounts/delete.mdx | 4 ++-- website/content/docs/commands/accounts/index.mdx | 4 ++-- website/content/docs/commands/accounts/list.mdx | 4 ++-- website/content/docs/commands/accounts/read.mdx | 6 +++--- website/content/docs/commands/accounts/set-password.mdx | 4 ++-- website/content/docs/commands/accounts/update.mdx | 2 +- website/content/docs/commands/aliases/create.mdx | 4 ++-- website/content/docs/commands/aliases/delete.mdx | 6 +++--- website/content/docs/commands/aliases/index.mdx | 4 ++-- website/content/docs/commands/aliases/list.mdx | 4 ++-- website/content/docs/commands/aliases/read.mdx | 4 ++-- website/content/docs/commands/aliases/update.mdx | 4 ++-- website/content/docs/commands/auth-methods/change-state.mdx | 4 ++-- website/content/docs/commands/auth-methods/create.mdx | 4 ++-- website/content/docs/commands/auth-methods/delete.mdx | 4 ++-- website/content/docs/commands/auth-methods/index.mdx | 4 ++-- website/content/docs/commands/auth-methods/list.mdx | 4 ++-- website/content/docs/commands/auth-methods/read.mdx | 4 ++-- website/content/docs/commands/auth-methods/update.mdx | 4 ++-- website/content/docs/commands/auth-tokens/delete.mdx | 4 ++-- website/content/docs/commands/auth-tokens/index.mdx | 4 ++-- website/content/docs/commands/auth-tokens/list.mdx | 4 ++-- website/content/docs/commands/auth-tokens/read.mdx | 4 ++-- website/content/docs/commands/authenticate/index.mdx | 4 ++-- website/content/docs/commands/authenticate/ldap.mdx | 4 ++-- website/content/docs/commands/authenticate/oidc.mdx | 4 ++-- website/content/docs/commands/authenticate/password.mdx | 4 ++-- website/content/docs/commands/billing/index.mdx | 2 +- .../content/docs/commands/billing/monthly-active-users.mdx | 4 ++-- website/content/docs/commands/cache/add-token.mdx | 4 ++-- website/content/docs/commands/cache/index.mdx | 4 ++-- website/content/docs/commands/cache/start.mdx | 4 ++-- website/content/docs/commands/cache/status.mdx | 4 ++-- website/content/docs/commands/cache/stop.mdx | 4 ++-- website/content/docs/commands/config/autocomplete.mdx | 2 +- website/content/docs/commands/config/decrypt.mdx | 4 ++-- website/content/docs/commands/config/encrypt.mdx | 4 ++-- website/content/docs/commands/config/get-token.mdx | 2 +- website/content/docs/commands/config/index.mdx | 4 ++-- website/content/docs/commands/connect/http.mdx | 4 ++-- website/content/docs/commands/connect/index.mdx | 4 ++-- website/content/docs/commands/connect/kube.mdx | 4 ++-- website/content/docs/commands/connect/postgres.mdx | 4 ++-- website/content/docs/commands/connect/rdp.mdx | 4 ++-- website/content/docs/commands/connect/ssh.mdx | 4 ++-- .../content/docs/commands/credential-libraries/create.mdx | 4 ++-- .../content/docs/commands/credential-libraries/delete.mdx | 4 ++-- .../content/docs/commands/credential-libraries/index.mdx | 4 ++-- website/content/docs/commands/credential-libraries/list.mdx | 4 ++-- website/content/docs/commands/credential-libraries/read.mdx | 6 +++--- .../content/docs/commands/credential-libraries/update.mdx | 4 ++-- website/content/docs/commands/credential-stores/create.mdx | 4 ++-- website/content/docs/commands/credential-stores/delete.mdx | 4 ++-- website/content/docs/commands/credential-stores/index.mdx | 4 ++-- website/content/docs/commands/credential-stores/list.mdx | 4 ++-- website/content/docs/commands/credential-stores/read.mdx | 4 ++-- website/content/docs/commands/credential-stores/update.mdx | 4 ++-- website/content/docs/commands/credentials/create.mdx | 4 ++-- website/content/docs/commands/credentials/delete.mdx | 4 ++-- website/content/docs/commands/credentials/index.mdx | 4 ++-- website/content/docs/commands/credentials/list.mdx | 4 ++-- website/content/docs/commands/credentials/read.mdx | 4 ++-- website/content/docs/commands/credentials/update.mdx | 4 ++-- website/content/docs/commands/database/index.mdx | 4 ++-- website/content/docs/commands/database/init.mdx | 2 +- website/content/docs/commands/database/migrate.mdx | 4 ++-- website/content/docs/commands/delete.mdx | 4 ++-- website/content/docs/commands/dev.mdx | 2 +- website/content/docs/commands/groups/add-members.mdx | 4 ++-- website/content/docs/commands/groups/create.mdx | 4 ++-- website/content/docs/commands/groups/delete.mdx | 4 ++-- website/content/docs/commands/groups/index.mdx | 4 ++-- website/content/docs/commands/groups/list.mdx | 4 ++-- website/content/docs/commands/groups/read.mdx | 4 ++-- website/content/docs/commands/groups/remove-members.mdx | 4 ++-- website/content/docs/commands/groups/set-members.mdx | 4 ++-- website/content/docs/commands/groups/update.mdx | 4 ++-- website/content/docs/commands/host-catalogs/create.mdx | 4 ++-- website/content/docs/commands/host-catalogs/delete.mdx | 4 ++-- website/content/docs/commands/host-catalogs/index.mdx | 4 ++-- website/content/docs/commands/host-catalogs/list.mdx | 4 ++-- website/content/docs/commands/host-catalogs/read.mdx | 4 ++-- website/content/docs/commands/host-catalogs/update.mdx | 4 ++-- website/content/docs/commands/host-sets/add-hosts.mdx | 4 ++-- website/content/docs/commands/host-sets/create.mdx | 4 ++-- website/content/docs/commands/host-sets/delete.mdx | 4 ++-- website/content/docs/commands/host-sets/index.mdx | 4 ++-- website/content/docs/commands/host-sets/list.mdx | 4 ++-- website/content/docs/commands/host-sets/read.mdx | 4 ++-- website/content/docs/commands/host-sets/remove-hosts.mdx | 4 ++-- website/content/docs/commands/host-sets/set-hosts.mdx | 4 ++-- website/content/docs/commands/host-sets/update.mdx | 4 ++-- website/content/docs/commands/hosts/create.mdx | 4 ++-- website/content/docs/commands/hosts/delete.mdx | 4 ++-- website/content/docs/commands/hosts/index.mdx | 4 ++-- website/content/docs/commands/hosts/list.mdx | 4 ++-- website/content/docs/commands/hosts/read.mdx | 4 ++-- website/content/docs/commands/hosts/update.mdx | 4 ++-- website/content/docs/commands/index.mdx | 4 ++-- website/content/docs/commands/logout.mdx | 2 +- website/content/docs/commands/managed-groups/create.mdx | 4 ++-- website/content/docs/commands/managed-groups/delete.mdx | 4 ++-- website/content/docs/commands/managed-groups/index.mdx | 4 ++-- website/content/docs/commands/managed-groups/list.mdx | 4 ++-- website/content/docs/commands/managed-groups/read.mdx | 4 ++-- website/content/docs/commands/managed-groups/update.mdx | 4 ++-- website/content/docs/commands/policies/create.mdx | 4 ++-- website/content/docs/commands/policies/delete.mdx | 4 ++-- website/content/docs/commands/policies/index.mdx | 4 ++-- website/content/docs/commands/policies/list.mdx | 4 ++-- website/content/docs/commands/policies/read.mdx | 4 ++-- website/content/docs/commands/policies/update.mdx | 4 ++-- website/content/docs/commands/read.mdx | 4 ++-- website/content/docs/commands/roles/add-grant-scopes.mdx | 4 ++-- website/content/docs/commands/roles/add-grants.mdx | 4 ++-- website/content/docs/commands/roles/add-principals.mdx | 4 ++-- website/content/docs/commands/roles/create.mdx | 4 ++-- website/content/docs/commands/roles/delete.mdx | 4 ++-- website/content/docs/commands/roles/index.mdx | 4 ++-- website/content/docs/commands/roles/list.mdx | 4 ++-- website/content/docs/commands/roles/read.mdx | 4 ++-- website/content/docs/commands/roles/remove-grant-scopes.mdx | 4 ++-- website/content/docs/commands/roles/remove-grants.mdx | 4 ++-- website/content/docs/commands/roles/remove-principals.mdx | 4 ++-- website/content/docs/commands/roles/set-grant-scopes.mdx | 4 ++-- website/content/docs/commands/roles/set-grants.mdx | 4 ++-- website/content/docs/commands/roles/set-principals.mdx | 4 ++-- website/content/docs/commands/roles/update.mdx | 4 ++-- website/content/docs/commands/scopes/create.mdx | 4 ++-- website/content/docs/commands/scopes/delete.mdx | 4 ++-- .../content/docs/commands/scopes/destroy-key-version.mdx | 4 ++-- website/content/docs/commands/scopes/index.mdx | 4 ++-- .../commands/scopes/list-key-version-destruction-jobs.mdx | 4 ++-- website/content/docs/commands/scopes/list-keys.mdx | 4 ++-- website/content/docs/commands/scopes/list.mdx | 4 ++-- website/content/docs/commands/scopes/read.mdx | 4 ++-- website/content/docs/commands/scopes/rotate-keys.mdx | 4 ++-- website/content/docs/commands/scopes/update.mdx | 4 ++-- website/content/docs/commands/search/index.mdx | 4 ++-- website/content/docs/commands/server.mdx | 4 ++-- website/content/docs/commands/session-recordings/delete.mdx | 4 ++-- .../content/docs/commands/session-recordings/download.mdx | 4 ++-- website/content/docs/commands/session-recordings/index.mdx | 4 ++-- website/content/docs/commands/session-recordings/list.mdx | 4 ++-- website/content/docs/commands/session-recordings/read.mdx | 4 ++-- .../commands/session-recordings/reapply-storage-policy.mdx | 4 ++-- website/content/docs/commands/sessions/cancel.mdx | 4 ++-- website/content/docs/commands/sessions/index.mdx | 4 ++-- website/content/docs/commands/sessions/list.mdx | 4 ++-- website/content/docs/commands/sessions/read.mdx | 4 ++-- website/content/docs/commands/storage-buckets/create.mdx | 4 ++-- website/content/docs/commands/storage-buckets/delete.mdx | 4 ++-- website/content/docs/commands/storage-buckets/index.mdx | 4 ++-- website/content/docs/commands/storage-buckets/list.mdx | 4 ++-- website/content/docs/commands/storage-buckets/read.mdx | 4 ++-- website/content/docs/commands/storage-buckets/update.mdx | 4 ++-- .../docs/commands/targets/add-credential-sources.mdx | 4 ++-- website/content/docs/commands/targets/add-host-sources.mdx | 4 ++-- website/content/docs/commands/targets/authorize-session.mdx | 4 ++-- website/content/docs/commands/targets/create.mdx | 4 ++-- website/content/docs/commands/targets/delete.mdx | 4 ++-- website/content/docs/commands/targets/index.mdx | 4 ++-- website/content/docs/commands/targets/list.mdx | 4 ++-- website/content/docs/commands/targets/read.mdx | 4 ++-- .../docs/commands/targets/remove-credential-sources.mdx | 4 ++-- .../content/docs/commands/targets/remove-host-sources.mdx | 4 ++-- .../docs/commands/targets/set-credential-sources.mdx | 4 ++-- website/content/docs/commands/targets/set-host-sources.mdx | 4 ++-- website/content/docs/commands/targets/update.mdx | 4 ++-- website/content/docs/commands/update.mdx | 4 ++-- website/content/docs/commands/users/add-accounts.mdx | 4 ++-- website/content/docs/commands/users/create.mdx | 4 ++-- website/content/docs/commands/users/delete.mdx | 4 ++-- website/content/docs/commands/users/index.mdx | 4 ++-- website/content/docs/commands/users/list.mdx | 4 ++-- website/content/docs/commands/users/read.mdx | 4 ++-- website/content/docs/commands/users/remove-accounts.mdx | 4 ++-- website/content/docs/commands/users/set-accounts.mdx | 4 ++-- website/content/docs/commands/users/update.mdx | 4 ++-- website/content/docs/commands/workers/add-worker-tags.mdx | 4 ++-- .../content/docs/commands/workers/certificate-authority.mdx | 4 ++-- website/content/docs/commands/workers/create.mdx | 4 ++-- website/content/docs/commands/workers/delete.mdx | 4 ++-- website/content/docs/commands/workers/index.mdx | 4 ++-- website/content/docs/commands/workers/list.mdx | 4 ++-- website/content/docs/commands/workers/read.mdx | 4 ++-- .../content/docs/commands/workers/remove-worker-tags.mdx | 4 ++-- website/content/docs/commands/workers/set-worker-tags.mdx | 4 ++-- website/content/docs/commands/workers/update.mdx | 4 ++-- 191 files changed, 378 insertions(+), 378 deletions(-) diff --git a/website/content/docs/commands/accounts/change-password.mdx b/website/content/docs/commands/accounts/change-password.mdx index d96bc8389..edd4e2e34 100644 --- a/website/content/docs/commands/accounts/change-password.mdx +++ b/website/content/docs/commands/accounts/change-password.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts change-password - Command -description: |- - The "accounts change-password" command lets Boundary admin change the password for an account. +description: >- + The "accounts change-password" command resets the password on account resources. --- # accounts change-password diff --git a/website/content/docs/commands/accounts/create.mdx b/website/content/docs/commands/accounts/create.mdx index 1ed892491..70b89e0de 100644 --- a/website/content/docs/commands/accounts/create.mdx +++ b/website/content/docs/commands/accounts/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts create - Command -description: |- - The "accounts create" command lets Boundary admin create a new account resource. +description: >- + The "accounts create" command creates a new account resource and associates it with an auth method. --- # accounts create diff --git a/website/content/docs/commands/accounts/delete.mdx b/website/content/docs/commands/accounts/delete.mdx index ca7bc0cce..a54605224 100644 --- a/website/content/docs/commands/accounts/delete.mdx +++ b/website/content/docs/commands/accounts/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts delete - Command -description: |- - The "accounts delete" command lets Boundary admin delete an account resource. +description: >- + The "accounts delete" command deletes an existing account resource. --- # accounts delete diff --git a/website/content/docs/commands/accounts/index.mdx b/website/content/docs/commands/accounts/index.mdx index 50899223a..83c156dad 100644 --- a/website/content/docs/commands/accounts/index.mdx +++ b/website/content/docs/commands/accounts/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts - Command -description: |- - The "accounts" command lets Boundary admin create and manage account resources. +description: >- + The "accounts" command performs operations on account resources. You can associate users with accounts using auth methods. --- # accounts diff --git a/website/content/docs/commands/accounts/list.mdx b/website/content/docs/commands/accounts/list.mdx index 4ddfcdcc5..a65604e26 100644 --- a/website/content/docs/commands/accounts/list.mdx +++ b/website/content/docs/commands/accounts/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts list - Command -description: |- - The "accounts list" command lets Boundary admin list an account resource. +description: >- + The "accounts list" command lists the available accounts that were created for an auth method. --- # accounts list diff --git a/website/content/docs/commands/accounts/read.mdx b/website/content/docs/commands/accounts/read.mdx index 1703f5eb7..6653ce19b 100644 --- a/website/content/docs/commands/accounts/read.mdx +++ b/website/content/docs/commands/accounts/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts read - Command -description: |- - The "accounts read" command lets Boundary admin read an account resource. +description: >- + The "accounts read" command retrieves the account details for an account. --- # accounts read @@ -67,4 +67,4 @@ $ boundary accounts read [options] [args] - `-id` `(string: "")` - The ID of the account to read. -@include 'cmd-option-note.mdx' \ No newline at end of file +@include 'cmd-option-note.mdx' diff --git a/website/content/docs/commands/accounts/set-password.mdx b/website/content/docs/commands/accounts/set-password.mdx index 861cc6f49..5034e3573 100644 --- a/website/content/docs/commands/accounts/set-password.mdx +++ b/website/content/docs/commands/accounts/set-password.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: accounts set-password - Command -description: |- - The "accounts set-password" command lets Boundary admin set the password for an account. +description: >- + The "accounts set-password" command sets the password for account resources. --- # accounts set-password diff --git a/website/content/docs/commands/accounts/update.mdx b/website/content/docs/commands/accounts/update.mdx index ca9235b58..2bcf12f0a 100644 --- a/website/content/docs/commands/accounts/update.mdx +++ b/website/content/docs/commands/accounts/update.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: accounts update - Command -description: |- +description: >- The "accounts update" command updates an existing account resource's LDAP, OIDC, or password authentication information. --- diff --git a/website/content/docs/commands/aliases/create.mdx b/website/content/docs/commands/aliases/create.mdx index 90731866b..875f8b6f4 100644 --- a/website/content/docs/commands/aliases/create.mdx +++ b/website/content/docs/commands/aliases/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: aliases create - Command -description: |- - The "aliases create" command lets you create a new alias. +description: >- + The "aliases create" command creates a new alias resource for a target. --- # aliases create diff --git a/website/content/docs/commands/aliases/delete.mdx b/website/content/docs/commands/aliases/delete.mdx index 94675acae..fcfbf2d9b 100644 --- a/website/content/docs/commands/aliases/delete.mdx +++ b/website/content/docs/commands/aliases/delete.mdx @@ -1,15 +1,15 @@ --- layout: docs page_title: aliases delete - Command -description: |- - The "aliases delete" command lets you delete an alias. +description: >- + The "aliases delete" command deletes an existing alias resource. --- # aliases delete Command: `aliases delete` -The `aliases delete` command lets you delete a target. +The `aliases delete` command lets you delete an alias. ## Example diff --git a/website/content/docs/commands/aliases/index.mdx b/website/content/docs/commands/aliases/index.mdx index fbbc19420..16faba53d 100644 --- a/website/content/docs/commands/aliases/index.mdx +++ b/website/content/docs/commands/aliases/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: aliases - Command -description: |- - The "aliases" command lets Boundary admin create and manage alias resources. +description: >- + 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/list.mdx b/website/content/docs/commands/aliases/list.mdx index 270002a80..d1055fc07 100644 --- a/website/content/docs/commands/aliases/list.mdx +++ b/website/content/docs/commands/aliases/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: aliases list - Command -description: |- - The "aliases list" command lists the aliases within a given scope or resource. +description: >- + The "aliases list" command lists the available alias resources within a scope or resource. --- # aliases list diff --git a/website/content/docs/commands/aliases/read.mdx b/website/content/docs/commands/aliases/read.mdx index b5cfcdca5..246fc35f5 100644 --- a/website/content/docs/commands/aliases/read.mdx +++ b/website/content/docs/commands/aliases/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: aliases read - Command -description: |- - The "aliases read" command reads an alias with a given ID. +description: >- + The "aliases read" command retrieves the details of an alias resource. --- # aliases read diff --git a/website/content/docs/commands/aliases/update.mdx b/website/content/docs/commands/aliases/update.mdx index efbc8cdac..04113957b 100644 --- a/website/content/docs/commands/aliases/update.mdx +++ b/website/content/docs/commands/aliases/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: aliases update - Command -description: |- - The "aliases update" command lets you update an alias. +description: >- + The "aliases update" command updates an existing alias resource with new information. --- # aliases update diff --git a/website/content/docs/commands/auth-methods/change-state.mdx b/website/content/docs/commands/auth-methods/change-state.mdx index 72386eed6..cba3b8189 100644 --- a/website/content/docs/commands/auth-methods/change-state.mdx +++ b/website/content/docs/commands/auth-methods/change-state.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods change-state - Command -description: |- - The "auth-methods change-state" command lets Boundary admin change the state of an auth method. +description: >- + The "auth-methods change-state" command changes the active and visibility state of an OIDC-type auth method resource. --- # auth-methods change-state diff --git a/website/content/docs/commands/auth-methods/create.mdx b/website/content/docs/commands/auth-methods/create.mdx index 810c9a0b1..b466c3b85 100644 --- a/website/content/docs/commands/auth-methods/create.mdx +++ b/website/content/docs/commands/auth-methods/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods create - Command -description: |- - The "auth-methods create" command creates auth method resources in Boundary. You can create LDAP, OIDC, and password auth method types. +description: >- + The "auth-methods create" command creates new auth method resources. You can create LDAP, OIDC, and password auth method types. --- # auth-methods create diff --git a/website/content/docs/commands/auth-methods/delete.mdx b/website/content/docs/commands/auth-methods/delete.mdx index 5a55bbbe5..120888fa0 100644 --- a/website/content/docs/commands/auth-methods/delete.mdx +++ b/website/content/docs/commands/auth-methods/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods delete - Command -description: |- - The "auth-methods delete" command lets Boundary admin delete an auth method. +description: >- + 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 e94918161..6b01fccb1 100644 --- a/website/content/docs/commands/auth-methods/index.mdx +++ b/website/content/docs/commands/auth-methods/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods - Command -description: |- - The "auth-methods" command lets you create and manage Boundary authentication method configuration. +description: >- + 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/list.mdx b/website/content/docs/commands/auth-methods/list.mdx index f97485914..16b41f84b 100644 --- a/website/content/docs/commands/auth-methods/list.mdx +++ b/website/content/docs/commands/auth-methods/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods list - Command -description: |- - The "auth-methods list" command lets Boundary admin list available auth methods. +description: >- + The "auth-methods list" command lists the available auth method resources within a scope or resource. --- # auth-methods list diff --git a/website/content/docs/commands/auth-methods/read.mdx b/website/content/docs/commands/auth-methods/read.mdx index 188aca820..c53a92bf2 100644 --- a/website/content/docs/commands/auth-methods/read.mdx +++ b/website/content/docs/commands/auth-methods/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods read - Command -description: |- - The "auth-methods read" command lets Boundary admin read an auth method. +description: >- + The "auth-methods read" command retrieves the details for an auth method resource. --- # auth-methods read diff --git a/website/content/docs/commands/auth-methods/update.mdx b/website/content/docs/commands/auth-methods/update.mdx index f96891ae4..400617bba 100644 --- a/website/content/docs/commands/auth-methods/update.mdx +++ b/website/content/docs/commands/auth-methods/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-methods update - Command -description: |- - The "auth-methods update" command updates existing auth method resources in Boundary. You can update LDAP, OIDC, and password auth method types. +description: >- + The "auth-methods update" command updates existing auth method resources. You can update LDAP, OIDC, and password auth method types. --- # auth-methods update diff --git a/website/content/docs/commands/auth-tokens/delete.mdx b/website/content/docs/commands/auth-tokens/delete.mdx index e6e747d18..768002d00 100644 --- a/website/content/docs/commands/auth-tokens/delete.mdx +++ b/website/content/docs/commands/auth-tokens/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-tokens delete - Command -description: |- - The "auth-tokens delete" command allows Boundary admin to delete an auth token. +description: >- + The "auth-tokens delete" command deletes an existing auth token resource. --- # auth-tokens delete diff --git a/website/content/docs/commands/auth-tokens/index.mdx b/website/content/docs/commands/auth-tokens/index.mdx index 87686984a..ccc291dc6 100644 --- a/website/content/docs/commands/auth-tokens/index.mdx +++ b/website/content/docs/commands/auth-tokens/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-tokens - Command -description: |- - The "auth-tokens" command allows operations on Boundary auth token resources. +description: >- + The "auth-tokens" command peforms operations on auth token resources. --- # auth-tokens diff --git a/website/content/docs/commands/auth-tokens/list.mdx b/website/content/docs/commands/auth-tokens/list.mdx index 78da5a5d4..e6b7f2ddd 100644 --- a/website/content/docs/commands/auth-tokens/list.mdx +++ b/website/content/docs/commands/auth-tokens/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-tokens list - Command -description: |- - The "auth-tokens list" command allows Boundary admin to list available auth tokens. +description: >- + The "auth-tokens list" command lists the available auth token resources within an enclosing scope or resource. --- # auth-tokens list diff --git a/website/content/docs/commands/auth-tokens/read.mdx b/website/content/docs/commands/auth-tokens/read.mdx index 1e26deeb3..74def8a07 100644 --- a/website/content/docs/commands/auth-tokens/read.mdx +++ b/website/content/docs/commands/auth-tokens/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: auth-tokens read - Command -description: |- - The "auth-tokens read" command allows Boundary admin to read an auth token. +description: >- + The "auth-tokens read" command retrieves the details for an auth token resource. --- # auth-tokens read diff --git a/website/content/docs/commands/authenticate/index.mdx b/website/content/docs/commands/authenticate/index.mdx index 623298f16..866b6f685 100644 --- a/website/content/docs/commands/authenticate/index.mdx +++ b/website/content/docs/commands/authenticate/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: authenticate - Command -description: |- - The "authenticate" command authenticates the Boundary command line client using a specified auth method. +description: >- + The "authenticate" command authenticates the CLI client using the specified auth method. --- # authenticate diff --git a/website/content/docs/commands/authenticate/ldap.mdx b/website/content/docs/commands/authenticate/ldap.mdx index 8c7cbdbe7..81bbca3f9 100644 --- a/website/content/docs/commands/authenticate/ldap.mdx +++ b/website/content/docs/commands/authenticate/ldap.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: authenticate ldap - Command -description: |- - The "authenticate ldap" command invokes the ldap auth method to authenticate the Boundary CLI. +description: >- + The "authenticate ldap" command invokes the LDAP auth method to authenticate the CLI client. --- # authenticate ldap diff --git a/website/content/docs/commands/authenticate/oidc.mdx b/website/content/docs/commands/authenticate/oidc.mdx index 6c2a8d067..7981e9852 100644 --- a/website/content/docs/commands/authenticate/oidc.mdx +++ b/website/content/docs/commands/authenticate/oidc.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: authenticate oidc - Command -description: |- - The "authenticate oidc" command invokes the OIDC auth method to authenticate the Boundary CLI. +description: >- + The "authenticate oidc" command invokes the OIDC auth method to authenticate the CLI client. --- # authenticate oidc diff --git a/website/content/docs/commands/authenticate/password.mdx b/website/content/docs/commands/authenticate/password.mdx index d798d0ef1..dd6c87bec 100644 --- a/website/content/docs/commands/authenticate/password.mdx +++ b/website/content/docs/commands/authenticate/password.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: authenticate password - Command -description: |- - The "authenticate password" command invokes the password auth method to authenticate the Boundary CLI. +description: >- + The "authenticate password" command invokes the password auth method to authenticate the CLI client. --- # authenticate password diff --git a/website/content/docs/commands/billing/index.mdx b/website/content/docs/commands/billing/index.mdx index 09734214e..6e07a3537 100644 --- a/website/content/docs/commands/billing/index.mdx +++ b/website/content/docs/commands/billing/index.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: billing - Command -description: |- +description: >- The "billing" command retrieves the number of active users to help you predict user-based pricing. --- diff --git a/website/content/docs/commands/billing/monthly-active-users.mdx b/website/content/docs/commands/billing/monthly-active-users.mdx index f1712f125..59381c1b9 100644 --- a/website/content/docs/commands/billing/monthly-active-users.mdx +++ b/website/content/docs/commands/billing/monthly-active-users.mdx @@ -1,8 +1,8 @@ --- 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. +description: >- + 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/cache/add-token.mdx b/website/content/docs/commands/cache/add-token.mdx index 075298f53..7c2adb5ed 100644 --- a/website/content/docs/commands/cache/add-token.mdx +++ b/website/content/docs/commands/cache/add-token.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: cache add-token - Command -description: |- - The "cache add-token" command lets you add an auth token to a Boundary cache that is running. +description: >- + The "cache add-token" command adds an auth token resource to the Boundary cache. --- # cache add-token diff --git a/website/content/docs/commands/cache/index.mdx b/website/content/docs/commands/cache/index.mdx index ba9f87194..901852091 100644 --- a/website/content/docs/commands/cache/index.mdx +++ b/website/content/docs/commands/cache/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: cache - Command -description: |- - Boundary's "cache" command lets you manage a local cache of information to facilitate searches and protect your system resources from being overwhelmed. +description: >- + The "cache" command performs operations on a local cache that facilitates searches and protects your system resources from being overwhelmed. --- # cache diff --git a/website/content/docs/commands/cache/start.mdx b/website/content/docs/commands/cache/start.mdx index ce2b4c713..6599f1218 100644 --- a/website/content/docs/commands/cache/start.mdx +++ b/website/content/docs/commands/cache/start.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: cache start - Command -description: |- - The "cache start" command lets you manually start the Boundary cache and customize the behavior of the local cache. +description: >- + The "cache start" command starts the Boundary cache and determines the behavior of the local cache. You can customize log, search, and refresh settings. --- # cache start diff --git a/website/content/docs/commands/cache/status.mdx b/website/content/docs/commands/cache/status.mdx index 1ef5b2f06..eb99ed47d 100644 --- a/website/content/docs/commands/cache/status.mdx +++ b/website/content/docs/commands/cache/status.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: cache status - Command -description: |- - The "cache status" command lets you manually check the status of the Boundary cache. +description: >- + The "cache status" command checks the status of the Boundary cache and reports on configuration, user, and resource information. --- # cache status diff --git a/website/content/docs/commands/cache/stop.mdx b/website/content/docs/commands/cache/stop.mdx index e99248c28..488ab25cc 100644 --- a/website/content/docs/commands/cache/stop.mdx +++ b/website/content/docs/commands/cache/stop.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: cache stop - Command -description: |- - The "cache stop" command lets you manually stop the Boundary cache. +description: >- + The "cache stop" command stops the Boundary cache. --- # cache stop diff --git a/website/content/docs/commands/config/autocomplete.mdx b/website/content/docs/commands/config/autocomplete.mdx index f916d92c9..bfa83418e 100644 --- a/website/content/docs/commands/config/autocomplete.mdx +++ b/website/content/docs/commands/config/autocomplete.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: config autocomplete - Command -description: |- +description: >- The "config autocomplete" command installs or uninstalls autocompletion support for Boundary's CLI. --- diff --git a/website/content/docs/commands/config/decrypt.mdx b/website/content/docs/commands/config/decrypt.mdx index 70ba986ed..bcdd76080 100644 --- a/website/content/docs/commands/config/decrypt.mdx +++ b/website/content/docs/commands/config/decrypt.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: config decrypt - Command -description: |- - The "config decrypt" command decrypts sensitive values in a Boundary's configuration file. These values must be marked with {{decrypt()}} as appropriate. +description: >- + The "config decrypt" command decrypts sensitive values in configuration files. You must mark sensitive values with {{decrypt()}} as appropriate. --- # config decrypt diff --git a/website/content/docs/commands/config/encrypt.mdx b/website/content/docs/commands/config/encrypt.mdx index 1b4b1e5a7..af611c255 100644 --- a/website/content/docs/commands/config/encrypt.mdx +++ b/website/content/docs/commands/config/encrypt.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: config encrypt - Command -description: |- - The "config encrypt" command encrypts sensitive values in a Boundary's configuration file. These values must be marked with {{encrypt()}} as appropriate. +description: >- + The "config encrypt" command encrypts sensitive values in configuration files. You must mark sensitive values with {{encrypt()}} as appropriate. --- # config encrypt diff --git a/website/content/docs/commands/config/get-token.mdx b/website/content/docs/commands/config/get-token.mdx index 94852dbcd..d4d781250 100644 --- a/website/content/docs/commands/config/get-token.mdx +++ b/website/content/docs/commands/config/get-token.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: config get-token - Command -description: |- +description: >- The "config get-token" command fetches a token stored by the Boundary CLI. --- diff --git a/website/content/docs/commands/config/index.mdx b/website/content/docs/commands/config/index.mdx index 38168a81a..345329a69 100644 --- a/website/content/docs/commands/config/index.mdx +++ b/website/content/docs/commands/config/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: config - Command -description: |- - The "config" command groups subcommands for operators to interact with Boundary's configuration files. +description: >- + The "config" command groups subcommands that interact with Boundary's configuration files. --- # config diff --git a/website/content/docs/commands/connect/http.mdx b/website/content/docs/commands/connect/http.mdx index 3149520b5..e8b7b71b0 100644 --- a/website/content/docs/commands/connect/http.mdx +++ b/website/content/docs/commands/connect/http.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect http - Command -description: |- - The "connect http" command command performs a target authorization or consumes an existing authorization token, and launches a proxied http connection. +description: >- + The "connect http" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied http connection. --- # connect http diff --git a/website/content/docs/commands/connect/index.mdx b/website/content/docs/commands/connect/index.mdx index 3eb513a30..119384cab 100644 --- a/website/content/docs/commands/connect/index.mdx +++ b/website/content/docs/commands/connect/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect - Command -description: |- - The "connect" command allows Boundary admin to authorize a target and launch a proxied connection. +description: >- + The "connect" command authorizes a target resource and launches a proxied connection. --- # connect diff --git a/website/content/docs/commands/connect/kube.mdx b/website/content/docs/commands/connect/kube.mdx index 359297e67..1369fe09f 100644 --- a/website/content/docs/commands/connect/kube.mdx +++ b/website/content/docs/commands/connect/kube.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect kube - Command -description: |- - The "connect kube" command command performs a target authorization or consumes an existing authorization token, and launches a proxied kube connection. +description: >- + The "connect kube" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied kube connection. --- # connect kube diff --git a/website/content/docs/commands/connect/postgres.mdx b/website/content/docs/commands/connect/postgres.mdx index de37e4f37..c37e641de 100644 --- a/website/content/docs/commands/connect/postgres.mdx +++ b/website/content/docs/commands/connect/postgres.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect postgres - Command -description: |- - The "connect postgres" command performs a target authorization or consumes an existing authorization token, and launches a proxied postgres connection. +description: >- + The "connect postgres" command performs a target authorization or consumes an existing authorization token, and then launches a proxied PostgreSQL connection. --- # connect postgres diff --git a/website/content/docs/commands/connect/rdp.mdx b/website/content/docs/commands/connect/rdp.mdx index 8e0d6d73f..21428442a 100644 --- a/website/content/docs/commands/connect/rdp.mdx +++ b/website/content/docs/commands/connect/rdp.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect rdp - Command -description: |- - The "connect rdp" command command performs a target authorization or consumes an existing authorization token, and launches a proxied rdp connection. +description: >- + The "connect rdp" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied RDP connection. --- # connect rdp diff --git a/website/content/docs/commands/connect/ssh.mdx b/website/content/docs/commands/connect/ssh.mdx index 47af082e1..9af152472 100644 --- a/website/content/docs/commands/connect/ssh.mdx +++ b/website/content/docs/commands/connect/ssh.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: connect ssh - Command -description: |- - The "connect ssh" command command performs a target authorization or consumes an existing authorization token, and launches a proxied SSH connection. +description: >- + The "connect ssh" command command performs a target authorization or consumes an existing authorization token, and then launches a proxied SSH connection. --- # connect ssh diff --git a/website/content/docs/commands/credential-libraries/create.mdx b/website/content/docs/commands/credential-libraries/create.mdx index 154f80835..55e49453e 100644 --- a/website/content/docs/commands/credential-libraries/create.mdx +++ b/website/content/docs/commands/credential-libraries/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-libraries create - Command -description: |- - The "credential-libraries create" command lets you create Boundary credential library resources. +description: >- + The "credential-libraries create" command creates new credential library resources. You can create a generic Vault or Vault SSH certificate credential library. --- # credential-libraries create diff --git a/website/content/docs/commands/credential-libraries/delete.mdx b/website/content/docs/commands/credential-libraries/delete.mdx index 09a133b8c..6b395b5bc 100644 --- a/website/content/docs/commands/credential-libraries/delete.mdx +++ b/website/content/docs/commands/credential-libraries/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-libraries delete - Command -description: |- - The "credential-libraries delete" command lets Boundary admin delete a credential library resource. +description: >- + The "credential-libraries delete" command deletes an existing credential library resource. --- # credential-libraries delete diff --git a/website/content/docs/commands/credential-libraries/index.mdx b/website/content/docs/commands/credential-libraries/index.mdx index 3be2a2adc..048f25188 100644 --- a/website/content/docs/commands/credential-libraries/index.mdx +++ b/website/content/docs/commands/credential-libraries/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-libraries - Command -description: |- - The "credential-libraries" command lets Boundary admin create and manage credential libraries. +description: >- + 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/list.mdx b/website/content/docs/commands/credential-libraries/list.mdx index 394d00d7e..3e84e6f74 100644 --- a/website/content/docs/commands/credential-libraries/list.mdx +++ b/website/content/docs/commands/credential-libraries/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-libraries list - Command -description: |- - The "credential-libraries list" command lists credential libraries within an enclosing scope or resource. +description: >- + The "credential-libraries list" command lists the available credential library resources within an enclosing scope or resource. --- # credential-libraries list diff --git a/website/content/docs/commands/credential-libraries/read.mdx b/website/content/docs/commands/credential-libraries/read.mdx index b3692c80a..d97d4f880 100644 --- a/website/content/docs/commands/credential-libraries/read.mdx +++ b/website/content/docs/commands/credential-libraries/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-libraries read - Command -description: |- - The "credential-libraries read" command lets Boundary admin read credential library information. +description: >- + The "credential-libraries read" command retrieves the details of a credential library. --- # credential-libraries read @@ -68,4 +68,4 @@ $ boundary credential-libraries read [options] [args] - `-id` `(string: "")` - The ID of the credential library from which to read information. -@include 'cmd-option-note.mdx' \ No newline at end of file +@include 'cmd-option-note.mdx' diff --git a/website/content/docs/commands/credential-libraries/update.mdx b/website/content/docs/commands/credential-libraries/update.mdx index 6cc8ed6bf..db86f845e 100644 --- a/website/content/docs/commands/credential-libraries/update.mdx +++ b/website/content/docs/commands/credential-libraries/update.mdx @@ -1,8 +1,8 @@ --- layout: doc page_title: credential-libraries update - Command -description: |- - The "credential-libraries update" command lets Boundary admin update a credential library resource. +description: >- + The "credential-libraries update" command updates an existing credential library resource with new information. --- # credential-libraries update diff --git a/website/content/docs/commands/credential-stores/create.mdx b/website/content/docs/commands/credential-stores/create.mdx index e90d6dd1c..1e6eef73d 100644 --- a/website/content/docs/commands/credential-stores/create.mdx +++ b/website/content/docs/commands/credential-stores/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-stores create - Command -description: |- - The "credential-stores create" command lets you create Boundary credential store resources. +description: >- + The "credential-stores create" command creates new credential store resources. You can create static or Vault credential stores to manage credentials. --- # credential-stores create diff --git a/website/content/docs/commands/credential-stores/delete.mdx b/website/content/docs/commands/credential-stores/delete.mdx index c103d09bd..c4563df2b 100644 --- a/website/content/docs/commands/credential-stores/delete.mdx +++ b/website/content/docs/commands/credential-stores/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-stores delete - Command -description: |- - The "credential-stores delete" command lets Boundary admin delete a credential store resource. +description: >- + The "credential-stores delete" command deletes an existing credential store resource. --- # credential-stores delete diff --git a/website/content/docs/commands/credential-stores/index.mdx b/website/content/docs/commands/credential-stores/index.mdx index 95da35d76..a62ed2303 100644 --- a/website/content/docs/commands/credential-stores/index.mdx +++ b/website/content/docs/commands/credential-stores/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-stores - Command -description: |- - The "credential-stores" command lets Boundary admin create and manage credential stores. +description: >- + 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/list.mdx b/website/content/docs/commands/credential-stores/list.mdx index b48889b82..285b452be 100644 --- a/website/content/docs/commands/credential-stores/list.mdx +++ b/website/content/docs/commands/credential-stores/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-stores list - Command -description: |- - The "credential-stores list" command lists credential stores within an enclosing scope or resource. +description: >- + The "credential-stores list" command lists the available credential store resources within an enclosing scope or resource. --- # credential-stores list diff --git a/website/content/docs/commands/credential-stores/read.mdx b/website/content/docs/commands/credential-stores/read.mdx index 29ad09eb7..7b731dd42 100644 --- a/website/content/docs/commands/credential-stores/read.mdx +++ b/website/content/docs/commands/credential-stores/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credential-stores read - Command -description: |- - The "credential-stores read" command lets Boundary admin read credential store information. +description: >- + The "credential-stores read" command retrieves the details of a credential store resource. --- # credential-stores read diff --git a/website/content/docs/commands/credential-stores/update.mdx b/website/content/docs/commands/credential-stores/update.mdx index 57d1d6e1a..0c19796a8 100644 --- a/website/content/docs/commands/credential-stores/update.mdx +++ b/website/content/docs/commands/credential-stores/update.mdx @@ -1,8 +1,8 @@ --- layout: doc page_title: credential-stores update - Command -description: |- - The "credential-stores update" command lets Boundary admin update a credential store resource. +description: >- + The "credential-stores update" command updates an existing credential store resource. --- # credential-stores update diff --git a/website/content/docs/commands/credentials/create.mdx b/website/content/docs/commands/credentials/create.mdx index 41c356516..c06bb3bce 100644 --- a/website/content/docs/commands/credentials/create.mdx +++ b/website/content/docs/commands/credentials/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credentials create - Command -description: |- - The "credentials create" command lets you create Boundary credential resources. +description: >- + The "credentials create" command creates new credential resources. You can create JSON, SSH private key, and username-password credentials. --- # credentials create diff --git a/website/content/docs/commands/credentials/delete.mdx b/website/content/docs/commands/credentials/delete.mdx index 4eb4a477a..8e4996661 100644 --- a/website/content/docs/commands/credentials/delete.mdx +++ b/website/content/docs/commands/credentials/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credentials delete - Command -description: |- - The "credentials delete" command lets Boundary admin delete a credential resource. +description: >- + The "credentials delete" command deletes an existing credential resource. --- # credentials delete diff --git a/website/content/docs/commands/credentials/index.mdx b/website/content/docs/commands/credentials/index.mdx index 428bd956c..ad553b2d6 100644 --- a/website/content/docs/commands/credentials/index.mdx +++ b/website/content/docs/commands/credentials/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credentials - Command -description: |- - The "credentials" command lets you create and manage Boundary credential resources. +description: >- + 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/list.mdx b/website/content/docs/commands/credentials/list.mdx index 19558ac84..892fb24fe 100644 --- a/website/content/docs/commands/credentials/list.mdx +++ b/website/content/docs/commands/credentials/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credentials list - Command -description: |- - The "credentials list" command lists credentials within an enclosing scope or resource. +description: >- + The "credentials list" command lists the available credential resources within an enclosing scope or resource. --- # credentials list diff --git a/website/content/docs/commands/credentials/read.mdx b/website/content/docs/commands/credentials/read.mdx index 03f740b76..12b8d82d9 100644 --- a/website/content/docs/commands/credentials/read.mdx +++ b/website/content/docs/commands/credentials/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: credentials read - Command -description: |- - The "credentials read" command reads information for a credential given its ID. +description: >- + The "credentials read" command retrieves the details of an existing credential resource. --- # credentials read diff --git a/website/content/docs/commands/credentials/update.mdx b/website/content/docs/commands/credentials/update.mdx index 9ab27adbc..39de70754 100644 --- a/website/content/docs/commands/credentials/update.mdx +++ b/website/content/docs/commands/credentials/update.mdx @@ -1,8 +1,8 @@ --- layout: doc page_title: credentials update - Command -description: |- - The "credentials update" command lets Boundary admin update a credential resource. +description: >- + The "credentials update" command updates an existing credential resource. --- # credentials update diff --git a/website/content/docs/commands/database/index.mdx b/website/content/docs/commands/database/index.mdx index a655f3cab..eefa8d622 100644 --- a/website/content/docs/commands/database/index.mdx +++ b/website/content/docs/commands/database/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: database - Command -description: |- - The "database" command allows operations on Boundary's database. +description: >- + The "database" command performs operations on Boundary's database. You can initialize or migrate the database. --- # database diff --git a/website/content/docs/commands/database/init.mdx b/website/content/docs/commands/database/init.mdx index bb7ccadae..e7cadfe1a 100644 --- a/website/content/docs/commands/database/init.mdx +++ b/website/content/docs/commands/database/init.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: database init - Command -description: |- +description: >- The "database init" command initializes Boundary's database. --- diff --git a/website/content/docs/commands/database/migrate.mdx b/website/content/docs/commands/database/migrate.mdx index 978a5d7a4..05b043adc 100644 --- a/website/content/docs/commands/database/migrate.mdx +++ b/website/content/docs/commands/database/migrate.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: database migrate - Command -description: |- - The "database migrate" command migrates database within an enclosing scope or resource. +description: >- + The "database migrate" command migrates Boundary's database within an enclosing scope or resource. --- # database migrate diff --git a/website/content/docs/commands/delete.mdx b/website/content/docs/commands/delete.mdx index 113baf51e..fa9a43860 100644 --- a/website/content/docs/commands/delete.mdx +++ b/website/content/docs/commands/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: delete - Command -description: |- - The "delete" command lets you delete Boundary resources. +description: >- + The "delete" command deletes existing resources. --- # delete diff --git a/website/content/docs/commands/dev.mdx b/website/content/docs/commands/dev.mdx index 76c572039..4da9dd162 100644 --- a/website/content/docs/commands/dev.mdx +++ b/website/content/docs/commands/dev.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: dev - Command -description: |- +description: >- The `dev` command starts a Boundary instance in a dev mode. Dev mode provides admin credentials for password authentication. --- diff --git a/website/content/docs/commands/groups/add-members.mdx b/website/content/docs/commands/groups/add-members.mdx index 67c02d945..a1ec0629f 100644 --- a/website/content/docs/commands/groups/add-members.mdx +++ b/website/content/docs/commands/groups/add-members.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups add-members - Command -description: |- - The "groups add-members" command lets Boundary admin add members (users) to a group. +description: >- + The "groups add-members" command adds users as members of a group resource. --- # groups add-members diff --git a/website/content/docs/commands/groups/create.mdx b/website/content/docs/commands/groups/create.mdx index e41f29c2a..9b38a66b6 100644 --- a/website/content/docs/commands/groups/create.mdx +++ b/website/content/docs/commands/groups/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups create - Command -description: |- - The "groups create" command lets Boundary admin create a group. +description: >- + The "groups create" command creates a new group resource. --- # groups create diff --git a/website/content/docs/commands/groups/delete.mdx b/website/content/docs/commands/groups/delete.mdx index acc1d0f3f..acbe54add 100644 --- a/website/content/docs/commands/groups/delete.mdx +++ b/website/content/docs/commands/groups/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups delete - Command -description: |- - The "groups delete" command lets Boundary admin delete a group resource. +description: >- + The "groups delete" command deletes an existing group resource. --- # groups delete diff --git a/website/content/docs/commands/groups/index.mdx b/website/content/docs/commands/groups/index.mdx index 2f95dc267..8601f8530 100644 --- a/website/content/docs/commands/groups/index.mdx +++ b/website/content/docs/commands/groups/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups - Command -description: |- - The "groups" command lets Boundary admin create and manage group resources. +description: >- + The "groups" command performs operations on group resources. A group represents a collection of users with the same access control. --- # groups diff --git a/website/content/docs/commands/groups/list.mdx b/website/content/docs/commands/groups/list.mdx index 199334072..aebe9e147 100644 --- a/website/content/docs/commands/groups/list.mdx +++ b/website/content/docs/commands/groups/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups list - Command -description: |- - The "groups list" command lets Boundary admin list groups within an enclosing scope or resource. +description: >- + The "groups list" command lists the available group resources within an enclosing scope or resource. --- # groups list diff --git a/website/content/docs/commands/groups/read.mdx b/website/content/docs/commands/groups/read.mdx index 4573f93b0..1395fd3b6 100644 --- a/website/content/docs/commands/groups/read.mdx +++ b/website/content/docs/commands/groups/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups read - Command -description: |- - The "groups read" command lets Boundary admin read a group resource. +description: >- + The "groups read" command retrieves the details of an existing group resource. --- # groups read diff --git a/website/content/docs/commands/groups/remove-members.mdx b/website/content/docs/commands/groups/remove-members.mdx index 55c19c4ea..fc33c760d 100644 --- a/website/content/docs/commands/groups/remove-members.mdx +++ b/website/content/docs/commands/groups/remove-members.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups remove-members - Command -description: |- - The "groups remove-members" command lets Boundary admin remove members (users) from a group given its ID. +description: >- + The "groups remove-members" command removes members from a group resource. --- # groups remove-members diff --git a/website/content/docs/commands/groups/set-members.mdx b/website/content/docs/commands/groups/set-members.mdx index 7d31784f6..4ce2ce6ed 100644 --- a/website/content/docs/commands/groups/set-members.mdx +++ b/website/content/docs/commands/groups/set-members.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups set-members - Command -description: |- - The "groups set-members" command lets Boundary admin configure a complete set of members (users) on a group given its ID. +description: >- + The "groups set-members" command configures a complete set of users as members in a group resource. --- # groups set-members diff --git a/website/content/docs/commands/groups/update.mdx b/website/content/docs/commands/groups/update.mdx index e94e831b1..f9eb53691 100644 --- a/website/content/docs/commands/groups/update.mdx +++ b/website/content/docs/commands/groups/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: groups update - Command -description: |- - The "groups update" command lets Boundary admin update a group resource. +description: >- + The "groups update" command updates an existing group resource. --- # groups update diff --git a/website/content/docs/commands/host-catalogs/create.mdx b/website/content/docs/commands/host-catalogs/create.mdx index 06d46fce0..05a61b5eb 100644 --- a/website/content/docs/commands/host-catalogs/create.mdx +++ b/website/content/docs/commands/host-catalogs/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs create - Command -description: |- - The "host-catalogs create" command lets you create a new host catalog. +description: >- + The "host-catalogs create" command creates a new host catalog resource. You can create plugin or static host catalog types. --- # host-catalogs create diff --git a/website/content/docs/commands/host-catalogs/delete.mdx b/website/content/docs/commands/host-catalogs/delete.mdx index 4cf47ff53..087db3af7 100644 --- a/website/content/docs/commands/host-catalogs/delete.mdx +++ b/website/content/docs/commands/host-catalogs/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs delete - Command -description: |- - The "host-catalogs delete" command lets you delete a host catalog. +description: >- + The "host-catalogs delete" command deletes a existing host catalog resource. --- # host-catalogs delete diff --git a/website/content/docs/commands/host-catalogs/index.mdx b/website/content/docs/commands/host-catalogs/index.mdx index c3dd569d4..c8c27c647 100644 --- a/website/content/docs/commands/host-catalogs/index.mdx +++ b/website/content/docs/commands/host-catalogs/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs - Command -description: |- - The "host-catalogs" command lets you perform operations on Boundary host catalog resources. +description: >- + The "host-catalogs" command performs operations on Boundary host catalog resources. Host catalogs contain hosts and host sets. --- # host-catalogs diff --git a/website/content/docs/commands/host-catalogs/list.mdx b/website/content/docs/commands/host-catalogs/list.mdx index 34d7faf3c..6c79962ba 100644 --- a/website/content/docs/commands/host-catalogs/list.mdx +++ b/website/content/docs/commands/host-catalogs/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs list - Command -description: |- - The "host-catalogs list" command lists the host catalogs within a given scope or resource. +description: >- + The "host-catalogs list" command lists the available host catalog resourcess within a scope or resource. --- # host-catalogs list diff --git a/website/content/docs/commands/host-catalogs/read.mdx b/website/content/docs/commands/host-catalogs/read.mdx index 3219ff5bb..7ad003590 100644 --- a/website/content/docs/commands/host-catalogs/read.mdx +++ b/website/content/docs/commands/host-catalogs/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs read - Command -description: |- - The "host-catalogs read" command lets you read host catalog information with a given host catalog ID. +description: >- + The "host-catalogs read" command retrieves host catalog information for a host catalog resource. --- # host-catalogs read diff --git a/website/content/docs/commands/host-catalogs/update.mdx b/website/content/docs/commands/host-catalogs/update.mdx index 5addc5dc1..d41d6f044 100644 --- a/website/content/docs/commands/host-catalogs/update.mdx +++ b/website/content/docs/commands/host-catalogs/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-catalogs update - Command -description: |- - The "host-catalogs update" command lets you update an existing host catalog. +description: >- + The "host-catalogs update" command updates an existing host catalog resource. --- # host-catalogs update diff --git a/website/content/docs/commands/host-sets/add-hosts.mdx b/website/content/docs/commands/host-sets/add-hosts.mdx index 4a05541e9..82a423d50 100644 --- a/website/content/docs/commands/host-sets/add-hosts.mdx +++ b/website/content/docs/commands/host-sets/add-hosts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets add-hosts - Command -description: |- - The "host-sets add-hosts" command lets you add hosts to host set resources, if the types match and the operation is allowed by the host set type. +description: >- + The "host-sets add-hosts" command adds new hosts to host set resources. --- # host-sets add-hosts diff --git a/website/content/docs/commands/host-sets/create.mdx b/website/content/docs/commands/host-sets/create.mdx index ee50cd48f..6d7258ac0 100644 --- a/website/content/docs/commands/host-sets/create.mdx +++ b/website/content/docs/commands/host-sets/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets create - Command -description: |- - The "host-sets create" command lets you create a new host set. +description: >- + The "host-sets create" command creates a new host set resource. You can create plugin or static type host sets. --- # host-sets create diff --git a/website/content/docs/commands/host-sets/delete.mdx b/website/content/docs/commands/host-sets/delete.mdx index 29e7ab3d7..4ed2e3e29 100644 --- a/website/content/docs/commands/host-sets/delete.mdx +++ b/website/content/docs/commands/host-sets/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets delete - Command -description: |- - The "host-sets delete" command lets you delete a host set. +description: >- + The "host-sets delete" command deletes a existing host set resource. --- # host-sets delete diff --git a/website/content/docs/commands/host-sets/index.mdx b/website/content/docs/commands/host-sets/index.mdx index f4c49ac7c..517341d1f 100644 --- a/website/content/docs/commands/host-sets/index.mdx +++ b/website/content/docs/commands/host-sets/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets - Command -description: |- - The "host-sets" command lets you perform operations on Boundary host set resources. +description: >- + The "host-sets" command performs operations on Boundary host set resources. A host set represents a collection of hosts with the same access control. --- # host-sets diff --git a/website/content/docs/commands/host-sets/list.mdx b/website/content/docs/commands/host-sets/list.mdx index b93fe675b..1ee63e180 100644 --- a/website/content/docs/commands/host-sets/list.mdx +++ b/website/content/docs/commands/host-sets/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets list - Command -description: |- - The "host-sets list" command lists the host sets within a given scope or resource. +description: >- + The "host-sets list" command lists the available host set resources within a scope or resource. --- # host-sets list diff --git a/website/content/docs/commands/host-sets/read.mdx b/website/content/docs/commands/host-sets/read.mdx index d6669ae6c..e1f9ac495 100644 --- a/website/content/docs/commands/host-sets/read.mdx +++ b/website/content/docs/commands/host-sets/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets read - Command -description: |- - The "host-sets read" command lets you read the details of a host set resource using its given ID. +description: >- + The "host-sets read" command retrieves the details of an existing host set resource. --- # host-sets read diff --git a/website/content/docs/commands/host-sets/remove-hosts.mdx b/website/content/docs/commands/host-sets/remove-hosts.mdx index 46dd230b6..74eef8d17 100644 --- a/website/content/docs/commands/host-sets/remove-hosts.mdx +++ b/website/content/docs/commands/host-sets/remove-hosts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets remove-hosts - Command -description: |- - The "host-sets remove-hosts" command lets you remove hosts from host set resources, if the types match and the operation is allowed by the host set type. +description: >- + The "host-sets remove-hosts" command removes hosts from host set resources. --- # host-sets remove-hosts diff --git a/website/content/docs/commands/host-sets/set-hosts.mdx b/website/content/docs/commands/host-sets/set-hosts.mdx index d8424e61c..9cd600809 100644 --- a/website/content/docs/commands/host-sets/set-hosts.mdx +++ b/website/content/docs/commands/host-sets/set-hosts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets set-hosts - Command -description: |- - The "host-sets set-hosts" command lets you configure the complete set of hosts on host source resources, if the types match and the operation is allowed by the host set type. +description: >- + The "host-sets set-hosts" command configures a complete set of hosts on host set resources. --- # host-sets set-hosts diff --git a/website/content/docs/commands/host-sets/update.mdx b/website/content/docs/commands/host-sets/update.mdx index 470fd6c60..a6fe888a3 100644 --- a/website/content/docs/commands/host-sets/update.mdx +++ b/website/content/docs/commands/host-sets/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: host-sets update - Command -description: |- - The "host-sets update" command lets you update an existing host set. +description: >- + The "host-sets update" command updates an existing host set resource. --- # host-sets update diff --git a/website/content/docs/commands/hosts/create.mdx b/website/content/docs/commands/hosts/create.mdx index 4980ac84f..2c11535bb 100644 --- a/website/content/docs/commands/hosts/create.mdx +++ b/website/content/docs/commands/hosts/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts create - Command -description: |- - The "hosts create" command lets you create a new host. +description: >- + The "hosts create" command creates a new host resource. --- # hosts create diff --git a/website/content/docs/commands/hosts/delete.mdx b/website/content/docs/commands/hosts/delete.mdx index 3893becfa..fd005135c 100644 --- a/website/content/docs/commands/hosts/delete.mdx +++ b/website/content/docs/commands/hosts/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts delete - Command -description: |- - The "hosts delete" command lets you delete a host. +description: >- + The "hosts delete" command deletes an existing host resource. --- # hosts delete diff --git a/website/content/docs/commands/hosts/index.mdx b/website/content/docs/commands/hosts/index.mdx index 12a4fcafe..c2c32cd76 100644 --- a/website/content/docs/commands/hosts/index.mdx +++ b/website/content/docs/commands/hosts/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts - Command -description: |- - The "hosts" command lets you perform operations on Boundary host resources. +description: >- + The "hosts" command performs operations on Boundary host resources. A host represents a computing element with a network address that Boundary can reach. --- # hosts diff --git a/website/content/docs/commands/hosts/list.mdx b/website/content/docs/commands/hosts/list.mdx index de6610a88..933d44e68 100644 --- a/website/content/docs/commands/hosts/list.mdx +++ b/website/content/docs/commands/hosts/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts list - Command -description: |- - The "hosts list" command lists the hosts within a given scope or resource. +description: >- + The "hosts list" command lists the available host resources within a scope or resource. --- # hosts list diff --git a/website/content/docs/commands/hosts/read.mdx b/website/content/docs/commands/hosts/read.mdx index 5ba2c95f4..0a58db90e 100644 --- a/website/content/docs/commands/hosts/read.mdx +++ b/website/content/docs/commands/hosts/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts read - Command -description: |- - The "hosts read" command lets you read information about a host with a given ID. +description: >- + The "hosts read" command retrieves details about a host resource. --- # hosts read diff --git a/website/content/docs/commands/hosts/update.mdx b/website/content/docs/commands/hosts/update.mdx index 56d0c1954..2d1bd0beb 100644 --- a/website/content/docs/commands/hosts/update.mdx +++ b/website/content/docs/commands/hosts/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: hosts update - Command -description: |- - The "hosts update" command lets you update a host. +description: >- + The "hosts update" command updates an existing host resource. --- # hosts update diff --git a/website/content/docs/commands/index.mdx b/website/content/docs/commands/index.mdx index 659c68485..446c2c63f 100644 --- a/website/content/docs/commands/index.mdx +++ b/website/content/docs/commands/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Commands (CLI) -description: |- - Boundary's CLI behavior +description: >- + Learn about Boundary's CLI command structure and behavior. View standard connection options, client options, and environment variables. --- # CLI diff --git a/website/content/docs/commands/logout.mdx b/website/content/docs/commands/logout.mdx index 9a814694d..07a231d9d 100644 --- a/website/content/docs/commands/logout.mdx +++ b/website/content/docs/commands/logout.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: logout - Command -description: |- +description: >- The `logout` command deletes the current token from Boundary and removes it from the local store. --- diff --git a/website/content/docs/commands/managed-groups/create.mdx b/website/content/docs/commands/managed-groups/create.mdx index fb4051b3e..10fb16898 100644 --- a/website/content/docs/commands/managed-groups/create.mdx +++ b/website/content/docs/commands/managed-groups/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups create - Command -description: |- - The "managed-groups create" command lets you create a new managed group. +description: >- + The "managed-groups create" command creates a new managed group resource. --- # managed-groups create diff --git a/website/content/docs/commands/managed-groups/delete.mdx b/website/content/docs/commands/managed-groups/delete.mdx index 5d9e0ad10..3ef4ee0aa 100644 --- a/website/content/docs/commands/managed-groups/delete.mdx +++ b/website/content/docs/commands/managed-groups/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups delete - Command -description: |- - The "managed-groups delete" command lets you delete a managed-group. +description: >- + The "managed-groups delete" command deletes an existing managed group resource. --- # managed-groups delete diff --git a/website/content/docs/commands/managed-groups/index.mdx b/website/content/docs/commands/managed-groups/index.mdx index 4043ce498..c5cd15501 100644 --- a/website/content/docs/commands/managed-groups/index.mdx +++ b/website/content/docs/commands/managed-groups/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups - Command -description: |- - The "managed-groups" command lets you perform operations on Boundary managed group resources. +description: >- + The "managed-groups" command performs operations on Boundary managed group resources. Managed groups represent collections of accounts. --- # managed-groups diff --git a/website/content/docs/commands/managed-groups/list.mdx b/website/content/docs/commands/managed-groups/list.mdx index 76dfe31be..794237b21 100644 --- a/website/content/docs/commands/managed-groups/list.mdx +++ b/website/content/docs/commands/managed-groups/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups list - Command -description: |- - The "managed-groups list" command lists the managed groups within a given scope or resource. +description: >- + The "managed-groups list" command lists the available managed group resources within a scope or resource. --- # managed-groups list diff --git a/website/content/docs/commands/managed-groups/read.mdx b/website/content/docs/commands/managed-groups/read.mdx index 72a6af87c..2a3d16cec 100644 --- a/website/content/docs/commands/managed-groups/read.mdx +++ b/website/content/docs/commands/managed-groups/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups read - Command -description: |- - The "managed-groups read" command lets you read the details of a managed group with a given ID. +description: >- + The "managed-groups read" command retrieves the details of a managed group resource. --- # managed-groups read diff --git a/website/content/docs/commands/managed-groups/update.mdx b/website/content/docs/commands/managed-groups/update.mdx index 7834aa1e2..17118849d 100644 --- a/website/content/docs/commands/managed-groups/update.mdx +++ b/website/content/docs/commands/managed-groups/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: managed-groups update - Command -description: |- - The "managed-groups update" command lets you update an existing managed group. +description: >- + The "managed-groups update" command updates an existing managed group resource. --- # managed-groups update diff --git a/website/content/docs/commands/policies/create.mdx b/website/content/docs/commands/policies/create.mdx index 0fae2876d..2e1819ac0 100644 --- a/website/content/docs/commands/policies/create.mdx +++ b/website/content/docs/commands/policies/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies create - Command -description: |- - The "policies create" command lets you create Boundary policies. +description: >- + The "policies create" command creates new policy resources. --- # policies create diff --git a/website/content/docs/commands/policies/delete.mdx b/website/content/docs/commands/policies/delete.mdx index c6d5ab559..a1299506b 100644 --- a/website/content/docs/commands/policies/delete.mdx +++ b/website/content/docs/commands/policies/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies delete - Command -description: |- - The "policies delete" command lets you delete Boundary policies. +description: >- + The "policies delete" command deletes existing policy resources. --- # policies delete diff --git a/website/content/docs/commands/policies/index.mdx b/website/content/docs/commands/policies/index.mdx index c858c9703..4b857edd8 100644 --- a/website/content/docs/commands/policies/index.mdx +++ b/website/content/docs/commands/policies/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies - Command -description: |- - The "policies" command lets you perform operations on Boundary policy resources. +description: >- + The "policies" command performs operations on Boundary policy resources. Policies codify how long Boundary retains session recordings. --- # policies diff --git a/website/content/docs/commands/policies/list.mdx b/website/content/docs/commands/policies/list.mdx index b2bd9b1a3..009179b3c 100644 --- a/website/content/docs/commands/policies/list.mdx +++ b/website/content/docs/commands/policies/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies list - Command -description: |- - The "policies list" command lists the policies within a given scope or resource. +description: >- + The "policies list" command lists the available policy resources within a scope or resource. --- # policies list diff --git a/website/content/docs/commands/policies/read.mdx b/website/content/docs/commands/policies/read.mdx index 7aacfcb23..d0fa49a5e 100644 --- a/website/content/docs/commands/policies/read.mdx +++ b/website/content/docs/commands/policies/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies read - Command -description: |- - The "policies read" command lets you read information about Boundary policies. +description: >- + The "policies read" command retrieves the details of an existing policy resource. --- # policies read diff --git a/website/content/docs/commands/policies/update.mdx b/website/content/docs/commands/policies/update.mdx index ab6564c74..bd49ea7ba 100644 --- a/website/content/docs/commands/policies/update.mdx +++ b/website/content/docs/commands/policies/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: policies update - Command -description: |- - The "policies update" command lets you update Boundary policies. +description: >- + The "policies update" command updates existing policy resources. --- # policies update diff --git a/website/content/docs/commands/read.mdx b/website/content/docs/commands/read.mdx index 86f9c04c4..7ce9273dd 100644 --- a/website/content/docs/commands/read.mdx +++ b/website/content/docs/commands/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: read - Command -description: |- - The "read" command lets you read Boundary resources. +description: >- + The "read" command retrieves details about existing Boundary resources using the resource's ID. --- # read diff --git a/website/content/docs/commands/roles/add-grant-scopes.mdx b/website/content/docs/commands/roles/add-grant-scopes.mdx index 085a0fc26..7c1a4142b 100644 --- a/website/content/docs/commands/roles/add-grant-scopes.mdx +++ b/website/content/docs/commands/roles/add-grant-scopes.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles add-grant-scopes - Command -description: |- - The "roles add-grant-scopes" command lets you add grant scopes to a role. +description: >- + The "roles add-grant-scopes" command adds grant scopes to an existing role resource. --- # roles add-grant-scopes diff --git a/website/content/docs/commands/roles/add-grants.mdx b/website/content/docs/commands/roles/add-grants.mdx index 023fdff64..30da838df 100644 --- a/website/content/docs/commands/roles/add-grants.mdx +++ b/website/content/docs/commands/roles/add-grants.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles add-grants - Command -description: |- - The "roles add-grants" command lets you add grants to a role. +description: >- + The "roles add-grants" command adds grants to an existing role resource. --- # roles add-grants diff --git a/website/content/docs/commands/roles/add-principals.mdx b/website/content/docs/commands/roles/add-principals.mdx index 259ddf991..a0ad95269 100644 --- a/website/content/docs/commands/roles/add-principals.mdx +++ b/website/content/docs/commands/roles/add-principals.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles add-principals - Command -description: |- - The "roles add-principals" command lets you add principals to a role. Principals can be users or groups. +description: >- + The "roles add-principals" command add principals to an existing role resource. Principals can be users or groups. --- # roles add-principals diff --git a/website/content/docs/commands/roles/create.mdx b/website/content/docs/commands/roles/create.mdx index b2cc823f5..e60c51329 100644 --- a/website/content/docs/commands/roles/create.mdx +++ b/website/content/docs/commands/roles/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles create - Command -description: |- - The "roles create" command lets you create a new role. +description: >- + The "roles create" command creates a new role resource. --- # roles create diff --git a/website/content/docs/commands/roles/delete.mdx b/website/content/docs/commands/roles/delete.mdx index f98fb2ee2..b119a62fb 100644 --- a/website/content/docs/commands/roles/delete.mdx +++ b/website/content/docs/commands/roles/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles delete - Command -description: |- - The "roles delete" command lets you delete a role. +description: >- + The "roles delete" command deletes an existing role resource. --- # roles delete diff --git a/website/content/docs/commands/roles/index.mdx b/website/content/docs/commands/roles/index.mdx index 4071014ed..5a1f96ac6 100644 --- a/website/content/docs/commands/roles/index.mdx +++ b/website/content/docs/commands/roles/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles - Command -description: |- - The "roles" command lets you perform operations on Boundary role resources. +description: >- + The "roles" command performs operations on Boundary role resources. Roles contain collections of permissions which are granted to principals assigned to the role. --- # roles diff --git a/website/content/docs/commands/roles/list.mdx b/website/content/docs/commands/roles/list.mdx index c1e217426..1d0ff8a6c 100644 --- a/website/content/docs/commands/roles/list.mdx +++ b/website/content/docs/commands/roles/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles list - Command -description: |- - The "roles list" command lists the roles within a given scope or resource. +description: >- + The "roles list" command lists the available role resources within a scope or resource. --- # roles list diff --git a/website/content/docs/commands/roles/read.mdx b/website/content/docs/commands/roles/read.mdx index c7f28183d..55831fbb6 100644 --- a/website/content/docs/commands/roles/read.mdx +++ b/website/content/docs/commands/roles/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles read - Command -description: |- - The "roles read" command lets you read the information about a role with a given ID. +description: >- + The "roles read" command retrieves the details of a role resource. --- # roles read diff --git a/website/content/docs/commands/roles/remove-grant-scopes.mdx b/website/content/docs/commands/roles/remove-grant-scopes.mdx index de320b633..c37201c76 100644 --- a/website/content/docs/commands/roles/remove-grant-scopes.mdx +++ b/website/content/docs/commands/roles/remove-grant-scopes.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles remove-grant-scopes - Command -description: |- - The "roles remove-grant-scopes" command lets you remove grant scopes from a role. +description: >- + The "roles remove-grant-scopes" command removes grant scopes from an existing role resource. --- # roles remove-grant-scopes diff --git a/website/content/docs/commands/roles/remove-grants.mdx b/website/content/docs/commands/roles/remove-grants.mdx index db31ee397..704771ee7 100644 --- a/website/content/docs/commands/roles/remove-grants.mdx +++ b/website/content/docs/commands/roles/remove-grants.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles remove-grants - Command -description: |- - The "roles remove-grants" command lets you remove grants from a role. +description: >- + The "roles remove-grants" command removes grants from an existing role resource. --- # roles remove-grants diff --git a/website/content/docs/commands/roles/remove-principals.mdx b/website/content/docs/commands/roles/remove-principals.mdx index 566f5f124..f44e224b9 100644 --- a/website/content/docs/commands/roles/remove-principals.mdx +++ b/website/content/docs/commands/roles/remove-principals.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles remove-principals - Command -description: |- - The "roles remove-principals" command lets you remove principals from a role. Principals can be users or groups. +description: >- + The "roles remove-principals" command removes principals from an existing role resource. Principals can be users or groups. --- # roles remove-principals diff --git a/website/content/docs/commands/roles/set-grant-scopes.mdx b/website/content/docs/commands/roles/set-grant-scopes.mdx index fa31cad81..0e3c77f79 100644 --- a/website/content/docs/commands/roles/set-grant-scopes.mdx +++ b/website/content/docs/commands/roles/set-grant-scopes.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles set-grant-scopes - Command -description: |- - The "roles set-grant-scopes" command lets you set the complete set of grant scopes on a role. +description: >- + The "roles set-grant-scopes" command sets the complete set of grant scopes on an existing role resource. --- # roles set-grant-scopes diff --git a/website/content/docs/commands/roles/set-grants.mdx b/website/content/docs/commands/roles/set-grants.mdx index 6aac0212a..4c4f1fbfb 100644 --- a/website/content/docs/commands/roles/set-grants.mdx +++ b/website/content/docs/commands/roles/set-grants.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles set-grants - Command -description: |- - The "roles set-grants" command lets you set the complete set of grants on a role. +description: >- + The "roles set-grants" command sets the complete set of grants on an existing role resource. --- # roles set-grants diff --git a/website/content/docs/commands/roles/set-principals.mdx b/website/content/docs/commands/roles/set-principals.mdx index 056077100..f8ddf7319 100644 --- a/website/content/docs/commands/roles/set-principals.mdx +++ b/website/content/docs/commands/roles/set-principals.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles set-principals - Command -description: |- - The "roles set-principals" command lets you set the complete set of principals on a role. Principals can be users or groups. +description: >- + The "roles set-principals" command sets the complete set of principals on an existing role resource. Principals can be users or groups. --- # roles set-principals diff --git a/website/content/docs/commands/roles/update.mdx b/website/content/docs/commands/roles/update.mdx index 36af12bfb..177b26de4 100644 --- a/website/content/docs/commands/roles/update.mdx +++ b/website/content/docs/commands/roles/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: roles update - Command -description: |- - The "roles update" command lets you update an existing role. +description: >- + The "roles update" command updates an existing role resource. --- # roles update diff --git a/website/content/docs/commands/scopes/create.mdx b/website/content/docs/commands/scopes/create.mdx index a3f42eca6..a38dbb8a8 100644 --- a/website/content/docs/commands/scopes/create.mdx +++ b/website/content/docs/commands/scopes/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes create - Command -description: |- - The "scopes create" command lets you create a new scope. +description: >- + The "scopes create" command creates a new scope resource. --- # scopes create diff --git a/website/content/docs/commands/scopes/delete.mdx b/website/content/docs/commands/scopes/delete.mdx index 303b0ed6d..cea816c25 100644 --- a/website/content/docs/commands/scopes/delete.mdx +++ b/website/content/docs/commands/scopes/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes delete - Command -description: |- - The "scopes delete" command lets you delete a scope. +description: >- + The "scopes delete" command deletes an existing scope resource. --- # scopes delete diff --git a/website/content/docs/commands/scopes/destroy-key-version.mdx b/website/content/docs/commands/scopes/destroy-key-version.mdx index be4f87b83..6fe1f1aba 100644 --- a/website/content/docs/commands/scopes/destroy-key-version.mdx +++ b/website/content/docs/commands/scopes/destroy-key-version.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes destroy-key-version - Command -description: |- - The "scopes destroy-key-version" destroys a key version in the scope. +description: >- + The "scopes destroy-key-version" destroys a key version in the scope resource. --- # scopes destroy-key-version diff --git a/website/content/docs/commands/scopes/index.mdx b/website/content/docs/commands/scopes/index.mdx index c0db33db1..ce4910321 100644 --- a/website/content/docs/commands/scopes/index.mdx +++ b/website/content/docs/commands/scopes/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes - Command -description: |- - The "scopes" command lets you perform operations on Boundary scope resources. +description: >- + The "scopes" command performs operations on Boundary scope resources. Scopes are permission boundaries modeled as containers. They group resources. --- # scopes diff --git a/website/content/docs/commands/scopes/list-key-version-destruction-jobs.mdx b/website/content/docs/commands/scopes/list-key-version-destruction-jobs.mdx index 0473cface..8d6e4a75e 100644 --- a/website/content/docs/commands/scopes/list-key-version-destruction-jobs.mdx +++ b/website/content/docs/commands/scopes/list-key-version-destruction-jobs.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes list-key-version-destruction-jobs - Command -description: |- - The "scopes list-key-version-destruction-jobs" lists all pending key version destruction jobs within a scope. +description: >- + The "scopes list-key-version-destruction-jobs" lists all pending key version destruction jobs within a scope resource. --- # scopes list-key-version-destruction-jobs diff --git a/website/content/docs/commands/scopes/list-keys.mdx b/website/content/docs/commands/scopes/list-keys.mdx index e13d3a6df..ab773e87d 100644 --- a/website/content/docs/commands/scopes/list-keys.mdx +++ b/website/content/docs/commands/scopes/list-keys.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes list-keys - Command -description: |- - The "scopes list-keys" command lists the keys within a given scope or resource. +description: >- + The "scopes list-keys" command lists the available keys within a scope or resource. --- # scopes list-keys diff --git a/website/content/docs/commands/scopes/list.mdx b/website/content/docs/commands/scopes/list.mdx index 18ee9799d..92b6124df 100644 --- a/website/content/docs/commands/scopes/list.mdx +++ b/website/content/docs/commands/scopes/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes list - Command -description: |- - The "scopes list" command lists the scopes within a given scope or resource. +description: >- + The "scopes list" command lists the available scope resources within a scope or resource. --- # scopes list diff --git a/website/content/docs/commands/scopes/read.mdx b/website/content/docs/commands/scopes/read.mdx index 0d06f7a25..782dd6cd5 100644 --- a/website/content/docs/commands/scopes/read.mdx +++ b/website/content/docs/commands/scopes/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes read - Command -description: |- - The "scopes read" command lets you read the details about a scope using its given ID. +description: >- + The "scopes read" command retrieves the details about a scope resource. --- # scopes read diff --git a/website/content/docs/commands/scopes/rotate-keys.mdx b/website/content/docs/commands/scopes/rotate-keys.mdx index 426a68b7f..f6735a5ea 100644 --- a/website/content/docs/commands/scopes/rotate-keys.mdx +++ b/website/content/docs/commands/scopes/rotate-keys.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes rotate-keys - Command -description: |- - The "scopes rotate-keys" command deactivates a scope's current KEK and DEKs, and activates a new set of keys for the scope. +description: >- + The "scopes rotate-keys" command deactivates a scope's current KEK and DEKs, and then activates a new set of keys for the scope resource. --- # scopes rotate-keys diff --git a/website/content/docs/commands/scopes/update.mdx b/website/content/docs/commands/scopes/update.mdx index f413b2fd8..93964b367 100644 --- a/website/content/docs/commands/scopes/update.mdx +++ b/website/content/docs/commands/scopes/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: scopes update - Command -description: |- - The "scopes update" command lets you update an existing scope. +description: >- + The "scopes update" command updates an existing scope resource. --- # scopes update diff --git a/website/content/docs/commands/search/index.mdx b/website/content/docs/commands/search/index.mdx index b282db32b..530cad43d 100644 --- a/website/content/docs/commands/search/index.mdx +++ b/website/content/docs/commands/search/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: search - Command -description: |- - The "search" command let's you search the Boundary local cache for information about sessions and targets. +description: >- + The "search" command searches the local cache for information about session and target resources. --- # search diff --git a/website/content/docs/commands/server.mdx b/website/content/docs/commands/server.mdx index e56910f5d..69f458ac3 100644 --- a/website/content/docs/commands/server.mdx +++ b/website/content/docs/commands/server.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: server - Command -description: |- - The `server` command starts a server (controller, worker, or both) with a configuration file. +description: >- + The `server` command starts a server with a configuration file. The command can start a controller, worker, or both. --- # server diff --git a/website/content/docs/commands/session-recordings/delete.mdx b/website/content/docs/commands/session-recordings/delete.mdx index bb1c4f8be..3c0b80e51 100644 --- a/website/content/docs/commands/session-recordings/delete.mdx +++ b/website/content/docs/commands/session-recordings/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings delete - Command -description: |- - The "session-recordings delete" command lets you delete a session recording. +description: >- + The "session-recordings delete" command deletes an existing session recording resource. --- # session-recordings delete diff --git a/website/content/docs/commands/session-recordings/download.mdx b/website/content/docs/commands/session-recordings/download.mdx index d37da7e29..8b8cd0c63 100644 --- a/website/content/docs/commands/session-recordings/download.mdx +++ b/website/content/docs/commands/session-recordings/download.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings download - Command -description: |- - The "session-recordings download" command lets you download Boundary session recording resources. +description: >- + The "session-recordings download" command downloads session recording resources so that you can view them. --- # session-recordings download diff --git a/website/content/docs/commands/session-recordings/index.mdx b/website/content/docs/commands/session-recordings/index.mdx index abf8183b5..e336351b1 100644 --- a/website/content/docs/commands/session-recordings/index.mdx +++ b/website/content/docs/commands/session-recordings/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings - Command -description: |- - The "session-recordings" command lets you perform operations on Boundary session recording resources. +description: >- + The "session-recordings" command performs operations on Boundary session recording resources. Session recordings capture sessions between users and targets. --- # session-recordings diff --git a/website/content/docs/commands/session-recordings/list.mdx b/website/content/docs/commands/session-recordings/list.mdx index 3772fac4c..5b4383811 100644 --- a/website/content/docs/commands/session-recordings/list.mdx +++ b/website/content/docs/commands/session-recordings/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings list - Command -description: |- - The "session-recordings list" command lists the session recordings within a given scope or resource. +description: >- + The "session-recordings list" command lists the available session recording resources within a scope or resource. --- # session-recordings list diff --git a/website/content/docs/commands/session-recordings/read.mdx b/website/content/docs/commands/session-recordings/read.mdx index aa5899fb0..b444537e5 100644 --- a/website/content/docs/commands/session-recordings/read.mdx +++ b/website/content/docs/commands/session-recordings/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings read - Command -description: |- - The "session-recordings read" command lets you read information about Boundary session recordings by ID. +description: >- + The "session-recordings read" command retrieves the details of a session recording resource. --- # session-recordings read diff --git a/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx b/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx index 67562c328..42496d0e8 100644 --- a/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx +++ b/website/content/docs/commands/session-recordings/reapply-storage-policy.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: session-recordings reapply-storage-policy - Command -description: |- - The "session-recordings reapply-storage-policy" command lets you reapply a storage policy to a session recording. +description: >- + The "session-recordings reapply-storage-policy" command reapplies a storage policy to a session recording resource. --- # session-recordings reapply-storage-policy diff --git a/website/content/docs/commands/sessions/cancel.mdx b/website/content/docs/commands/sessions/cancel.mdx index d99653f67..44bd2a96a 100644 --- a/website/content/docs/commands/sessions/cancel.mdx +++ b/website/content/docs/commands/sessions/cancel.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: sessions cancel - Command -description: |- - The "sessions cancel" command lets you cancel Boundary sessions by ID. +description: >- + The "sessions cancel" command cancels a session resource. --- # sessions cancel diff --git a/website/content/docs/commands/sessions/index.mdx b/website/content/docs/commands/sessions/index.mdx index 41b5b5780..17b5ad74d 100644 --- a/website/content/docs/commands/sessions/index.mdx +++ b/website/content/docs/commands/sessions/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: sessions - Command -description: |- - The "sessions" command lets you perform operations on Boundary session resources. +description: >- + The "sessions" command performs operations on Boundary session resources. A session is a set of related connections between a user and host. --- # sessions diff --git a/website/content/docs/commands/sessions/list.mdx b/website/content/docs/commands/sessions/list.mdx index 46ba91245..40da8543b 100644 --- a/website/content/docs/commands/sessions/list.mdx +++ b/website/content/docs/commands/sessions/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: sessions list - Command -description: |- - The "sessions list" command lists the sessions within a given scope or resource. +description: >- + The "sessions list" command lists the available session resources within a scope or resource. --- # sessions list diff --git a/website/content/docs/commands/sessions/read.mdx b/website/content/docs/commands/sessions/read.mdx index f5cc6a36a..15900c22a 100644 --- a/website/content/docs/commands/sessions/read.mdx +++ b/website/content/docs/commands/sessions/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: sessions read - Command -description: |- - The "sessions read" command lets you read information about Boundary sessions by ID. +description: >- + The "sessions read" command retrieves the details of a session resources. --- # sessions read diff --git a/website/content/docs/commands/storage-buckets/create.mdx b/website/content/docs/commands/storage-buckets/create.mdx index 901c84799..c3b43d119 100644 --- a/website/content/docs/commands/storage-buckets/create.mdx +++ b/website/content/docs/commands/storage-buckets/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets create - Command -description: |- - The "storage-buckets create" command lets you create Boundary storage buckets. +description: >- + The "storage-buckets create" command creates new storage bucket resources. --- # storage-buckets create diff --git a/website/content/docs/commands/storage-buckets/delete.mdx b/website/content/docs/commands/storage-buckets/delete.mdx index 62dd47a8b..cd921f6f6 100644 --- a/website/content/docs/commands/storage-buckets/delete.mdx +++ b/website/content/docs/commands/storage-buckets/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets delete - Command -description: |- - The "storage-buckets delete" command lets you delete Boundary storage buckets. +description: >- + The "storage-buckets delete" deletes existing storage bucket resources. --- # storage-buckets delete diff --git a/website/content/docs/commands/storage-buckets/index.mdx b/website/content/docs/commands/storage-buckets/index.mdx index 6d6e1005b..1dd706b45 100644 --- a/website/content/docs/commands/storage-buckets/index.mdx +++ b/website/content/docs/commands/storage-buckets/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets - Command -description: |- - The "storage-buckets" command lets you perform operations on Boundary storage bucket resources. +description: >- + The "storage-buckets" command performs operations on Boundary storage bucket resources. Storage buckets store session recordings. --- # storage-buckets diff --git a/website/content/docs/commands/storage-buckets/list.mdx b/website/content/docs/commands/storage-buckets/list.mdx index 15c8f4a19..9e15015c6 100644 --- a/website/content/docs/commands/storage-buckets/list.mdx +++ b/website/content/docs/commands/storage-buckets/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets list - Command -description: |- - The "storage-buckets list" command lists the storage buckets within a given scope or resource. +description: >- + The "storage-buckets list" command lists the available storage bucket resources within a scope or resource. --- # storage-buckets list diff --git a/website/content/docs/commands/storage-buckets/read.mdx b/website/content/docs/commands/storage-buckets/read.mdx index 1148473e9..a3bafada6 100644 --- a/website/content/docs/commands/storage-buckets/read.mdx +++ b/website/content/docs/commands/storage-buckets/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets read - Command -description: |- - The "storage-buckets read" command lets you read information about Boundary storage buckets. +description: >- + The "storage-buckets read" command retrieves the details of an existing storage bucket resource. --- # storage-buckets read diff --git a/website/content/docs/commands/storage-buckets/update.mdx b/website/content/docs/commands/storage-buckets/update.mdx index 0b0941a9b..a59ba7def 100644 --- a/website/content/docs/commands/storage-buckets/update.mdx +++ b/website/content/docs/commands/storage-buckets/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: storage-buckets update - Command -description: |- - The "storage-buckets update" command lets you update Boundary storage buckets. +description: >- + The "storage-buckets update" command updates existing storage bucket resources. --- # storage-buckets update diff --git a/website/content/docs/commands/targets/add-credential-sources.mdx b/website/content/docs/commands/targets/add-credential-sources.mdx index d19f878fe..a4ef8ecdd 100644 --- a/website/content/docs/commands/targets/add-credential-sources.mdx +++ b/website/content/docs/commands/targets/add-credential-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets add-credential-sources - Command -description: |- - The "targets add-credential-sources" lets you add credential sources to target resources. +description: >- + The "targets add-credential-sources" command adds credential sources to target resources. --- # targets add-credential-sources diff --git a/website/content/docs/commands/targets/add-host-sources.mdx b/website/content/docs/commands/targets/add-host-sources.mdx index 175ca1edb..2158e676f 100644 --- a/website/content/docs/commands/targets/add-host-sources.mdx +++ b/website/content/docs/commands/targets/add-host-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets add-host-sources - Command -description: |- - The "targets add-host-sources" lets you add host sources to target resources. +description: >- + The "targets add-host-sources" command adds host sources to target resources. --- # targets add-host-sources diff --git a/website/content/docs/commands/targets/authorize-session.mdx b/website/content/docs/commands/targets/authorize-session.mdx index 33a914d85..7d3e38a0a 100644 --- a/website/content/docs/commands/targets/authorize-session.mdx +++ b/website/content/docs/commands/targets/authorize-session.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets authorize-session - Command -description: |- - The "targets authorize-session" lets you fetch session authorization credentials for a target. +description: >- + The "targets authorize-session" command fetches session authorization credentials for a target resource. --- # targets authorize-session diff --git a/website/content/docs/commands/targets/create.mdx b/website/content/docs/commands/targets/create.mdx index 8165fed42..9b8475212 100644 --- a/website/content/docs/commands/targets/create.mdx +++ b/website/content/docs/commands/targets/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets create - Command -description: |- - The "targets create" command lets you create a new target. +description: >- + The "targets create" command creates a new target resource. --- # targets create diff --git a/website/content/docs/commands/targets/delete.mdx b/website/content/docs/commands/targets/delete.mdx index 4ba0806c3..e47f4d3d4 100644 --- a/website/content/docs/commands/targets/delete.mdx +++ b/website/content/docs/commands/targets/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets delete - Command -description: |- - The "targets delete" command lets you delete a target. +description: >- + The "targets delete" command deletes an existing target resource. --- # targets delete diff --git a/website/content/docs/commands/targets/index.mdx b/website/content/docs/commands/targets/index.mdx index 9b2d37ac5..9fb25eca0 100644 --- a/website/content/docs/commands/targets/index.mdx +++ b/website/content/docs/commands/targets/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets - Command -description: |- - The "targets" command performs operations on Boundary target resources. +description: >- + The "targets" command performs operations on Boundary target resources. Targets represent networked services that users can connect to during sessions. --- # targets diff --git a/website/content/docs/commands/targets/list.mdx b/website/content/docs/commands/targets/list.mdx index de6497ca4..9d5812f5b 100644 --- a/website/content/docs/commands/targets/list.mdx +++ b/website/content/docs/commands/targets/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets list - Command -description: |- - The "targets list" command lists the targets within a given scope or resource. +description: >- + The "targets list" command lists the available target resources within a scope or resource. --- # targets list diff --git a/website/content/docs/commands/targets/read.mdx b/website/content/docs/commands/targets/read.mdx index ebe3ac155..e2eeb6736 100644 --- a/website/content/docs/commands/targets/read.mdx +++ b/website/content/docs/commands/targets/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets read - Command -description: |- - The "targets read" command reads a target with a given ID. +description: >- + The "targets read" command retrieves the details of a target resource. --- # targets read diff --git a/website/content/docs/commands/targets/remove-credential-sources.mdx b/website/content/docs/commands/targets/remove-credential-sources.mdx index 96f9dc4b2..552e748c7 100644 --- a/website/content/docs/commands/targets/remove-credential-sources.mdx +++ b/website/content/docs/commands/targets/remove-credential-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets remove-credential-sources - Command -description: |- - The "targets remove-credential-sources" lets you remove credential sources from target resources. +description: >- + The "targets remove-credential-sources" removes credential sources from target resources. --- # targets remove-credential-sources diff --git a/website/content/docs/commands/targets/remove-host-sources.mdx b/website/content/docs/commands/targets/remove-host-sources.mdx index cf298962c..41e769bb1 100644 --- a/website/content/docs/commands/targets/remove-host-sources.mdx +++ b/website/content/docs/commands/targets/remove-host-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets remove-host-sources - Command -description: |- - The "targets remove-host-sources" lets you remove host sources from target resources. +description: >- + The "targets remove-host-sources" command removes host sources from target resources. --- # targets remove-host-sources diff --git a/website/content/docs/commands/targets/set-credential-sources.mdx b/website/content/docs/commands/targets/set-credential-sources.mdx index e58c0cd36..be10b3fa3 100644 --- a/website/content/docs/commands/targets/set-credential-sources.mdx +++ b/website/content/docs/commands/targets/set-credential-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets set-credential-sources - Command -description: |- - The "targets set-credential-sources" lets you set credential sources on target resources. +description: >- + The "targets set-credential-sources" command sets credential sources on target resources. --- # targets set-credential-sources diff --git a/website/content/docs/commands/targets/set-host-sources.mdx b/website/content/docs/commands/targets/set-host-sources.mdx index 58d0fbbea..65cdee823 100644 --- a/website/content/docs/commands/targets/set-host-sources.mdx +++ b/website/content/docs/commands/targets/set-host-sources.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets set-host-sources - Command -description: |- - The "targets set-host-sources" lets you set host sources on target resources. +description: >- + The "targets set-host-sources" command sets host sources on target resources. --- # targets set-host-sources diff --git a/website/content/docs/commands/targets/update.mdx b/website/content/docs/commands/targets/update.mdx index 9e22d8bc1..728b166fa 100644 --- a/website/content/docs/commands/targets/update.mdx +++ b/website/content/docs/commands/targets/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: targets update - Command -description: |- - The "targets update" command lets you update a target. +description: >- + The "targets update" command updates an existing target resource. --- # targets update diff --git a/website/content/docs/commands/update.mdx b/website/content/docs/commands/update.mdx index 9bef2866e..91282738e 100644 --- a/website/content/docs/commands/update.mdx +++ b/website/content/docs/commands/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: update - Command -description: |- - The "update" command lets you update Boundary resources. +description: >- + The "update" command updates existing Boundary resources. --- # update diff --git a/website/content/docs/commands/users/add-accounts.mdx b/website/content/docs/commands/users/add-accounts.mdx index 0e6bb816d..9706b2e26 100644 --- a/website/content/docs/commands/users/add-accounts.mdx +++ b/website/content/docs/commands/users/add-accounts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users add-accounts - Command -description: |- - The "users add-accounts" command associates accounts with a user. +description: >- + The "users add-accounts" command associates accounts with a user resource. --- # users add-accounts diff --git a/website/content/docs/commands/users/create.mdx b/website/content/docs/commands/users/create.mdx index 194144718..a21ac6298 100644 --- a/website/content/docs/commands/users/create.mdx +++ b/website/content/docs/commands/users/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users create - Command -description: |- - The "users create" command lets you create a new user. +description: >- + The "users create" command create a new user resource. --- # users create diff --git a/website/content/docs/commands/users/delete.mdx b/website/content/docs/commands/users/delete.mdx index 2243ee681..ca6a828a7 100644 --- a/website/content/docs/commands/users/delete.mdx +++ b/website/content/docs/commands/users/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users delete - Command -description: |- - The "users delete" command lets you delete a user. +description: >- + The "users delete" command deletes an existing user resource. --- # users delete diff --git a/website/content/docs/commands/users/index.mdx b/website/content/docs/commands/users/index.mdx index e7d7f44fa..b01023da0 100644 --- a/website/content/docs/commands/users/index.mdx +++ b/website/content/docs/commands/users/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users - Command -description: |- - The "users" command performs operations on Boundary user resources. +description: >- + The "users" command performs operations on Boundary user resources. Users represent an individual or entity for the purposes of access control. --- # users diff --git a/website/content/docs/commands/users/list.mdx b/website/content/docs/commands/users/list.mdx index 0d29dae65..9dec10707 100644 --- a/website/content/docs/commands/users/list.mdx +++ b/website/content/docs/commands/users/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users list - Command -description: |- - The "users list" command lists users from the specified scope or resource. +description: >- + The "users list" command lists the available user resources from the specified scope or resource. --- # users list diff --git a/website/content/docs/commands/users/read.mdx b/website/content/docs/commands/users/read.mdx index 5c9ae0382..6728cbabb 100644 --- a/website/content/docs/commands/users/read.mdx +++ b/website/content/docs/commands/users/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users read - Command -description: |- - The `users read` command lets you read information about users by their user ID. +description: >- + The "users read" command retrieves the details about a user resource. --- # users read diff --git a/website/content/docs/commands/users/remove-accounts.mdx b/website/content/docs/commands/users/remove-accounts.mdx index 4b9020368..fc7c06e30 100644 --- a/website/content/docs/commands/users/remove-accounts.mdx +++ b/website/content/docs/commands/users/remove-accounts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users remove-accounts - Command -description: |- - The "users remove-accounts" command disassociates accounts from a user. +description: >- + The "users remove-accounts" command disassociates accounts from a user resource. --- # users remove-accounts diff --git a/website/content/docs/commands/users/set-accounts.mdx b/website/content/docs/commands/users/set-accounts.mdx index 278ce5fcc..64cfc7e78 100644 --- a/website/content/docs/commands/users/set-accounts.mdx +++ b/website/content/docs/commands/users/set-accounts.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users set-accounts - Command -description: |- - The "users set-accounts" command configures the complete set of associated acounts on a user. +description: >- + The "users set-accounts" command configures a complete set of associated acounts on a user resource. --- # users set-accounts diff --git a/website/content/docs/commands/users/update.mdx b/website/content/docs/commands/users/update.mdx index c2987ea92..a1929b6bd 100644 --- a/website/content/docs/commands/users/update.mdx +++ b/website/content/docs/commands/users/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: users update - Command -description: |- - The "users update" command lets you update a user's information. +description: >- + The "users update" command updates an existing user's information. --- # users update diff --git a/website/content/docs/commands/workers/add-worker-tags.mdx b/website/content/docs/commands/workers/add-worker-tags.mdx index 8b5760acc..13f080c4f 100644 --- a/website/content/docs/commands/workers/add-worker-tags.mdx +++ b/website/content/docs/commands/workers/add-worker-tags.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers add-worker-tags - Command -description: |- - The "workers add-worker-tags" command lets you add api tags to worker resources. +description: >- + The "workers add-worker-tags" command adds API tags to worker resources. --- # workers add-worker-tags diff --git a/website/content/docs/commands/workers/certificate-authority.mdx b/website/content/docs/commands/workers/certificate-authority.mdx index 77a8047ce..fd2c13cf5 100644 --- a/website/content/docs/commands/workers/certificate-authority.mdx +++ b/website/content/docs/commands/workers/certificate-authority.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers certificate-authority - Command -description: |- - The "workers certificate-authority" command lets you manage the certificate authority used to authorize Boundary workers. +description: >- + The "workers certificate-authority" command manages the certificate authority used to authorize worker resources. --- # workers certificate-authority diff --git a/website/content/docs/commands/workers/create.mdx b/website/content/docs/commands/workers/create.mdx index 1472ba691..b72f20d2b 100644 --- a/website/content/docs/commands/workers/create.mdx +++ b/website/content/docs/commands/workers/create.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers create - Command -description: |- - The "workers create" command lets you create Boundary workers. +description: >- + The "workers create" command creates new worker resources. --- # workers create diff --git a/website/content/docs/commands/workers/delete.mdx b/website/content/docs/commands/workers/delete.mdx index 8069d375d..37fb8eebb 100644 --- a/website/content/docs/commands/workers/delete.mdx +++ b/website/content/docs/commands/workers/delete.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers delete - Command -description: |- - The "workers delete" command lets you delete Boundary workers. +description: >- + The "workers delete" command deletes existing worker resources. --- # workers delete diff --git a/website/content/docs/commands/workers/index.mdx b/website/content/docs/commands/workers/index.mdx index 0c467acf3..191267ff0 100644 --- a/website/content/docs/commands/workers/index.mdx +++ b/website/content/docs/commands/workers/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers - Command -description: |- - The "workers" command performs operations on Boundary worker resources. +description: >- + 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/list.mdx b/website/content/docs/commands/workers/list.mdx index 18d6e6fd4..038be0207 100644 --- a/website/content/docs/commands/workers/list.mdx +++ b/website/content/docs/commands/workers/list.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers list - Command -description: |- - The "workers list" command lets you list Boundary workers in a scope or resource. +description: >- + The "workers list" command lists available worker resources in a scope or resource. --- # workers list diff --git a/website/content/docs/commands/workers/read.mdx b/website/content/docs/commands/workers/read.mdx index 9c583d643..b892fb59b 100644 --- a/website/content/docs/commands/workers/read.mdx +++ b/website/content/docs/commands/workers/read.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers read - Command -description: |- - The "workers read" command lets you read a Boundary worker with a given ID. +description: >- + The "workers read" command retrieves the details of a worker resource. --- # workers read diff --git a/website/content/docs/commands/workers/remove-worker-tags.mdx b/website/content/docs/commands/workers/remove-worker-tags.mdx index 616d6a05a..00d7604f7 100644 --- a/website/content/docs/commands/workers/remove-worker-tags.mdx +++ b/website/content/docs/commands/workers/remove-worker-tags.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers remove-worker-tags - Command -description: |- - The "workers remove-worker-tags" command lets you remove api tags from worker resources. +description: >- + The "workers remove-worker-tags" command removes API tags from worker resources. --- # workers remove-worker-tags diff --git a/website/content/docs/commands/workers/set-worker-tags.mdx b/website/content/docs/commands/workers/set-worker-tags.mdx index 97e712daf..5934864c3 100644 --- a/website/content/docs/commands/workers/set-worker-tags.mdx +++ b/website/content/docs/commands/workers/set-worker-tags.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers set-worker-tags - Command -description: |- - The "workers set-worker-tags" command lets you set api tags for worker resources. +description: >- + The "workers set-worker-tags" command sets API tags for worker resources. --- # workers set-worker-tags diff --git a/website/content/docs/commands/workers/update.mdx b/website/content/docs/commands/workers/update.mdx index c27fb76df..8f3772b6d 100644 --- a/website/content/docs/commands/workers/update.mdx +++ b/website/content/docs/commands/workers/update.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: workers update - Command -description: |- - The "workers update" command lets you update a Boundary worker. +description: >- + The "workers update" command updates an existing worker resource. --- # workers update