doc: move topics/guides to website #10896
Conversation
nodejs-github-bot
added
doc
|
Maybe |
|
@gibfahn good call. Thanks! |
|
So looking at the line counts between this and nodejs/nodejs.org#1105, it looks like:
Did |
|
Yes, I had to inline the js file. |
This commit removes the topics and guides that the documentation working group has proposed added to the website. We want them to have more visibility and believe that moving them to the website does that. Ref: nodejs/nodejs.org#1105 Fixes: nodejs#10792 PR-URL: nodejs#10896 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
|
Landed in 7eef09d. Thanks! |
This commit removes the topics and guides that the documentation working group has proposed added to the website. We want them to have more visibility and believe that moving them to the website does that. Ref: nodejs/nodejs.org#1105 Fixes: nodejs#10792 PR-URL: nodejs#10896 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
This commit removes the topics and guides that the documentation working group has proposed added to the website. We want them to have more visibility and believe that moving them to the website does that. Ref: nodejs/nodejs.org#1105 Fixes: nodejs#10792 PR-URL: nodejs#10896 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
|
So I'm not sure what we want to do about this for LTS... It just dawned on me that in the past our guides were versioned... so the proper guide was with LTS. Now we may have the wrong guides... /cc @nodejs/lts |
|
ping @nodejs/lts again |
|
Only the API docs from LTS branches shows up on the website, so there isn't much reason to backport this, is there? Since we won't be cherry picking anything back that touches the guides, since they don't exist on the master, it won't even help avoid future conflicts. |
When this was previously discussed in the docs WG, the general feeling was that we should do this first to get the guides more visible, and worry about things like multiple versions later. The alternative to this would be to do what we do with the api docs, but that's a lot more involved. Previously, no-one really knew that the user guides existed, so this is at least a step in the right direction. |
|
@gibfahn based on that, should we backport the removal? |
|
@MylesBorins I can't find any signs that the guides even show up on the website for older releases, am I missing it? Given that, back-port or not is just a matter of what makes maintaing LTS easier. Since its just removing files, I don't think we need this, there won't be conflicts. |
@sam-github The new location is directly at https://nodejs.org/en/docs/guides/, so they're not tied to a release. The old guides weren't on the website at all, they just sat in the source tree.
Either way is fine. Shouldn't be any problem to backport, but it shouldn't cause any problems if we don't. So let's say no. |
This commit removes the topics and guides that the documentation
working group has proposed added to the website. We want them to have
more visibility and believe that moving them to the website does that.
This depends on nodejs/nodejs.org#1105 landing.
/cc @nodejs/documentation
Checklist
Affected core subsystem(s)
doc