[DOCS] Fix style inconsistency (#29199)

* Fix style inconsistency * Fix typos * Update website/content/docs/platform/k8s/vso/secret-transformation.mdx Co-authored-by: Jonathan Frappier <[email protected]> * Update website/content/docs/platform/k8s/helm/terraform.mdx Co-authored-by: Theron Voran <[email protected]> * Update website/content/docs/platform/k8s/injector/annotations.mdx Co-authored-by: Theron Voran <[email protected]> --------- Co-authored-by: Jonathan Frappier <[email protected]> Co-authored-by: Theron Voran <[email protected]>
hashicorp · Dec 17, 2024 · ed46640 · ed46640
1 parent 1390176
commit ed46640
Show file tree

Hide file tree

Showing 50 changed files with 130 additions and 135 deletions.
diff --git a/website/content/docs/platform/aws/index.mdx b/website/content/docs/platform/aws/index.mdx
@@ -2,11 +2,10 @@
 layout: docs
 page_title: AWS Marketplace
 description: >-
-  This section documents the official AWS Marketplace AMIs for Vault Open Source
-  and Vault Enterprise.
+   Deploy Vault on AWS using HashiCorp’s official AWS Marketplace AMIs for Vault Open Source and Vault Enterprise.
 ---
 
-# AWS marketplace
+# AWS Marketplace
 
 Vault can be deployed onto Amazon Web Services (AWS) using HashiCorp’s official AWS Marketplace offerings. HashiCorp packages the latest version of both Vault Open Source and Vault Enterprise as Amazon Machine Images (AMIs).
 

diff --git a/website/content/docs/platform/aws/lambda-extension.mdx b/website/content/docs/platform/aws/lambda-extension.mdx
@@ -1,11 +1,11 @@
 ---
 layout: docs
-page_title: Vault Lambda Extension
+page_title: Vault Lambda extension
 description: >-
-  The Vault Lambda Extension allows a Lambda function to read secrets from a Vault deployment.
+  Learn how the Vault Lambda extension allows a Lambda function to read secrets from a Vault deployment.
 ---
 
-# Vault lambda extension
+# Vault Lambda extension
 
 AWS Lambda lets you run code without provisioning and managing servers.
 The [Vault Lambda Extension](https://github.com/hashicorp/vault-lambda-extension) utilizes the AWS Lambda Extensions API to help your Lambda function read secrets from your Vault deployment.

diff --git a/website/content/docs/platform/aws/run.mdx b/website/content/docs/platform/aws/run.mdx
@@ -2,8 +2,7 @@
 layout: docs
 page_title: Running Vault
 description: >-
-  Vault can be launched from within the AWS Marketplace from the official Vault
-  Marketplace Listings.
+   Learn how to launch Vault from within the AWS Marketplace from the official Vault Marketplace listings.
 ---
 
 # Running Vault

diff --git a/website/content/docs/platform/github-actions.mdx b/website/content/docs/platform/github-actions.mdx
@@ -1,8 +1,8 @@
 ---
 layout: docs
-page_title: GitHub Actions
+page_title: GitHub actions
 description: >-
-  GitHub Actions
+  Use GitHub action workflow to leverage secrets stored in Vault using vault-action.
 ---
 
 # GitHub actions

diff --git a/website/content/docs/platform/index.mdx b/website/content/docs/platform/index.mdx
@@ -1,7 +1,7 @@
 ---
 layout: docs
 page_title: Platforms
-description: This section covers running Vault on various platforms (such as Kubernetes).
+description: Learn how to run Vault on various platforms such as Kubernetes.
 ---
 
 # Platforms

diff --git a/website/content/docs/platform/k8s/csi/configurations.mdx b/website/content/docs/platform/k8s/csi/configurations.mdx
@@ -1,10 +1,11 @@
 ---
 layout: docs
-page_title: Vault CSI Provider Configurations
-description: This section documents the configurables for the Vault CSI Provider.
+page_title: Vault CSI provider configurations
+description: >-
+   Learn about the command line arguments and the secret provider class parameters supported by the Vault CSI provider.
 ---
 
-# Command line arguments
+# Vault CSI provider configurations
 
 The following command line arguments are supported by the Vault CSI provider.
 Most settings support being set by, in ascending order of precedence:

diff --git a/website/content/docs/platform/k8s/csi/examples.mdx b/website/content/docs/platform/k8s/csi/examples.mdx
@@ -1,7 +1,7 @@
 ---
 layout: docs
-page_title: Vault CSI Provider Examples
-description: This section documents examples of using the Vault CSI Provider.
+page_title: Vault CSI provider examples
+description: Examples of using the Vault CSI provider.
 ---
 
 # Vault CSI provider examples

diff --git a/website/content/docs/platform/k8s/csi/index.mdx b/website/content/docs/platform/k8s/csi/index.mdx
@@ -1,8 +1,8 @@
 ---
 layout: docs
-page_title: Vault CSI Provider
+page_title: Vault CSI provider
 description: >-
-  The Vault CSI Provider allows pods to consume Vault secrets using CSI volumes.
+  Learn how the Vault CSI provider allows pods to consume Vault secrets using CSI volumes.
 ---
 
 # Vault CSI provider

diff --git a/website/content/docs/platform/k8s/csi/installation.mdx b/website/content/docs/platform/k8s/csi/installation.mdx
@@ -1,10 +1,10 @@
 ---
 layout: docs
-page_title: Vault CSI Provider Installation
-description: The Vault CSI Provider can be installed using Vault Helm.
+page_title: Install the Vault CSI provider
+description: Install the Vault CSI provider using Vault Helm.
 ---
 
-# Installing the Vault CSI provider
+# Install the Vault CSI provider
 
 ## Prerequisites
 
@@ -14,7 +14,7 @@ description: The Vault CSI Provider can be installed using Vault Helm.
   `--service-account-signing-key-file` and `--service-account-issuer` for
   `kube-apiserver`. Set by default from 1.20+ and earlier in most managed services.
 
-## Installation using helm
+## Installation using Helm
 
 The [Vault Helm chart](/vault/docs/platform/k8s/helm) is the recommended way to
 install and configure the Vault CSI Provider in Kubernetes.

diff --git a/website/content/docs/platform/k8s/helm/configuration.mdx b/website/content/docs/platform/k8s/helm/configuration.mdx
@@ -1,7 +1,7 @@
 ---
 layout: docs
 page_title: Configuration
-description: This section documents configuration options for the Vault Helm chart
+description: Configuration options for the Vault Helm chart.
 ---
 
 # Configuration

diff --git a/website/content/docs/platform/k8s/helm/enterprise.mdx b/website/content/docs/platform/k8s/helm/enterprise.mdx
@@ -1,11 +1,11 @@
 ---
 layout: docs
-page_title: Vault Enterprise License Management - Kubernetes
+page_title: Vault Enterprise license management
 description: >-
   Vault Helm supports deploying Vault Enterprise, including license autoloading.
 ---
 
-# Vault enterprise license management
+# Vault Enterprise license management
 
 You can use this Helm chart to deploy Vault Enterprise by following a few extra steps around licensing.
 

diff --git a/website/content/docs/platform/k8s/helm/examples/development.mdx b/website/content/docs/platform/k8s/helm/examples/development.mdx
@@ -2,8 +2,8 @@
 layout: 'docs'
 page_title: 'Development'
 sidebar_current: 'docs-platform-k8s-examples-development'
-description: |-
-  Describes how to set up a development Vault
+description: >-
+  Learn how to set up a development Vault server.
 ---
 
 # Development

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-dr-with-raft.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Highly Available Vault Enterprise Disaster Recovery Clusters with Raft'
+page_title: 'Highly available Vault Enterprise disaster recovery clusters with integrated storage (Raft)'
 sidebar_current: 'docs-platform-k8s-examples-enterprise-dr-with-raft'
-description: |-
-  Describes how to set up Diaster Recovery clusters with Integrated Storage (Raft)
+description: >-
+  Learn how to set up diaster recovery (DR) clusters with integrated storage (Raft) as the storage backend.
 ---
 
-# Highly available Vault enterprise disaster recovery clusters with integrated storage (Raft)
+# Highly available Vault Enterprise disaster recovery clusters with integrated storage (Raft)
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-perf-with-raft.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Highly Available Vault Enterprise Performance Clusters with Raft'
+page_title: 'Highly available Vault Enterprise performance clusters with integrated storage (Raft)'
 sidebar_current: 'docs-platform-k8s-examples-enterprise-perf-with-raft'
-description: |-
-  Describes how to set up Performance clusters with Integrated Storage (Raft)
+description: >-
+  Learn how to set up performance replication clusters with integrated storage (Raft) as the storage backend.
 ---
 
-# Highly available Vault enterprise performance clusters with integrated storage (Raft)
+# Highly available Vault Enterprise performance clusters with integrated storage (Raft)
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/enterprise-with-raft.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Highly Available Vault Enterprise Cluster with Raft'
+page_title: 'Highly available Vault Enterprise cluster with integrated storage (Raft)'
 sidebar_current: 'docs-platform-k8s-examples-enterprise-with-raft'
-description: |-
-  Describes how to set up a highly available Vault Enterprise cluster with Integrated Storage (Raft)
+description: >-
+  Learn how to set up a highly available Vault Enterprise cluster with integrated storage (Raft) as the storage backend.
 ---
 
-# Highly available Vault enterprise cluster with integrated storage (Raft)
+# Highly available Vault Enterprise cluster with integrated storage (Raft)
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/external.mdx b/website/content/docs/platform/k8s/helm/examples/external.mdx
@@ -3,7 +3,7 @@ layout: 'docs'
 page_title: 'External Vault'
 sidebar_current: 'docs-platform-k8s-examples-external'
 description: |-
-  Describes how to set up an external Vault
+  Learn how to set up an external Vault server or cluster.
 ---
 
 # External Vault

diff --git a/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx b/website/content/docs/platform/k8s/helm/examples/ha-tls.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'HA Cluster with Raft and TLS'
+page_title: 'HA cluster with Raft and TLS'
 sidebar_current: 'docs-platform-k8s-examples-ha-tls'
-description: |-
-  Describes how to set up a Raft HA Vault cluster with TLS certificate
+description: >-
+  Learn how to set up a Raft HA Vault cluster with TLS certificate.
 ---
 
-# HA Cluster with Raft and TLS
+# HA cluster with Raft and TLS
 
 The overview for [Integrated Storage and
 TLS](/vault/docs/concepts/integrated-storage#integrated-storage-and-tls) covers

diff --git a/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx b/website/content/docs/platform/k8s/helm/examples/ha-with-consul.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Highly Available Vault Cluster with Consul'
+page_title: 'Highly available Vault cluster with Consul'
 sidebar_current: 'docs-platform-k8s-examples-ha-with-consul'
-description: |-
-  Describes how to set up a highly available Vault cluster with Consul backend
+description: >-
+  Learn how to set up a highly available Vault cluster with Consul as the storage backend.
 ---
 
-# Highly available Vault cluster with consul
+# Highly available Vault cluster with Consul
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx b/website/content/docs/platform/k8s/helm/examples/ha-with-raft.mdx
@@ -1,9 +1,9 @@
 ---
 layout: 'docs'
-page_title: 'Highly Available Vault Cluster with Raft'
+page_title: 'Highly available Vault cluster with integrated storage (Raft)'
 sidebar_current: 'docs-platform-k8s-examples-ha-with-raft'
-description: |-
-  Describes how to set up a highly available Vault cluster with Integrated Storage (Raft)
+description: >-
+  Learn how to set up a highly available Vault cluster with integrated storage (Raft) as the storage backend.
 ---
 
 # Highly available Vault cluster with integrated storage (Raft)

diff --git a/website/content/docs/platform/k8s/helm/examples/index.mdx b/website/content/docs/platform/k8s/helm/examples/index.mdx
@@ -1,9 +1,9 @@
 ---
 layout: 'docs'
-page_title: 'Examples'
+page_title: 'Helm chart examples'
 sidebar_current: 'docs-platform-k8s-examples'
 description: |-
-  This section documents configuration options for the Vault Helm chart
+  Examples of configuration options for the Vault Helm chart.
 ---
 
 # Helm chart examples

diff --git a/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx b/website/content/docs/platform/k8s/helm/examples/injector-tls-cert-manager.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Vault Agent Injector TLS with Cert-Manager'
+page_title: 'Vault Agent Injector TLS with cert-manager'
 sidebar_current: 'docs-platform-k8s-examples-injector-tls-cert-manager'
-description: |-
-  Describes how to set up the Vault Agent Injector with certificates and keys generated by cert-manager.
+description: >-
+  Learn how to set up the Vault Agent Injector with certificates and keys generated by cert-manager.
 ---
 
-# Vault agent injector TLS with Cert-Manager
+# Vault Agent Injector TLS with cert-manager
 
 The following instructions demonstrate how to configure the Vault Agent Injector to use certificates generated by [cert-manager](https://cert-manager.io/). This allows you to run multiple replicas of the Vault Agent Injector in a Kubernetes cluster.
 

diff --git a/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx b/website/content/docs/platform/k8s/helm/examples/injector-tls.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Vault Agent Injector TLS Configuration'
+page_title: 'Vault Agent Injector TLS configuration'
 sidebar_current: 'docs-platform-k8s-examples-injector-tls'
-description: |-
-  Describes how to set up the Vault Agent Injector with manually generated certificates and keys.
+description: >-
+  Learn how to set up the Vault Agent Injector with manually generated certificates and keys.
 ---
 
-# Vault agent injector TLS configuration
+# Vault Agent Injector TLS configuration
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx b/website/content/docs/platform/k8s/helm/examples/kubernetes-auth.mdx
@@ -1,12 +1,12 @@
 ---
 layout: 'docs'
-page_title: 'Using Kubernetes Auth Method'
+page_title: 'Bootstrapping Kubernetes auth method'
 sidebar_current: 'docs-platform-k8s-examples-kubernetes-auth'
-description: |-
-  Describes how to set up Kubernetes Auth method
+description: >-
+  Learn how to set up Kubernetes auth method.
 ---
 
-# Bootstrapping kubernetes auth method
+# Bootstrapping Kubernetes auth method
 
 @include 'helm/version.mdx'
 

diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-audit.mdx
@@ -1,9 +1,9 @@
 ---
 layout: 'docs'
-page_title: 'Standalone Server with Audit Storage'
+page_title: 'Standalone server with audit storage'
 sidebar_current: 'docs-platform-k8s-examples-standalone-audit'
-description: |-
-  Describes how to set up a standalone Vault with audit storage
+description: >-
+  Learn how to set up a standalone Vault server with audit storage.
 ---
 
 # Standalone server with audit storage

diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-load-balanced-ui.mdx
@@ -1,9 +1,9 @@
 ---
 layout: 'docs'
-page_title: 'Standalone Server with Load Balanced UI'
+page_title: 'Standalone server with load balanced UI'
 sidebar_current: 'docs-platform-k8s-examples-standalone-load-balanced-ui'
-description: |-
-  Describes how to set up a standalone Vault with a load balanced UI
+description: >-
+  Learn how to set up a standalone Vault server with a load balanced UI.
 ---
 
 # Standalone server with load balanced UI

diff --git a/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx b/website/content/docs/platform/k8s/helm/examples/standalone-tls.mdx
@@ -1,9 +1,9 @@
 ---
 layout: 'docs'
-page_title: 'Standalone Server with TLS'
+page_title: 'Standalone server with TLS'
 sidebar_current: 'docs-platform-k8s-examples-standalone-tls'
-description: |-
-  Describes how to set up a standalone Vault with TLS certificate
+description: >-
+  Learn how to set up a standalone Vault server with TLS certificate.
 ---
 
 # Standalone server with TLS

diff --git a/website/content/docs/platform/k8s/helm/index.mdx b/website/content/docs/platform/k8s/helm/index.mdx
@@ -1,9 +1,8 @@
 ---
 layout: docs
-page_title: Helm - Kubernetes
+page_title: Helm chart
 description: >-
-  The Vault Helm chart is the recommended way to install and configure Vault on
-  Kubernetes.
+  Install and configure Vault on Kubernetes using the Vault Helm chart which is the recommended way.
 ---
 
 # Helm chart

diff --git a/website/content/docs/platform/k8s/helm/openshift.mdx b/website/content/docs/platform/k8s/helm/openshift.mdx
@@ -1,8 +1,8 @@
 ---
 layout: docs
-page_title: Running Vault - OpenShift
+page_title: Run Vault on OpenShift
 description: >-
-  Vault can run directly on OpenShift in various configurations.  For
+  Run Vault directly on OpenShift in various configurations. For
   pure-OpenShift workloads, this enables Vault to also exist purely within
   Kubernetes.
 ---