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

Syntax Highlighting license #27397

Closed
BethGriggs opened this issue Apr 24, 2019 · 9 comments
Closed

Syntax Highlighting license #27397

BethGriggs opened this issue Apr 24, 2019 · 9 comments
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.

Comments

@BethGriggs
Copy link
Member

This might not be an issue, but one of our scanning tools picked up on it so thought I'd post it for discussion anyway.

Syntax Highlighting JS (https://github.com/nodejs/node/blob/master/doc/api_assets/sh_main.js) has a GPLv3 license. It is only used in the docs, but I don't know if this could have implications if anyone was to redistribute the docs (perhaps unlikely?).

Should the license potentially be listed/mentioned somewhere else in addition to the file itself?

I notice that SHJS is also over in nodejs/nodejs.org. Do we still need it in nodejs/node, could it be pulled in from nodejs.org? (refs: nodejs/nodejs.org#2150 (comment)).

Admittedly I do not know the history of this file/docs. /cc @nodejs/documentation

@BethGriggs BethGriggs added the doc Issues and PRs related to the documentations. label Apr 24, 2019
@richardlau
Copy link
Member

#22831 replaces the file but that PR appears to have stalled.

@BridgeAR
Copy link
Member

BridgeAR commented Jan 4, 2020

This is currently discussed in a more generic fashion in #30241.

@BridgeAR BridgeAR added the meta Issues and PRs related to the general management of the project. label Jan 4, 2020
@BethGriggs
Copy link
Member Author

SHJS was removed from this repository in #33442 (@DerekNonGeneric 🎉), but I am not sure if it can/should be removed from nodejs/nodejs.org too?

@DerekNonGeneric
Copy link
Contributor

but I am not sure if it can/should be removed from nodejs/nodejs.org too?

@BethGriggs, the website appears to be using Prism. Please see the comment below.

LGTM, I'd just point out the org site is running https://prismjs.com/ rather than highlight.js, but I think that shouldn't be an issue.
#33442 (review)

Were you thinking to use highlight.js everywhere?

@richardlau
Copy link
Member

SHJS was removed from this repository in #33442 (@DerekNonGeneric 🎉), but I am not sure if it can/should be removed from nodejs/nodejs.org too?

The old docs, e.g. https://nodejs.org/docs/latest-v0.10.x/api/, reference https://nodejs.org/sh_main.js and https://nodejs.org/sh_javascript.min.js (also see the README in https://github.com/nodejs/nodejs.org/tree/master/static/legacy).

@jasnell
Copy link
Member

jasnell commented Jun 26, 2020

What action is needed here then?

@targos
Copy link
Member

targos commented Nov 20, 2021

Ping @BethGriggs

@BethGriggs
Copy link
Member Author

As SHJS is still used for the legacy documentation I do not see what we can do about this. Perhaps we can just close as we've now moved away from it in Node.js core.

@DerekNonGeneric
Copy link
Contributor

Yes, we would not want to have old versions' docs un-syntax-highlighted. That would be barbaric.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

No branches or pull requests

6 participants