Backport of adjust permalinks in vault partials into release/1.18.x #29002
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
hc-github-team-secure-vault-core
requested a review
from a team
as a code owner
hc-github-team-secure-vault-core
force-pushed
the
backport/zs.patch-permalink-issues/lively-integral-seagull
branch
from
6ee53f5
to
2684ff1
Compare
github-actions
bot
added
the
hashicorp-contributed-pr
schavis
approved these changes
Nov 22, 2024
|
CI Results: |
|
Build Results: |
zchsh
approved these changes
Nov 22, 2024
schavis
deleted the
backport/zs.patch-permalink-issues/lively-integral-seagull
branch
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.
Backport
This PR is auto-generated from #28996 to be assessed for backporting due to the inclusion of the label backport/1.18.x.
The below text is copied from the body of the original PR.
Description
This PR fixes a downstream error by replacing a custom HTML approach to permalinks with the supported "list items of inline code" approach to permalinks.
For documentation on supported approaches to permalinks, see https://github.com/hashicorp/web-platform-packages/tree/main/packages/remark-plugins/plugins/anchor-links.
Screenshots
Note
The appearance of permalinks is not identical to how it was with the custom HTML approach. However, we're unable to deploy the custom HTML approach to production, as our docs rendering system is designed to handle plain markdown rather than HTML. The approach in this PR aims to get as close as we can to previous UX and UI.
We could iterate further on this approach - for example, removing underlines, changing styles, avoiding the requirement of using "list items", and so on - by making code changes to our
anchor-linksplugin and to hashicorp/dev-portal, rather than content changes in this repo.Related
The contents of this PR can be previewed and validated through both the deploy preview off of this PR, and the following PR downstream in
hashicorp/dev-portal:Overview of commits