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

[DOCS] Update the PKI secrets engine docs title & description #29136

Merged
merged 10 commits into from
Dec 19, 2024

Conversation

yhyakuna
Copy link
Contributor

Description

This PR updates the secrets engine docs title & description for style consistency, as well as SEO improvement.

  • Match the H1 header and the page_title for consistency
  • Use <Note> callout elment instead of ~>

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.

@yhyakuna yhyakuna self-assigned this Dec 10, 2024
@yhyakuna yhyakuna requested review from a team as code owners December 10, 2024 02:01
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Dec 10, 2024
Copy link

CI Results:
All Go tests succeeded! ✅

Copy link

Build Results:
All builds succeeded! ✅

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
Copy link
Contributor

@victorr victorr left a comment

Choose a reason for hiding this comment

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

I left a couple of suggestions but I am "requesting changes" as the description in file rotation-primitives.mdx needs a slight correction.

website/content/docs/secrets/pki/considerations.mdx Outdated Show resolved Hide resolved
website/content/docs/secrets/pki/est.mdx Outdated Show resolved Hide resolved
website/content/docs/secrets/pki/rotation-primitives.mdx Outdated Show resolved Hide resolved
@yhyakuna yhyakuna requested a review from victorr December 16, 2024 22:54
@yhyakuna
Copy link
Contributor Author

@victorr Thank you so much for your help in updating the description! I believe I incorporated all your feedback, and it's ready for your review.

Copy link
Contributor

@victorr victorr left a comment

Choose a reason for hiding this comment

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

Awesome. 👍

@yhyakuna yhyakuna merged commit 32ba53f into main Dec 19, 2024
33 of 34 checks passed
@yhyakuna yhyakuna deleted the docs/secrets-seo-updates-3 branch December 19, 2024 13:36
Monkeychip pushed a commit that referenced this pull request Dec 20, 2024
* Update the PKI secrets engine docs title & description

* Update website/content/docs/secrets/pki/index.mdx

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>

* Incorporate the review feedback

---------

Co-authored-by: Jonathan Frappier <92055993+jonathanfrappier@users.noreply.github.com>
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.

4 participants