[DOCS] Update the title & description for SEO improvement #29115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
hashicorp-contributed-pr
|
CI Results: |
|
Build Results: |
jonathanfrappier
previously approved these changes
Dec 6, 2024
sgmiller
reviewed
Dec 6, 2024
| @@ -1,7 +1,7 @@ | |||
| --- | |||
| layout: docs | |||
| page_title: KMIP - Profiles Support | |||
| description: |- | |||
| page_title: KMIP profiles version 1.4 | |||
There was a problem hiding this comment.
I don't think this change is accurate. @victorr ?
There was a problem hiding this comment.
I agree with Scott, I think the original title is better (without "version 1.4").
There was a problem hiding this comment.
I think it is fine to change the H1 header to match the title. The second paragraph informs of the KMIP version, so it is fine for the header to drop it.
schavis
previously approved these changes
Dec 6, 2024
Co-authored-by: Sarah Chavis <[email protected]>
victorr
approved these changes
Dec 16, 2024
| IAM policies. | ||
| page_title: AWS secrets engine | ||
| description: >- | ||
| Dynamically generate access keys based on IAM policies with the AWS secrets engine plugin. |
There was a problem hiding this comment.
Maybe remove plugin and use "...the AWS secrets engine"?
schavis
approved these changes
Dec 18, 2024
Merged
24 tasks
Monkeychip
pushed a commit
that referenced
this pull request
Dec 20, 2024
* Update the title & description for SEO improvement * Minor updates for style consistency * Revert back the change * Update website/content/docs/secrets/aws.mdx Co-authored-by: Sarah Chavis <[email protected]> --------- Co-authored-by: Sarah Chavis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the secrets engine docs title & description for style consistency, as well as SEO improvement.
secrets/alicloud.mdxsecrets/aws.mdxsecrets/azure.mdxsecrets/consul.mdxsecrets/cubbyhole.mdxsecrets/gcp.mdxsecrets/gcpkms.mdxsecrets/index.mdxsecrets/kmip-profiles.mdxsecrets/kmip.mdxsecrets/kubernetes.mdxsecrets/ldap.mdxsecrets/mongodbatlas.mdxsecrets/nomad.mdxsecrets/rabbitmq.mdxsecrets/terraform.mdxupdates "Terraform Cloud" to say "HCP Terraform"secrets/totp.mdxsecrets/venafi.mdxTODO only if you're a HashiCorp employee
backport/label that matches the desired release branch. Note that in the CE repo, the latest release branch will look likebackport/x.x.x, but older release branches will bebackport/ent/x.x.x+ent.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.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.