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

doc: Better links for all WGs + sp edits #1113

Closed
wants to merge 4 commits into from
Closed

doc: Better links for all WGs + sp edits #1113

wants to merge 4 commits into from

Conversation

blakmatrix
Copy link
Contributor

Addresses nodejs/evangelism#24

Not all links are in place as some WG are still working on CONTRIBUTING.md and GOVERNANCE.md but should soon be setup

Addresses nodejs/evangelism#24

Not all links are in place as some WG are still working on `CONTRIBUTING.md` and `GOVERNANCE.md` but should soon be setup
@blakmatrix blakmatrix changed the title Better linking/gitter for WGs/sp doc: Better linking/gitter for WGs/sp Mar 10, 2015
@Fishrock123
Copy link
Contributor

Note: we don't actually use gitter. It should probably be removed.

@Fishrock123 Fishrock123 added the doc Issues and PRs related to the documentations. label Mar 10, 2015
@blakmatrix
Copy link
Contributor Author

@Fishrock123 Fixed that, I'll admit, I was a bit over zealous in adding them in hopes that it would encourage more contributors to the various WG for visibility and such.

@Fishrock123
Copy link
Contributor

Do the localization groups use gitter? I'm not sure. None of the core groups do afaik, unless evangelism does.

There was length discussions on the website repo about which way we should go forward with gitter, and we figured it was actually best to stick to irc and keep everything together.

@julianduque
Copy link
Contributor

@Fishrock123 we (@iojs/iojs-es) use gitter (https://gitter.im/iojs/iojs-es) but i've heard of other groups using Slack and others IRC so there is no official communication channel for localization groups

@Fishrock123
Copy link
Contributor

Fair enough. Let's just remove chat links from the localization groups. If they advertise it on their repo's it is probably best and easiest. :)

@blakmatrix
Copy link
Contributor Author

@Fishrock123 All of the ones listed exist in gitter, meaning someone had created them after the repos were created.

@Fishrock123
Copy link
Contributor

I'm not concerned with what exists. We should probably list what the collaborators use. :)

@blakmatrix
Copy link
Contributor Author

@Fishrock123 @bnb @julianduque Good point, actually most of them are in use, It would be beneficial to list gitter/webIRC/whatever in this document, OR _somewhere else consolidated_ where we have a listing of all of the WGs and quick useful links for more visibility and hopefully more help into the individual WGs.

That being said, the iojs-XX i18n repos in this document have been rather glossed over--with the goal of getting more contributors and promoting the open governance model, it would help to provide what it is(ie. vietnamese, norsk, spanish) a link to what the collaborators use and issues at minimum (the elephant in the room being the assumption that a link to the repo is enough to achieve this for the i18n repos), if not also the contrib, governance, members links.

@stringparser
Copy link

@blakmatrix, @kosamari has a document here that might be useful for this

@blakmatrix
Copy link
Contributor Author

@stringparser @kosamari Thanks!

@blakmatrix blakmatrix changed the title doc: Better linking/gitter for WGs/sp doc: Better links for all WGs + sp edits Mar 12, 2015
@stringparser
Copy link

@blakmatrix welcome! @kosamari has all the merit though ;)

@dotproto
Copy link

@blakmatrix Quick note regarding Gitter chat rooms. They're automatically created as soon as a repo contributor visits (or some similar condition is met). The existence of a room is also less meaningful because there isn't an easy way to delete them.

@blakmatrix
Copy link
Contributor Author

@SVincent Yeah, I removed all the ones that weren't listed on the individual repos, all the i18n links come straight from the repo docs, plus I found a couple medium weekly's and twitters on a few that hadn't made it into the ReadMes. I made sure I wasn't just listing them because they existed after @Fishrock123 's comment. :) I hope there is a way we can list this doc on the site somehow, I think It'll be really useful for getting folks interested in the WG and their efforts.

@snostorm
Copy link

I'd like us to try to try and cross-publish some of this stuff. Website wise it might work well to start with this list a "single page" article but, eventually, I'd like to see every (interested) WG have a landing page on the site.

nodejs/iojs.org#73 (comment)

Edit: I just imported the Markdown, as is, and it works pretty well inside the website. I'm contemplating syncing a few files like this from the various io.js groups this way in a semi-automated way. ... Or, we could make a website-specific variations and manage two variations of similar data. See nodejs/iojs.org#287 for "automatic syncing" of the external markdown content from GitHub.

@blakmatrix
Copy link
Contributor Author

@snostorm I think that's a good direction to strive for.

Honestly though, many of these WG only have one or a few people right now doing the work of translating, we can't assume what they know and know how to do, ie. if they know how to make a landing page or have the bandwidth for it, I mean one thing we often forget is how hard it is to understand git/github or any revision control system for that matter. We just don't know what we don't know about other groups and people.

We do know that io.js evangelism and the WG let "the world know how awesome io.js is and how to get involved." -- That's the goal of evangelism, while not necessarily the goal of each WG, as they may work on its own evangelism efforts or not, whether interest is involved or not, is something the individual WGs need to decide. As such we need to consider the open governance model and how best to accommodate.

The WG's may ultimately decide to host on a different domain separate from the iojs.org site, publish content on a different site (ex: http://blog.iojs.jp/), but from the end users perspective we need some kind of structure, and it makes the most sense to me that that lies in the realm of evangelisms WG as one of its purpose is to get users to know of and how to contribute to the other WGs.

It'd follow that if and when individual WGs may want to take on their own efforts for which evangelism serves, that they would then get involved in the evangelism WG serving their interests, it's also possible that they may just go their own way, it's up to them really, that's open governance.

@blakmatrix
Copy link
Contributor Author

This thread for a PR feels like it's getting a bit off topic... lets try and reign this in.

@mikeal
Copy link
Contributor

mikeal commented Mar 15, 2015

We should only point to each WG's primary GitHub repo. The README in each repo should contain information about the WG, the list of members, and how to best get involved. If they are using gitter, IRC, or carrier pidgeons the instructions on how to participate will be in the README.

@blakmatrix
Copy link
Contributor Author

@mikeal This is where it becomes difficult in the OG model, they are allowed to do whatever they see fit, right, "should contain information" simply becomes something someone else has impressed on their WG that they may or may not agree with.

The idea that relevant info will be in the README is a gross assumption on how their WG should work.

Perhaps we should only list links to what we assume is the WG primary repo. At least it's the effort of the larger WG to help trickle down what is assumed to be the right information, unfortunately that makes it somewhat harder for interested parties to discover the info they are looking for, I mean what we are looking at is an extra 1-4 more clicks anyways (or a click and no info at all), but easier maintenance in the long run.

@mikeal
Copy link
Contributor

mikeal commented Mar 15, 2015

@blakmatrix if there isn't a README, or the README contains little information, the best way to get them to care about making it relevant is to link to it :)

@snostorm
Copy link

from the end users perspective we need some kind of structure, and it makes the most sense to me that that lies in the realm of evangelisms WG as one of its purpose is to get users to know of and how to contribute to the other WGs.

Exactly why I'd love to pull content like this in to iojs.org itself (as well). Discovery :)

@silverwind
Copy link
Contributor

LGTM

@blakmatrix please squash the commits and add a small summary in the commit message.
@mikeal could you LGTM as well?

@Fishrock123
Copy link
Contributor

LGTM

@silverwind
Copy link
Contributor

Going to squash and merge this soon unless further objections are made. I think stuff like this shouldn't linger this long :)

Fishrock123 pushed a commit that referenced this pull request Mar 30, 2015
Related to nodejs/evangelism#24

PR-URL: #1113
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Mikeal Rogers <mikeal.rogers@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
@Fishrock123
Copy link
Contributor

Thanks, landed in 73de135 with a fixup to add spaces between the english language name and the language name in parenthesis.

@rvagg rvagg mentioned this pull request Mar 31, 2015
@pesho pesho mentioned this pull request Apr 1, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants