-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
Proposal to move guides to nodejs/nodejs.org #10792
Comments
I also think https://github.com/nodejs/node/blob/master/doc/topics/domain-postmortem.md should be moved to a documentation/Website guide, it includes important information on the limitations of Domains, and gives context to their deprecation. Thoughts? |
Thanks @sam-github. I updated the OP. |
Definitely in favor of this. Moving the guides out ought to give them greater visibility. +1 |
+1 for sure |
+1 |
Is the domains postmortem doc in a good enough format for publishing in the website? Its original intent was to simply record the collection of problems that we had with domains in a single place we could point to rather than trying to regurgitate it each time we were asked. |
That's exactly why its worth having on the website. I'm not about to claim an energetic editor couldn't improve it, but its perfectly readable, serves its purpose, and yet isn't in a place its easily discovered. We can wait until people post github issues, then close them and point into the nodejs/node doc/topics directory, but I suggest its better to just put it on the website and link to from the domains API page. |
Indeed, I would say it could use some editing, but I wouldn't want that to block this request. We could move it with the other docs and edit it after the transition, or we could leave it here and rewrite it in the website repo. I'm good with either, but I feel like keeping it in one location is probably best. |
Including the +1 votes from @evanlucas and @targos here with the 10 votes from the CTC meeting today, that's 12 CTC members in favor, which is a majority. Removing the |
This adds 4 guides from the nodejs/node repo to the guides section of the website. The documentation working group would like to make these guides more visible for end users. Ref: nodejs/node#10792
This adds 4 guides from the nodejs/node repo to the guides section of the website. The documentation working group would like to make these guides more visible for end users. Ref: nodejs/node#10792
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>
@nodejs/documentation would like to move all of the guides that are not directly related to contributing to core out of this repo and into the nodejs/nodejs.org repo. This is a tracking issue so we can bring it up at the next ctc-meeting.
This has come about in response to the latest docs wg discussion at nodejs/docs#119.
We propose that the following guides be moved:
The text was updated successfully, but these errors were encountered: