Skip to content

Update index.mdx #30783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update index.mdx #30783

wants to merge 1 commit into from

Conversation

bmeyer99
Copy link

Description

What does this PR do?
Added CLI install instructions

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@Copilot Copilot AI review requested due to automatic review settings May 29, 2025 16:39
@bmeyer99 bmeyer99 requested review from a team as code owners May 29, 2025 16:39
@bmeyer99 bmeyer99 requested review from scellef and elliesterner May 29, 2025 16:39
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Vault documentation page for installing Vault by introducing new CLI install instructions. The key change is the addition of a new instructional line encouraging terminal usage.

@@ -6,6 +6,7 @@ description: >-
---

# Get Vault
Pray to your terminal gods so they can install the CLI for you
Copy link
Preview

Copilot AI May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The added instruction uses informal language that may not align with the professional tone expected in official documentation. Consider rephrasing to a clearer and more straightforward instruction, such as 'Install the CLI using your preferred package manager.'

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant