doc: make contributing info more discoverable by mhdawson · Pull Request #41408 · nodejs/node · GitHub

There are been several discussions in recent PRs about
the docs related to contributing not being very discoverable.
Move these docs from doc/guides/ to doc/contributing.

Signed-off-by: Michael Dawson mdawson@devrus.com

I think this is a step in the right direction although there may be other suggestions. If nothing else it can kickoff the bikeshedding.

If we move these we'll also need to update any links, e.g. in https://github.com/nodejs/node/blob/master/CONTRIBUTING.md

I think I forgot to check in updates I made to fix a number of the lint issue :(

pushed commit to fix linter errors.

Will fix up things like the code owners once I see if people like/dislike the proposal

@Trott since you are active on docs. Want to get some level of agreement before I look at fixing up all the links in files not being moved.

I think those will just be the set identified in the linter failures reported. I guess my local run does not report those since they are in files not being changed.

Adding to tsc agenda to get some feedback on if this is a reasonable approach or not.

@Trott since you are active on docs. Want to get some level of agreement before I look at fixing up all the links in files not being moved.

At a high level, yes, I believe this is a sensible approach.

+1 to this. Definitely think it's a good change!

In case anyone else was wondering, all docs from guides were moved to contributing (which makes sense IMO, since all docs there were related to contributing, maybe with the exception of build instructions).

@mhdawson I wouldn't be surprised if we have links in the org pointing to the coc file that was on doc/guides, worth double checking before landing.

I think this means that the TSC will be pinged for changes to any of the guides now.

Thanks, good idea

It was more of a comment/heads up. The previous directory structure and config only pinged TSC on a subset of documents.

If that becomes a problem I'm happy to change in later on.

There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com>

Signed-off-by: Michael Dawson <mdawson@devrus.com>

Rebased and squashed and also looks like @targos fixed all of the links outside the docs I modified. Thanks!

Rerunning the test-asan once that passes I think the fact the the rest of the github actions are green likely means that links have been fixed up as well and this should be good to land. I'll do that once test-asan passes in order to avoid future conflicts which will happen every time there is a change to one of the maintaining docs.

I

Well test-asan failed again. Moving docs is not going to affect that and re-running an hour +1 job just to get an action to pass that does not test the change in the PR does not sound useful.

Going to land.

See this now has changed in code as well as docs, kicking off ci.

CI: https://ci.nodejs.org/job/node-test-pull-request/41968/

CI: https://ci.nodejs.org/job/node-test-pull-request/41972/

Created 5 PRs to update links in other repos, will help to update others if we find ones that need to updated.

re #41408 (comment), cool URLs don't change - can files be added in guides that point to the new locations?

re #41408 (comment), cool URLs don't change - can files be added in guides that point to the new locations?

I don't quite follow, the URLs are changing, I was submitting PRs to update to the new location?

Right - i was referencing this core principle of the web which means that if a link moves, it's supposed to redirect, so that any link that's ever worked continues to work for eternity.

For in-repo docs this indeed may not always be practical, but for specific cases when a doc is known to be externally linked, it seems like a reasonable thing to do to me.

In this case the external links are in our own, or related repos so I think updating those thinks is probably the right thing to do versus keeing a redirect file forever.

There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #41408 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: James M Snell <jasnell@gmail.com>

Landed in a199387

* doc: fixup links to code-of-conduct.md Refs: nodejs/node#41408 The code-of-conduct.md file has been moved, update the related links. Signed-off-by: Michael Dawson <mdawson@devrus.com> * squash: remove package-lock.json change Signed-off-by: Michael Dawson <mdawson@devrus.com>

Refs: nodejs/node#41408 Signed-off-by: Michael Dawson <mdawson@devrus.com>

Refs: nodejs/node#41408 The code-of-conduct.md file has been moved, update the related links. Signed-off-by: Michael Dawson <mdawson@devrus.com>

* doc: update links to collaborator guide Refs: nodejs/node#41408 Signed-off-by: Michael Dawson <mdawson@devrus.com> * squash: fixup Signed-off-by: Michael Dawson <mdawson@devrus.com>

There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #41408 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: James M Snell <jasnell@gmail.com>

interesting and willing to learn more

doc/guides was moved to doc/contributing in nodejs/node#41408. Signed-off-by: Darshan Sen <raisinten@gmail.com>

There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #41408 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: James M Snell <jasnell@gmail.com>

Refs: nodejs/node#41408 The code-of-conduct.md file has been moved, update the related links. Signed-off-by: Michael Dawson <mdawson@devrus.com>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 5, 2022

mhdawson added the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Jan 7, 2022

mhdawson mentioned this pull request Jan 10, 2022

Node.js Technical Steering Committee (TSC) Meeting 2022-01-13 nodejs/TSC#1148

Closed

fhinkel approved these changes Jan 13, 2022

View reviewed changes

targos approved these changes Jan 13, 2022

View reviewed changes

DerekNonGeneric approved these changes Jan 14, 2022

View reviewed changes

mmarchini approved these changes Jan 14, 2022

View reviewed changes

targos reviewed Jan 14, 2022

View reviewed changes

doc: make contributing info more discoverable

fb9fbbb

There are been several discussions in recent PRs about the docs related to contributing not being very discoverable. Move these docs from doc/guides/ to doc/contributing. Signed-off-by: Michael Dawson <mdawson@devrus.com>

mhdawson force-pushed the move-doc branch from 9404235 to fb9fbbb Compare January 14, 2022 20:32

squash: fixup broken link

c25aa6a

Signed-off-by: Michael Dawson <mdawson@devrus.com>

mhdawson mentioned this pull request Jan 17, 2022

Node.js Technical Steering Committee (TSC) Meeting 2022-01-19 nodejs/TSC#1152

Closed

mhdawson removed the tsc-agenda Issues and PRs to discuss during the meetings of the TSC. label Jan 17, 2022

jasnell approved these changes Jan 17, 2022

View reviewed changes

mhdawson closed this Jan 18, 2022

mhdawson added a commit to mhdawson/nodejs.org that referenced this pull request Jan 18, 2022

doc: update links to collaborator guide

789b2a9

Refs: nodejs/node#41408 Signed-off-by: Michael Dawson <mdawson@devrus.com>

mhdawson mentioned this pull request Jan 18, 2022

doc: update links to collaborator guide nodejs/nodejs.org#4373

Merged

mhdawson added a commit to pkgjs/support that referenced this pull request Jan 18, 2022

doc: update link to code-of-conduct.md (#49 )

5545cce

Refs: nodejs/node#41408 The code-of-conduct.md file has been moved, update the related links. Signed-off-by: Michael Dawson <mdawson@devrus.com>

mhdawson added a commit to mhdawson/bootstrap that referenced this pull request Jan 18, 2022

doc: update link for Node.js CoC link

13934b6

Refs: nodejs/node#41408 The code-of-conduct.md file has been moved, update the related links. Signed-off-by: Michael Dawson <mdawson@devrus.com>

github-actions Bot mentioned this pull request Jan 19, 2022

CI Reliability 2022-01-19 nodejs/reliability#176

Open

13 tasks

This was referenced Jan 20, 2022

CI Reliability 2022-01-20 nodejs/reliability#177

Open

CI Reliability 2022-01-21 nodejs/reliability#178

Open

richardlau mentioned this pull request Feb 4, 2022

docs: update valgrind investigation nodejs/diagnostics#525

Merged

ruyadorno mentioned this pull request Feb 8, 2022

v17.5.0 release proposal #41897

Merged

RaisinTen added a commit to RaisinTen/TSC that referenced this pull request Feb 19, 2022

doc: fix core repo doc/guides links

b2ea143

doc/guides was moved to doc/contributing in nodejs/node#41408. Signed-off-by: Darshan Sen <raisinten@gmail.com>

RaisinTen mentioned this pull request Feb 19, 2022

doc: fix core repo doc/guides links nodejs/TSC#1171

Merged

targos pushed a commit to nodejs/TSC that referenced this pull request Feb 19, 2022

doc: fix core repo doc/guides links (#1171 )

24ca70c

doc/guides was moved to doc/contributing in nodejs/node#41408. Signed-off-by: Darshan Sen <raisinten@gmail.com>

danielleadams mentioned this pull request Mar 3, 2022

v16.14.1 release proposal #42200

Merged

doc: make contributing info more discoverable by mhdawson · Pull Request #41408 · nodejs/node · GitHub

Uh oh!

Uh oh!

doc: make contributing info more discoverable - #41408

doc: make contributing info more discoverable#41408mhdawson wants to merge 2 commits intonodejs:masternodejs/node:masterfrom mhdawson:move-docmhdawson/io.js:move-docCopy head branch name to clipboard

Conversation

mhdawson commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 5, 2022

Uh oh!

richardlau commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 5, 2022

Uh oh!

mhdawson commented Jan 7, 2022

Uh oh!

Trott commented Jan 8, 2022

Uh oh!

jasnell commented Jan 10, 2022

Uh oh!

mmarchini commented Jan 14, 2022

Uh oh!

targos Jan 14, 2022

Choose a reason for hiding this comment

Uh oh!

mhdawson Jan 14, 2022

Choose a reason for hiding this comment

Uh oh!

targos Jan 16, 2022

Choose a reason for hiding this comment

Uh oh!

mhdawson Jan 17, 2022

Choose a reason for hiding this comment

Uh oh!

mhdawson commented Jan 14, 2022

Uh oh!

mhdawson commented Jan 17, 2022

Uh oh!

mhdawson commented Jan 17, 2022

Uh oh!

mhdawson commented Jan 17, 2022

Uh oh!

nodejs-github-bot commented Jan 17, 2022

Uh oh!

nodejs-github-bot commented Jan 17, 2022

Uh oh!

mhdawson commented Jan 18, 2022

Uh oh!

ljharb commented Jan 18, 2022

Uh oh!

mhdawson commented Jan 18, 2022

Uh oh!

ljharb commented Jan 18, 2022

Uh oh!

mhdawson commented Jan 18, 2022

Uh oh!

mhdawson commented Jan 18, 2022

Uh oh!

PETERO2022 commented Feb 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

doc: make contributing info more discoverable#41408
mhdawson wants to merge 2 commits into
nodejs:masterfrom
mhdawson:move-doc