Backport of [docs] update doc headers into release/1.12.x#13564
Merged
kschoche merged 2 commits intorelease/1.12.xfrom Jun 23, 2022
Merged
Conversation
hc-github-team-consul-core
force-pushed
the
backport/update_helm_docs_june21/mainly-liberal-mullet
branch
from
8c0367b to
a610868
Compare
github-actions
bot
added
the
type/docs
* update helm docs to have correct headers
im2nguyen
approved these changes
Jun 23, 2022
kschoche
approved these changes
Jun 23, 2022
kschoche
deleted the
backport/update_helm_docs_june21/mainly-liberal-mullet
branch
eculver
pushed a commit
that referenced
this pull request
Jun 23, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Backport
This PR is auto-generated from #13527 to be assessed for backporting due to the inclusion of the label type/docs-cherrypick.
WARNING automatic cherry-pick of commits failed. Commits will require human attention.
The below text is copied from the body of the original PR.
Description
Describe why you're making this change, in plain English.
Use anchor links for table of contents in helm k8s docs.
Due to functionality we have which auto-generates anchors for code snippets which are list items. connectInject exists higher up the page as a list item, and so an anchor is generated for it with the id #connectinject. Because the heading we are trying to link to is further down the page, it gets the -1 suffix to ensure uniqueness, use anchor links instead.
Testing & Reproduction steps
Links
Include any links here that might be helpful for people reviewing your PR (Tickets, GH issues, API docs, external benchmarks, tools docs, etc). If there are none, feel free to delete this section.
Please be mindful not to leak any customer or confidential information. HashiCorp employees may want to use our internal URL shortener to obfuscate links.
PR Checklist