From e53aeddd56487a260283cda7cfbf37c96d439cf6 Mon Sep 17 00:00:00 2001 From: Loann Le <84412881+taoism4504@users.noreply.github.com> Date: Fri, 1 Apr 2022 13:37:38 -0700 Subject: [PATCH] Vault documentation: changing references from learn to tutorial (#14844) * changed learn to tutorial references * changed learn to tutorial * Update website/content/docs/plugins/plugin-portal.mdx Co-authored-by: Yoko Hyakuna * Update website/content/docs/platform/aws/run.mdx Co-authored-by: Yoko Hyakuna Co-authored-by: Yoko Hyakuna --- .../content/api-docs/system/storage/raftautopilot.mdx | 2 +- website/content/docs/commands/operator/usage.mdx | 4 ++-- website/content/docs/install.mdx | 4 ++-- website/content/docs/platform/aws/run.mdx | 2 +- .../docs/platform/k8s/helm/examples/development.mdx | 6 +++--- website/content/docs/platform/k8s/helm/index.mdx | 9 ++++----- website/content/docs/plugins/plugin-portal.mdx | 7 +++---- website/content/docs/what-is-vault.mdx | 6 +++--- 8 files changed, 19 insertions(+), 21 deletions(-) diff --git a/website/content/api-docs/system/storage/raftautopilot.mdx b/website/content/api-docs/system/storage/raftautopilot.mdx index b1c465ecaf..702c0f80b6 100644 --- a/website/content/api-docs/system/storage/raftautopilot.mdx +++ b/website/content/api-docs/system/storage/raftautopilot.mdx @@ -12,7 +12,7 @@ description: |- The `/sys/storage/raft/autopilot` endpoints are used to manage raft clusters using autopilot with Vault's [Integrated Storage backend](/docs/internals/integrated-storage). -For a tutorial on Integrated Storage autopilot, see the [Learn guide here](https://learn.hashicorp.com/tutorials/vault/raft-autopilot?in=vault/raft). +Refer to the [Integrated Storage Autopilot](https://learn.hashicorp.com/tutorials/vault/raft-autopilot?in=vault/raft) tutorial to learn how to manage raft clusters using autopilot. ## Get Cluster State diff --git a/website/content/docs/commands/operator/usage.mdx b/website/content/docs/commands/operator/usage.mdx index f333814f0a..65c35a045b 100644 --- a/website/content/docs/commands/operator/usage.mdx +++ b/website/content/docs/commands/operator/usage.mdx @@ -17,8 +17,8 @@ indicate that no data is available for the requested time range, which may be because the client count reporting is disabled, the time range is too far in the past, or no data has yet been collected since the feature was enabled. -> The HashiCorp Learn site provides a detailed tutorial on [Vault Usage Metrics](https://learn.hashicorp.com/tutorials/vault/usage-metrics), -including required policy and data collection details. +> Refer to the [Vault Usage Metrics](https://learn.hashicorp.com/tutorials/vault/usage-metrics) tutorial to learn more about usage metrics, +> including required policy and data collection details. ## Examples diff --git a/website/content/docs/install.mdx b/website/content/docs/install.mdx index c35e4ef52b..6a7271bf50 100644 --- a/website/content/docs/install.mdx +++ b/website/content/docs/install.mdx @@ -24,7 +24,7 @@ with the SHA256 sums that can be verified. We build and sign official packages for Ubuntu, Debian, Fedora, RHEL, Amazon Linux, and other distributions. Follow the instructions at [HashiCorp -Learn][learn-vault-install] to add our PGP key, add our repository, and +Tutorials][learn-vault-install] to add our PGP key, add our repository, and install. ## Precompiled Binaries @@ -39,7 +39,7 @@ additional files are required to run Vault. Copy the binary to anywhere on your system. If you intend to access it from the command-line, make sure to place it somewhere on your `PATH`. -Continue on to [HashiCorp Learn][learn-vault-dev-server] to start a server, `put` +Continue on to [HashiCorp Tutorials][learn-vault-dev-server] to start a server, `put` your first secret, and use other features of Vault. ## Compiling from Source diff --git a/website/content/docs/platform/aws/run.mdx b/website/content/docs/platform/aws/run.mdx index 036fb6ee67..6dbe325ea7 100644 --- a/website/content/docs/platform/aws/run.mdx +++ b/website/content/docs/platform/aws/run.mdx @@ -30,7 +30,7 @@ To upgrade a Vault instance launched from an official AWS Marketplace AMI, pleas HashiCorp’s AWS Marketplace offerings provide an easy way to deploy Vault in a single-instance configuration using the [Filesystem storage backend](/docs/configuration/storage/filesystem), but for production use, we recommend running Vault on AWS with the same [general architecture](/docs/internals/architecture) as running it anywhere else. While the Filesystem storage backend is officially supported by HashiCorp, it does not support High Availability. Because Vault data is stored on disk in this configuration, it is subject to the durability and availability of Amazon Elastic Block Store (EBS) and should be backed up accordingly. -For additional guidance on best practices for running Vault in production, please refer to the [production hardening guide](https://learn.hashicorp.com/vault/day-one/production-hardening). +For additional guidance on best practices for running Vault in production, please refer to the [Production Hardening](https://learn.hashicorp.com/vault/day-one/production-hardening) tutorial. # Getting Support diff --git a/website/content/docs/platform/k8s/helm/examples/development.mdx b/website/content/docs/platform/k8s/helm/examples/development.mdx index 413469f9a8..66ec9f0647 100644 --- a/website/content/docs/platform/k8s/helm/examples/development.mdx +++ b/website/content/docs/platform/k8s/helm/examples/development.mdx @@ -18,8 +18,8 @@ server: enabled: true ``` -## Learn +## Tutorial Refer to the [Injecting Secrets into Kubernetes Pods via Vault Helm -Sidecar](https://learn.hashicorp.com/vault/getting-started-k8s/sidecar) guide -for a step-by-step tutorial. +Sidecar](https://learn.hashicorp.com/vault/getting-started-k8s/sidecar) tutorial +to learn how to set up Vault and the Vault Agent Injector service with the Vault Helm chart. diff --git a/website/content/docs/platform/k8s/helm/index.mdx b/website/content/docs/platform/k8s/helm/index.mdx index eb8a9cba2a..7be84a8f2c 100644 --- a/website/content/docs/platform/k8s/helm/index.mdx +++ b/website/content/docs/platform/k8s/helm/index.mdx @@ -24,7 +24,7 @@ properly installed and configured with your Kubernetes cluster. Helm must be installed and configured on your machine. Please refer to the [Helm documentation](https://helm.sh/) or the [Vault Installation to Minikube via -Helm](https://learn.hashicorp.com/tutorials/vault/kubernetes-minikube) guide. +Helm](https://learn.hashicorp.com/tutorials/vault/kubernetes-minikube) tutorial. To use the Helm chart, add the Hashicorp helm repository and check that you have access to the chart: @@ -57,8 +57,7 @@ cluster](https://kubernetes.io/docs/tasks/administer-cluster/securing-a-cluster/ options](/docs/platform/k8s/helm/configuration), and read the [production deployment checklist](/docs/platform/k8s/helm/run#architecture). -## Learn +## Tutorial -Refer to the [Run Vault on -Kubernetes](https://learn.hashicorp.com/collections/vault/kubernetes) -guides for step-by-step tutorials. +Refer to the [Kubernetes](https://learn.hashicorp.com/collections/vault/kubernetes) +tutorials series to learn how to run Vault on Kubernetes. diff --git a/website/content/docs/plugins/plugin-portal.mdx b/website/content/docs/plugins/plugin-portal.mdx index 92a8889e40..f3c1ca1a5d 100644 --- a/website/content/docs/plugins/plugin-portal.mdx +++ b/website/content/docs/plugins/plugin-portal.mdx @@ -10,8 +10,7 @@ This page contains a curated collection of official, partner, and community [Vault plugins](/docs/plugins). For more information about plugin development, refer to this [documentation -section](/docs/plugins/plugin-development) and this [Learn -Guide](https://learn.hashicorp.com/vault/developer/plugin-backends). +section](/docs/plugins/plugin-development). In addition, the [Custom Secrets Engines](https://learn.hashicorp.com/collections/vault/custom-secrets-engine) tutorial series demonstrates the plugin development workflow in more detail. ## Official @@ -128,8 +127,8 @@ Plugin authors who wish to have their plugins listed may file a submission via a - [Jenkins](https://plugins.jenkins.io/hashicorp-vault-plugin) - [Terraform Enterprise/Terraform Cloud](https://github.com/gitrgoliveira/vault-plugin-auth-tfe) -- [SSH](https://github.com/42wim/vault-plugin-auth-ssh) - +- [SSH](https://github.com/42wim/vault-plugin-auth-ssh) + ### Secrets - [AWS Cognito](https://github.com/WealthWizardsEngineering/vault-plugin-secrets-cognito) diff --git a/website/content/docs/what-is-vault.mdx b/website/content/docs/what-is-vault.mdx index 68aa2b97c2..86d07f411e 100644 --- a/website/content/docs/what-is-vault.mdx +++ b/website/content/docs/what-is-vault.mdx @@ -61,7 +61,7 @@ To learn more about HCP Vault, see the [HCP Vault documentation](https://cloud.h ## Next Steps -See the page on [Vault use cases](/docs/use-cases) to see the multiple ways -Vault can be used. Then, continue onwards with the [getting started -guide](https://learn.hashicorp.com/vault/getting-started/install) to use Vault +See the page on [Vault use cases](/docs/use-cases) to learn about the multiple ways +Vault can be used. Then, continue onwards with the [Getting Started +(https://learn.hashicorp.com/collections/vault/getting-started) tutorial to use Vault to read, write, and create real secrets and see how it works in practice.