Repository navigation
docs: fix broken section anchors in 2-edge and 2.19 - #2158
Open
SatvikMishra08 wants to merge 1 commit into
Open
SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
Several in-page links point at heading anchors that no longer exist (sections were renamed or a typo crept in), so the browser lands at the top of the page instead of the referenced section: - circuit-breaking: #meshed-conncections typo, and the proxy-metrics link now points at #endpoint-metrics, where outbound_http_balancer_endpoints is documented - authorization-policy, fault-injection, configuring-per-route-policy: httproute #linkerd-and-gateway-api-httproutes -> #the-policylinkerdio-group - multicluster: automatic-mtls #how-does-it-work -> #how-does-linkerds-mtls-implementation-work - troubleshooting: server-policy #policy-annotations -> #default-policies - upgrade: install-helm #helm-upgrade-procedure -> #upgrading-with-helm Signed-off-by: Satvik Mishra <Satvikmishra.ipu146183@maims.ac.in>
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
1 participant
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.
Some links in the docs go to section anchors that don't exist anymore, so you end up at the top of the page and not at the section the text talks about. I found these by building the site locally and checking every
#fragmentagainst the heading ids in the output. I also checked each new anchor on linkerd.io.The same fixes are in
2-edgeand2.19:architecture/#meshed-conncections(typo)#meshed-connectionsproxy-metrics/#outbound-xroute-metrics#endpoint-metrics(whereoutbound_http_balancer_endpointsis described)httproute/#linkerd-and-gateway-api-httproutes#the-policylinkerdio-groupautomatic-mtls/#how-does-it-work#how-does-linkerds-mtls-implementation-workserver-policy/#policy-annotations#default-policiesinstall-helm/#helm-upgrade-procedure#upgrading-with-helmThe checker turned up a few more that I didn't touch, because fixing them needs rewording and not just a new anchor:
architecture/#grafanaand#dashboard(those sections are gone) andbooks/#service-profiles.