Update mdtoc, fix TOC entries with backticks #4437
Merged
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
v1.1.0 (which is 3 years old, but only 1 commit newer than what we're currently using) correctly handles headings with backticked elements.
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
sig/api-machinery
|
/assign @mrbobbytables |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: danwinship, mrbobbytables The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
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.
The version of mdtoc currently used by
update-toc.sh/verify-toc.shdoes not handle headings with backticks in them, resulting in broken links in some KEPs. eg, in the nftables kube-proxy KEP, the table of contents entry for the##### Forcing traffic on `HealthCheckNodePort`s to be acceptedheading links to#forcing-traffic-on-s-to-be-acceptedbut the actual anchor generated by GitHub is#forcing-traffic-on-healthchecknodeports-to-be-accepted.This has actually been fixed in https://github.com/kubernetes-sigs/mdtoc for a very long time, we're just still using a very old version of mdtoc...
cc @saschagrunert