[skip changelog] Disable internal anchor checks by link checker tool #1692
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
Validation of links to internal anchors was recently added to the markdown-link-check tool used to check for broken links in this project's documentation. Although a much needed feature, unfortunately it does not currently support anchors created by HTML anchor tags. For example, this is valid and common Markdown: [click here](#some-anchor) <a name="some-anchor"></a> but will fail the check: ERROR: 1 dead links found! [x] #some-anchor -> Status: 404 This type of link markup is used by the protoc-gen-doc tool that generates the gRPC interface documentation, which causes a spurious failure of the link check. The solution is to configure markdown-link-check to skip these links (which was the behavior anyway with versions 3.8.7 and older). That will be reverted whenever the tool is able to correctly validate internal anchor links.
per1234
added
topic: infrastructure
umbynos
approved these changes
Mar 22, 2022
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.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)Docs have been added / updated (for bug fixes / features)UPGRADING.mdhas been updated with a migration guide (for breaking changes)Infrastructure bug fix.
Validation of links to internal anchors (tcort/markdown-link-check@6522186) was recently added to the "markdown-link-check" tool used to check for broken links in this project's documentation.
Although a much needed feature, unfortunately it does not currently support anchors created by HTML anchor tags (tcort/markdown-link-check#195).
For example, this is valid and common Markdown:
but will fail the check:
This type of link markup is used by the "protoc-gen-doc" tool that generates the gRPC interface documentation, causing a spurious failure of the link check.
The solution is to configure "markdown-link-check" to skip these links (which was the behavior anyway with versions 3.9.0 and older of that tool). That configuration will be reverted whenever the tool is able to correctly validate internal anchor links (tcort/markdown-link-check#195).
titled accordingly?
No breaking change.