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.

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

outdated governance information #758

Closed
Trott opened this issue May 22, 2016 · 8 comments
Closed

outdated governance information #758

Trott opened this issue May 22, 2016 · 8 comments
Labels
content Issues/pr concerning content

Comments

@Trott
Copy link
Member

Trott commented May 22, 2016

The information in https://github.com/nodejs/nodejs.org/blob/master/locale/en/get-involved/development.md is out of date. Primarily, it mentions the TSC many times but there is no mention of the CTC. It seems like it duplicates info in the nodejs/node repo. I wonder if it should be much shorter and link out to the .md files in that repo so as to not have the issue of needing to stay in sync with it?

@fhemberger
Copy link
Contributor

You are right, it's too long and too complicated. Nobody is going to read that entire page before submitting something for the first time. Having a shorter version (or linking to CONTRIBUTING.md in nodejs/node) would be a great idea.

IIRC part of the texts still date back to the old Node.js website and were extended with new content. So maybe a general review would make sense as well.

@williamkapke
Copy link
Member

I also agree. The information on that page is important, but too granular. For anything in these areas on the website, I think things should stay pretty high level.

Because the website is the entry point for the general public, I like to think to myself "If a typical journalist were to see this page, would they be able to understand of the majority of the content?"

@fhemberger fhemberger added the content Issues/pr concerning content label Dec 16, 2016
@fhemberger
Copy link
Contributor

/cc @nodejs/tsc @nodejs/community-committee Could you please have a look on how we could simplify this?

@Trott
Copy link
Member Author

Trott commented Dec 19, 2017

@fhemberger On the principle of not having more than one place to manage information, perhaps that section could be replaced with a sentence that links to https://github.com/nodejs/node/blob/master/GOVERNANCE.md#collaborators. That doc is kept up-to-date. It would also help make that far-too-long (IMO) web page a little shorter.

@Trott
Copy link
Member Author

Trott commented Dec 19, 2017

I think the section labeled "A Few Open Questions" should also be removed. In fact, that should be so uncontroversial that I'll open a PR to do that right now....

@ghost ghost closed this as completed Dec 19, 2017
@ghost ghost reopened this Dec 19, 2017
@Trott
Copy link
Member Author

Trott commented Dec 19, 2017

(By the way, now my original comment above from May 2016 is out of date--there is no CTC anymore, so lots of TSC mentions probably makes sense again. Another argument for directing people to the GOVERNANCE.md doc in the repo rather than trying to duplicate the information on the website.)

@fhemberger
Copy link
Contributor

@Trott So what part of the page should be replaced with the link? Only the "Collaborators" section or the entire thing?

Personally I'd love to get rid of the entire page (this is way too much badly structured information, no one will read it anyway). First step would be replacing it with a link. But in the future, I'd love to pull the page's content directly from the repo during build. The website should IMHO still be the first entry point for answering general questions, not just a proxy for a bunch of GitHub links (we had the same issue already somewhere else).

@Trott
Copy link
Member Author

Trott commented Dec 26, 2017

@fhemberger I agree the page can be removed entirely. Not sure how many links there are to it, but those links can be replaced with links to CONTRIBUTING.md or GOVERNANCE.md or something else (depending on their context).

fhemberger added a commit that referenced this issue Dec 28, 2017
Te content of the 'development' page was outdated and written in a way too long
and complex manner. Currently, there are two documents, explaining the
overall governance and contribution process in detail:

- https://github.com/nodejs/node/blob/master/GOVERNANCE.md
- https://github.com/nodejs/node/blob/master/CONTRIBUTING.md

Both documents go into a level of detail that IMHO aren't suitable for a general
"get involved" text like on the website, so the following sections were added:

- Where to get general help (linking Node.js help repository)
- Code contribution guidelines (CONTRIBUTING.md#pull-requests)
- What are 'Collaborators', who appoints them and how can I become one

Other changes:

- Removes menu item from all translations
- Fix links and minor layout issues in 'get-involved/index' (ca, en, es, uk)
- Remove note about last Fall's collab summit's Code + Learn (en)

Fixes: #758
@fhemberger fhemberger added the pr label Dec 28, 2017
fhemberger added a commit that referenced this issue Dec 28, 2017
* Remove outdated 'get-involved/development' page

Te content of the 'development' page was outdated and written in a way too long
and complex manner. Currently, there are two documents, explaining the
overall governance and contribution process in detail:

- https://github.com/nodejs/node/blob/master/GOVERNANCE.md
- https://github.com/nodejs/node/blob/master/CONTRIBUTING.md

Both documents go into a level of detail that IMHO aren't suitable for a general
"get involved" text like on the website, so the following sections were added:

- Where to get general help (linking Node.js help repository)
- Code contribution guidelines (CONTRIBUTING.md#pull-requests)
- What are 'Collaborators', who appoints them and how can I become one

Other changes:

- Removes menu item from all translations
- Fix links and minor layout issues in 'get-involved/index' (ca, en, es, uk)
- Remove note about last Fall's collab summit's Code + Learn (en)

Fixes: #758

* Remove 'get-involved/development.md' page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues/pr concerning content
Projects
None yet
Development

No branches or pull requests

3 participants