Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: add section for strategic initiatives #17104

Closed
wants to merge 1 commit into from
Closed

doc: add section for strategic initiatives #17104

wants to merge 1 commit into from

Conversation

mhdawson
Copy link
Member

Add reference to strategic initiatives on core README.md
in order to ensure broarder visibility.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 17, 2017
vsemozhetbyt
vsemozhetbyt approved these changes Nov 17, 2017
View reviewed changes
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A nit: Table of Contents may need updating with this part.

@mhdawson
Copy link
Member Author

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
Trott reviewed Nov 17, 2017
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Trott
Trott previously requested changes Nov 17, 2017
View reviewed changes
README.md Outdated

### Strategic Initiatives

At any one time the Node.js project has a number of strategic initiatives
Copy link
Member

@Trott Trott Nov 17, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 ...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MylesBorins what do you think as you suggested I add it here (I think)

@BridgeAR
Copy link
Member

I actually agree with @Trott that this is not really necessary in the README. Moving it to the COLLABORATOR_GUIDE seems better.

@BridgeAR
Copy link
Member

Ping @mhdawson

@mhdawson
Copy link
Member Author

I'm happy to move the collaborate guide instead. Will update PR this week to do athat.

@mhdawson mhdawson force-pushed the strat-init branch 2 times, most recently from a78d9e3 to 4b8464c Compare February 2, 2018 15:25
@mhdawson
Copy link
Member Author

mhdawson commented Feb 2, 2018

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.

@Trott
Copy link
Member

Trott commented Feb 2, 2018

I'm less opposed to it this way and there, but it still seems shoe-horned and unnecessary to me.

@Trott
Copy link
Member

Trott commented Feb 2, 2018

(Basically, if something is "nice to have" in the README but not necessary, it should be omitted.)

@Trott Trott dismissed their stale review February 2, 2018 20:54

Still dislike it, but not enough to block it.

@mhdawson
Copy link
Member Author

mhdawson commented Feb 5, 2018

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

@mhdawson
doc: add section for strategic initiatives
40d1130 
Add reference to strategic initiatives on core README.md
in order to ensure broarder visibility.
@mhdawson
Copy link
Member Author

mhdawson commented Feb 5, 2018

One more time for the CI: https://ci.nodejs.org/job/node-test-pull-request/12945/

@mhdawson
Copy link
Member Author

mhdawson commented Feb 5, 2018

A few failures in CI, but none that could be related to this PR. Opened #18585 for the alpine failure.
and #18587 for failure in sharedlibs docker testing. These rest I believe already had issues tagging them.

Going to land.

@mhdawson
Copy link
Member Author

mhdawson commented Feb 5, 2018

Landed as 46b02c1

@mhdawson mhdawson closed this Feb 5, 2018
mhdawson added a commit that referenced this pull request Feb 5, 2018
@mhdawson
doc: add section for strategic initiatives
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>
MylesBorins pushed a commit that referenced this pull request Feb 21, 2018
@mhdawson @MylesBorins
doc: add section for strategic initiatives
04e76b8 
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>
MylesBorins pushed a commit that referenced this pull request Feb 21, 2018
@mhdawson @MylesBorins
doc: add section for strategic initiatives
7b1a9b2 
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>
MylesBorins pushed a commit that referenced this pull request Feb 21, 2018
@mhdawson @MylesBorins
doc: add section for strategic initiatives
6256d70 
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>
@MylesBorins MylesBorins mentioned this pull request Feb 21, 2018
Merged
gibfahn pushed a commit that referenced this pull request Apr 13, 2018
@mhdawson @gibfahn
doc: add section for strategic initiatives
dc6dc82 
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>
gibfahn pushed a commit that referenced this pull request Apr 13, 2018
@mhdawson @gibfahn
doc: add section for strategic initiatives
73adadd 
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>
@MylesBorins MylesBorins mentioned this pull request Apr 13, 2018
Merged
@MylesBorins MylesBorins mentioned this pull request May 2, 2018
Merged
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@mhdawson @MayaLekova
doc: add section for strategic initiatives
d83bfe5 
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>
@mhdawson mhdawson deleted the strat-init branch September 30, 2019 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott left review comments

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@mhdawson @BridgeAR @Trott @jasnell @vsemozhetbyt @gibfahn @nodejs-github-bot