doc: add section for strategic initiatives#17104
doc: add section for strategic initiatives#17104mhdawson wants to merge 1 commit intonodejs:masterfrom
Conversation
vsemozhetbyt
left a comment
vsemozhetbyt
left a comment
There was a problem hiding this comment.
A nit: Table of Contents may need updating with this part.
|
Looking at the table of contents it does not seem to cover a few of the sections lower down so a larger update may make sense, but may make sense to do it seperately. |
Trott
left a comment
Trott
left a comment
There was a problem hiding this comment.
Is this necessary? If so, does it need to live in README? I'd really like to avoid adding unnecessary material to the README. Might be better in the COLLABORATOR_GUIDE or as a separate document altogether or even in the GOVERNANCE doc.
README.md
Outdated
There was a problem hiding this comment.
I'd recommend removing this entire paragraph. The first sentence is equivalent to "Strategic Intiaitves are a thing that exist" but doesn't tell you anything about what they are. The second sentence is a bit better, mentioning champions, but IMO that's non-essential information for the README. Maybe we can just include a link to the Strategic Initiatives somewhere in the doc where links to other important docs are and call it good.
There was a problem hiding this comment.
@Trott it already exists in the TSC repo. I opened this PR as the discussion in the original PR suggested it might make sense to have it in the core README.md for visibility. I don't really have a strong feeling one way or the other ...
There was a problem hiding this comment.
@MylesBorins what do you think as you suggested I add it here (I think)
|
I actually agree with @Trott that this is not really necessary in the README. Moving it to the COLLABORATOR_GUIDE seems better. |
|
Ping @mhdawson |
|
I'm happy to move the collaborate guide instead. Will update PR this week to do athat. |
mhdawson
force-pushed
the
strat-init
branch
2 times, most recently
from
a78d9e3 to
4b8464c
Compare
|
I looked at moving to the Collaborator guide but did not find a good fit. I then looked at the README.md to see how we ref working groups and have updated to reference the strategic initiatives in what I think is a way that fits ok with the README.md doc. @Trott can you take a look. |
|
I'm less opposed to it this way and there, but it still seems shoe-horned and unnecessary to me. |
|
(Basically, if something is "nice to have" in the README but not necessary, it should be omitted.) |
Trott
dismissed
their stale review
Still dislike it, but not enough to block it.
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility.
|
One more time for the CI: https://ci.nodejs.org/job/node-test-pull-request/12945/ |
|
Landed as 46b02c1 |
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: #17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add reference to strategic initiatives on core README.md in order to ensure broarder visibility. PR-URL: nodejs#17104 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
7 participants
Add reference to strategic initiatives on core README.md
in order to ensure broarder visibility.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc