Skip to content
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

CLI List and HCP command docs refresh #28778

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

CLI List and HCP command docs refresh #28778

wants to merge 25 commits into from

Conversation

kiannaquach
Copy link
Contributor

Description

CLI docs updated:

  • list command
  • hcp
    • connect command
    • disconnect command

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • 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.

@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Oct 25, 2024
Copy link

CI Results:
All Go tests succeeded! ✅

@kiannaquach kiannaquach changed the title [WIP] cli docs CLI List and HCP command docs refresh Oct 29, 2024
@kiannaquach kiannaquach marked this pull request as ready for review October 29, 2024 14:56
@kiannaquach kiannaquach requested a review from a team as a code owner October 29, 2024 14:56
Copy link

Build Results:
All builds succeeded! ✅

website/content/docs/commands/hcp/connect.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/hcp/connect.mdx Show resolved Hide resolved
website/content/docs/commands/hcp/connect.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/hcp/connect.mdx Outdated Show resolved Hide resolved
- `-secret-id` `(string: "")` - Secret ID belonging to a service principal
credential previously generated in the HCP Portal. **Required for
non-interactive authentication**.
@include 'cli/hcp/flags/secret-id.mdx'
Copy link
Contributor

Choose a reason for hiding this comment

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

We should list flags in alphabetic order

website/content/docs/commands/hcp/disconnect.mdx Outdated Show resolved Hide resolved
website/content/docs/commands/hcp/disconnect.mdx Outdated Show resolved Hide resolved
website/content/partials/cli/hcp/flags/cluster-id.mdx Outdated Show resolved Hide resolved
website/content/partials/cli/hcp/flags/organization-id.mdx Outdated Show resolved Hide resolved
website/content/partials/cli/hcp/flags/project-id.mdx Outdated Show resolved Hide resolved
kiannaquach and others added 13 commits November 4, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants