Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): fix package id links in docs #11500

Merged
merged 1 commit into from Oct 4, 2019

Conversation

@davidjb
Copy link
Contributor

commented Oct 2, 2019

Pull Request check-list

Documentation-only change.

Description of change

These were previously being rendered as mailto: links via esdoc (which uses marked's autolink rendering); see https://sequelize.org/master/manual/upgrade-to-v5.html.

There are some suggestions about how one might disable or avoid autolinking but in this case the package identifiers are in backticks, producing weird behaviour similar to markedjs/marked#1327. Assuming the fix for this latter issue worked to solve this issue, then a dependency upgrade of marked within esdoc might solve the problem, but there are maintenance issues there preventing updates or merges.

Until that point, this is a workaround to avoiding the weird mailto: links on this page by using HTML and character encoded entities instead. Various attempts like <code>foobar@1.2.3</code> still rendered in the inner version spec as an email address.

These were previously being rendered via esdoc (which uses marked's
autolink rendering) as `mailto:` links.  There are some
[suggestions](https://gist.github.com/alexpeattie/4729247) about how one
might disable or avoid autolinking but in this case the package
identifiers are in backticks, producing weird behaviour similar to
markedjs/marked#1327.

Assuming the fix attached to this latter issue applied in this case,
then a dependency upgrade of `marked` within `esdoc` might solve the
problem, but there are [maintenance
issues](esdoc/esdoc#543) there.

Until that arrives, this is a workaround to avoiding the weird `mailto:`
links on this page.
@davidjb davidjb force-pushed the davidjb:fix-docs branch from ee169a1 to 4cbcd68 Oct 2, 2019
@codecov

This comment has been minimized.

Copy link

commented Oct 2, 2019

Codecov Report

Merging #11500 into master will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #11500      +/-   ##
==========================================
+ Coverage   96.24%   96.26%   +0.02%     
==========================================
  Files          94       94              
  Lines        9181     9181              
==========================================
+ Hits         8836     8838       +2     
+ Misses        345      343       -2
Impacted Files Coverage Δ
lib/dialects/postgres/connection-manager.js 95.77% <0%> (+1.4%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a90df5...4cbcd68. Read the comment docs.

@sushantdhiman sushantdhiman merged commit 3834fe2 into sequelize:master Oct 4, 2019
4 checks passed
4 checks passed
codecov/patch Coverage not affected when comparing 7a90df5...4cbcd68
Details
codecov/project 96.26% (+0.02%) compared to 7a90df5
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@sushantdhiman

This comment has been minimized.

Copy link
Member

commented Oct 5, 2019

🎉 This PR is included in version 5.19.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
You can’t perform that action at this time.