Skip to content

docs: add -download ent command option for plugin register - #31196

Merged
maithyton merged 3 commits into
mainfrom
thyton/VAULT-37546/cli-doc-download-plugin-register
Jul 3, 2025
Merged

docs: add -download ent command option for plugin register#31196
maithyton merged 3 commits into
mainfrom
thyton/VAULT-37546/cli-doc-download-plugin-register

Conversation

@maithyton

Copy link
Copy Markdown
Contributor

Description

What does this PR do?
The PR documents -download ent command option for plugin register

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.

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've documented the impact of any changes to security controls.

Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.

@maithyton
maithyton requested review from a team as code owners July 3, 2025 01:38
@maithyton
maithyton requested review from anwittin and brewgator July 3, 2025 01:38
@github-actions github-actions Bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jul 3, 2025
@maithyton maithyton added pr/no-changelog and removed hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed labels Jul 3, 2025
@github-actions

github-actions Bot commented Jul 3, 2025

Copy link
Copy Markdown

CI Results:
All Go tests succeeded! ✅

@github-actions

github-actions Bot commented Jul 3, 2025

Copy link
Copy Markdown

Build Results:
All builds succeeded! ✅

Register a plugin with download:

```shell-session
$ vault plugin register

@schavis schavis Jul 3, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We generally try to avoid using comments in example code to explain what's happening in the command. We should move the information to the intro sentence for the example. I added a suggestion to that effect.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fixed in e78bdb8

Comment thread website/content/docs/commands/plugin/register.mdx Outdated
Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
@github-actions github-actions Bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jul 3, 2025
@maithyton
maithyton requested a review from schavis July 3, 2025 18:49
@maithyton
maithyton merged commit c0f4c20 into main Jul 3, 2025
27 of 28 checks passed
@maithyton
maithyton deleted the thyton/VAULT-37546/cli-doc-download-plugin-register branch July 3, 2025 18:51
Erfankam pushed a commit to Erfankam/vault that referenced this pull request Sep 1, 2025
…#31196)

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants