FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add internal links and backticks around names by svenheden · Pull Request #4054 · nodejs/node · GitHub

/ node Public

doc: add internal links and backticks around names - #4054

Closed
svenheden wants to merge 2 commits into
nodejs:masterfrom
svenheden:doc/internal-links
ConversationCommits (2)ChecksFiles changed
Closed

doc: add internal links and backticks around names#4054
svenheden wants to merge 2 commits into
nodejs:masterfrom
svenheden:doc/internal-links

Conversation

svenheden commented Nov 28, 2015

Copy link
Copy Markdown

I noticed some inconsistencies in the docs that I've fixed in these commits.

  • Added backticks around all names
  • Added single quotes around all event names
  • Added parenthesis after function names
  • Added internal links between different sections
  • Added external links to MDN for some JavaScript references
  • Sorted the link definitions alphabetically

mscdex added http Issues or PRs related to the http subsystem. doc Issues and PRs related to the documentations. labels Nov 28, 2015

JungMinu commented Nov 28, 2015

Copy link
Copy Markdown
Member

would you squash the commits?

Trott commented Nov 28, 2015

Copy link
Copy Markdown
Member

/cc @nodejs/documentation

svenheden commented Nov 29, 2015

Copy link
Copy Markdown
Author

Sure @JungMinu, I’ve squashed them and force pushed now.

svenheden changed the title doc: add internal links and backticks around names in the http docs doc: add internal links and backticks around names Nov 29, 2015

cjihrig commented Nov 30, 2015

Copy link
Copy Markdown
Contributor

Did we ever decide on a policy for linking out to third parties such as MDN and unix man pages? Also, 27 commits still seems a bit much.

svenheden commented Nov 30, 2015

Copy link
Copy Markdown
Author

The reason I added links to MDN was because there was already 5 links to it from other parts of the docs, so I figured you thought it was a reliable source.

There's one commit per "page", would one PR per page have been better, or one commit with all pages in it?

silverwind removed the http Issues or PRs related to the http subsystem. label Nov 30, 2015

rvagg commented Nov 30, 2015

Copy link
Copy Markdown
Member

The (unfortunate) precedent for one-commit per page was set in #3662.

I'm +1 on links to MDN, Wikipedia and authoritative sources (like openssl and libuv) where we know the URLs will be consistent over time. I'm concerned about links to man pages as there's no good authoritative source for those, we seem to be using man7.org and I'm not sure why that was chosen.

I'm also a strong +1 on switching to https in links where possible. Some of the Wikipedia links in this PR are http for example, they'll be redirected when you get to Wikipedia but leakage has already occurred with a plaintext redirect.

svenheden commented Nov 30, 2015

Copy link
Copy Markdown
Author

I didn't add any Wikipedia links in this PR (but sorted the link definitions so it might look that way), but I could go through the Wikipedia links and update them if you like.

Do you want me to squash the 27 commits into 1?

silverwind commented Dec 2, 2015

Copy link
Copy Markdown
Contributor

I'm fine with linking to MDN as it is the most user-friendly resource. Technically, one could link to spec documents, but these are often way to verbose for the average user. I'd prefer all of this in a single commit. Also +1 for correcting links to https where possible, but that could be done in a seperate commit.

jpersson added 2 commits December 2, 2015 11:22
doc: add links and backticks around names
b366548 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically
doc: update links to use https where possible
d310d2f

svenheden commented Dec 2, 2015

Copy link
Copy Markdown
Author

Cool, I've squashed it to one commit now and updated the http:// links to https:// where possible.

cjihrig commented Dec 2, 2015

Copy link
Copy Markdown
Contributor

Rubber stamp LGTM

silverwind commented Dec 3, 2015

Copy link
Copy Markdown
Contributor

LGTM, nice work!

jasnell commented Dec 3, 2015

Copy link
Copy Markdown
Member

LGTM

jasnell pushed a commit that referenced this pull request Dec 3, 2015
doc: add links and backticks around names
14b3aab 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically

PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
jasnell pushed a commit that referenced this pull request Dec 3, 2015
doc: update links to use https where possible
7e4f22c 
PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>

jasnell commented Dec 3, 2015

Copy link
Copy Markdown
Member

Landed in 14b3aab and 7e4f22c

jasnell closed this Dec 3, 2015
svenheden deleted the doc/internal-links branch December 3, 2015 21:42
rvagg pushed a commit that referenced this pull request Dec 5, 2015
doc: add links and backticks around names
3169eed 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically

PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
rvagg pushed a commit that referenced this pull request Dec 5, 2015
doc: update links to use https where possible
f4164bd 
PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
This was referenced Dec 8, 2015
Closed
Merged
rvagg mentioned this pull request Dec 17, 2015
Closed
MylesBorins pushed a commit that referenced this pull request Dec 29, 2015
doc: add links and backticks around names
24117ee 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically

PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins mentioned this pull request Jan 14, 2016
Closed
rvagg pushed a commit that referenced this pull request Jan 15, 2016
doc: update links to use https where possible
476ac24 
PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>

rvagg commented Jan 15, 2016

Copy link
Copy Markdown
Member

landed second commit from here on v4.x-staging @ 476ac24, only one made it last time / @thealphanerd

MylesBorins commented Jan 15, 2016

Copy link
Copy Markdown
Contributor

bah... sorry about that. I'm playing with some ideas about how this could be automated to minimize on human error.

Thanks for taking the time to audit!

jasnell commented Jan 15, 2016

Copy link
Copy Markdown
Member

+1 for automation. @thealphanerd and I have discussed it a few times and the pain is real.

MylesBorins pushed a commit that referenced this pull request Jan 19, 2016
doc: add links and backticks around names
e2fe214 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically

PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jan 19, 2016
doc: update links to use https where possible
33e72e1 
PR-URL: #4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins mentioned this pull request Jan 19, 2016
Merged
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
doc: add links and backticks around names
ee95e4c 
* add backticks around names
* add single quotes around event names
* add parenthesis after function names
* add internal links between different sections
* add external links to MDN for some JavaScript references
* sort the link definitions alphabetically

PR-URL: nodejs#4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
doc: update links to use https where possible
4c88008 
PR-URL: nodejs#4054
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

Back | FazBrowse Home | New Git URL