doc: make contributing info more discoverable #41408
Conversation
|
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. |
mhdawson
added
the
tsc-agenda
|
Adding to tsc agenda to get some feedback on if this is a reasonable approach or not. |
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 @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. |
| /doc/guides/contributing/*.md @nodejs/tsc | ||
| /doc/guides/collaborator-guide.md @nodejs/tsc | ||
| /doc/guides/offboarding.md @nodejs/tsc | ||
| /doc/contributing/*.md @nodejs/tsc |
There was a problem hiding this comment.
I think this means that the TSC will be pinged for changes to any of the guides now.
There was a problem hiding this comment.
It was more of a comment/heads up. The previous directory structure and config only pinged TSC on a subset of documents.
There was a problem hiding this comment.
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! |
mhdawson
removed
the
tsc-agenda
|
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. |
|
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 |
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>
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>
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>
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: nodejs#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>
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>
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>
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