doc: remove hoe-markdown #3033
Merged
doc: remove hoe-markdown #3033
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
We'll rely on github to linkify this doc properly in the repo, and move markdownification into nokogiri.org for rendering the site.
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.
What problem is this PR intended to solve?
The CHANGELOG.md file has had hyperlinked issues, PRs, and usernames since 0ac9033 / 2020-02-02 so that, when rendered on nokogiri.org, users could easily get to deeper information.
The downside, though, is that when the changelog snippets are copied to release notes, usernames aren't added to the "contributors" list for the release; and the release notes consumed by tools like dependabot and libraries.io don't really need the hyperlinks and it's sometimes just messy-looking.
So this PR removes the markdown linkification, and updates the CHANGELOG to just have bare references like
#1234and@flavorjones.Separately, I've added hoe-markdown to nokogiri.org in sparklemotion/nokogiri.org@4fa918d so the site will still have everything linkified.
Have you included adequate test coverage?
unneeded.
Does this change affect the behavior of either the C or the Java implementations?
N/A