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 <[email protected]> * Apply batch suggestions from code review Co-authored-by: Robin Beck <[email protected]> * docs: Remove given id references * Update read.mdx * Update read.mdx --------- Co-authored-by: Robin Beck <[email protected]>
hashicorp · Dec 17, 2024 · b442c1f · b442c1f
1 parent a4f2a70
commit b442c1f
Show file tree

Hide file tree

Showing 191 changed files with 378 additions and 378 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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'
+@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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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