tools: adds doc links to the stability index reference - #11664
Closed
michaelcox wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
I think that the commit message should be tools rather than doc;) |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
|
Thanks - updated to be tools instead. Makes more sense. :) |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
cc @nodejs/documentation |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
I don't think this file is exercised by any tests, but it is covered by lint rules, so here's a CI lint run for it: https://ci.nodejs.org/job/node-test-linter/7386/ |
Sorry, something went wrong.
thefourtheye
approved these changes
Mar 3, 2017
Comment thread
tools/doc/html.js
Outdated
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Nit: I would prefer writing this as,
`<pre class="${classNames}">
<a href="${docsUrl}">$1 $2</a>$3
</pre>`
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
There was a problem hiding this comment.
I've updated to bring the closing </pre> to the same line, but I can't write it nested the way you have it because of the default formatting of a <pre> tag. Doing it the way you had it adds another 20px-ish left padding into the bar.
Sorry, something went wrong.
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html.
jasnell
approved these changes
Mar 3, 2017
fhinkel
approved these changes
Mar 9, 2017
fhinkel
pushed a commit
that referenced
this pull request
Mar 9, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Mar 13, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
jungx098
pushed a commit
to jungx098/node
that referenced
this pull request
Mar 21, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 17, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 19, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Merged
andrew749
pushed a commit
to michielbaird/node
that referenced
this pull request
Jul 19, 2017
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs/node#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
9 participants
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.
Checklist
Affected core subsystem(s)
tools
Description of Change
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. This was a first-commit request from @Trott. Here is what he pitched to me:
I looked for any precedent for styling, and the best I could find is that when features are deprecated, a simple link is put to the new API to use, inside the banner. This similarly just links the first part (e.g. Stability: 2) to the documentation.html page. I'm obviously open to other styling suggestions, but this seemed the most straightforward. There doesn't seem to be any precedent in the docs for other things like a ? icon or similar.
Also I'm just linking to the main anchor for the Stability Index explanations, rather than to a specific one. My thinking here is that there are only a handful of them, and they should all fit nicely above the fold for anyone reading that page. It didn't seem necessary to create additional anchors.
Note that I had to make a couple more variables in the commit here to make the tests pass with the 80 character line limit.