Skip to content
This repository has been archived by the owner on Aug 3, 2022. It is now read-only.

Update readme with new process #37

Closed
wants to merge 10 commits into from
78 changes: 48 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# The Node.js Collection Team
A place for [the Node.js Collection](https://medium.com/the-node-js-collection) to organize the technical editing process for articles submitted to the publication.

## Purpose of Node.js Foundation Medium publication
The Node.js Foundation’s new [Medium](https://medium.com/) publication serves as a channel for the community to broadcast to a wide audience its views related to Node.js and its ecosystem. This may include:
## Purpose of Node.js Collection publication
The Node.js Collection is a [Medium](https://medium.com/) publication which serves as a channel for the community to broadcast to a wide audience its views related to Node.js and its ecosystem. This may include:

- Summaries of incubated projects or technical decisions made
- Working project initiatives
Expand All @@ -11,6 +11,23 @@ The Node.js Foundation’s new [Medium](https://medium.com/) publication serves
- Reports on Node.js and JavaScript events (these events must have a code of conduct to be considered)
- Other topics will certainly be considered, but it should be something of interest to the Node.js community

## Editors
We have list of people who review the post before publishing. If the post is specific to some technical topic, we seek review from someone who has knowledge of that domain.

### How to become an editor?
We are looking for more reviewers. If you are interested, please open an issue in [nodejs-collection repo](https://github.com/nodejs/nodejs-collection/issues) with your details and the team will review it.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

### Benefits of being an editor
- Your name will be added in the [current editors list](https://github.com/nodejs/nodejs-collection#current-editors).
- You'll be added to [editors list on Medium](https://medium.com/the-node-js-collection/about).
- You'll receive discount to attend OpenJS Foundation Conference.


### Current Editors
* [bnb] - **Tierney Cyren** <hello@bnb.im>
* [rromoff] - **Rachel Romoff**
* [waleedashraf] - **Waleed Ashraf** <waleedashrafhere@gmail.com> **Node.js Collection Champion**

## Quality
We are looking for posts that inform, teach, experiment, and generally enrich our community. There's no hard and fast rule of what an article should or feel like; Node.js Collection articles should be as diverse as the community itself. Ideally, contributions should encourage readers to explore new ideas, dig deeper into old ones, and to inspire readers to experiment and tinker. Articles can cover any number of topics such as:

Expand All @@ -20,43 +37,44 @@ We are looking for posts that inform, teach, experiment, and generally enrich ou
- Best Practices (How To)
- Embedded/IoT
- AI/Mobile
- More (Essentially news from the Foundation and potentially more editorial style content about the future of Node.js Core) - see Google Cloud Platform’s More section as an example [here](https://cloudplatform.googleblog.com).
- More (Essentially news from the project and potentially more editorial style content about the future of Node.js Core) - see Google Cloud Platform’s More section as an example [here](https://cloudplatform.googleblog.com).

If you're passionate about something not listed above, please don't hesitate to submit your idea for consideration.

## Resources
* [Trello Board](https://trello.com/b/M9VUQl9S/nodejs-collection)

### Key Roles:
- **Contributor/Writer** : Person submitting article or idea for inclusion on the Node.js Collection
- **Editor** : Technical Reviewer. Person who ensures the content's technical integrity.

## Guidelines/General Tips of Submissions

- Posts from members and community members must be vendor neutral, though they may mention vendors involved in specific project deployments if this serves the purpose of educating readers.
- Posts about hosting of an in-person event or speaking at an event, or other indications of meaningful participation in the community, are allowed, but again shouldn’t feel like an advertisement for your services or company.
- Your post must be your original content, but can be published on the Node.js Foundation Medium publication, if you received permission from the editors of the website to do so.
- Posts from members and community members must be vendor-neutral, though they may mention vendors involved in specific project deployments if this serves the purpose of educating readers.
- Posts about hosting of an in-person event or speaking at an event, or other indications of meaningful participation in the community, are allowed, but again shouldn’t feel like an advertisement for your services or company.
bnb marked this conversation as resolved.
Show resolved Hide resolved
- Your post must be your original content, but can be published on the Node.js Collection publication, if you received permission from the editors of the website to do so.
- All content should have a byline (preferably by a company engineer) and be published with Creative Commons with Attribution, so you’re welcome to republish on your blog.
- The most interesting posts are ones that teach or explain how to do something in a way maybe others haven’t thought of. Good blog posts show hurdles that were encountered and explain how they were overcome (not that everything is rainbows and unicorns).
- A few posts that have performed well on the Node.js Foundation Medium page include Walmart Strives to be an Online Retailer with Node.js (use case); Node.js Transitions to LTS (news); The Progress of Node.js Post io.js and Node.js merger (progress update).
- When showing upstreaming of a patch fixing an issue for others, link back to the Github issue so readers can follow along.
- We don’t avoid critical commentary or broad issues, but approach them with sensitivity, professionalism and tact in a way that is beneficial and positive for the community.
- Node.js Foundation Medium posts should be no longer than 1,000 words and no shorter than 300 words.

Diagrams or photos are strongly encouraged.
- The most interesting posts are ones that teach or explain how to do something in a way maybe others haven’t thought of. Good blog posts show hurdles that were encountered and explain how they were overcome (not that everything is rainbows and unicorns).
- A few posts that have performed well on the Node.js Collection Medium page include Walmart Strives to be an Online Retailer with Node.js (use case); Node.js Transitions to LTS (news); The Progress of Node.js Post io.js and Node.js merger (progress update).
- When showing upstreaming of a patch fixing an issue for others, link back to the Github issue so readers can follow along.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved
- We don’t avoid critical commentary or broad issues but approach them with sensitivity, professionalism, and tact in a way that is beneficial and positive for the community.
- Node.js Collection Medium posts should be no longer than 1,000 words and no shorter than 300 words.
- Diagrams or photos are strongly encouraged.

## How to submit for consideration

- Please submit a brief summary and the topic of the post to `medium@nodejs.org` for consideration.
- Members of the Node.js Collection Technical Review Team and Node.js Foundation PR team will review your submission in a timely manner and provide the green light to draft the entire article or provide feedback or direction.
- If you are submitting an article or presentation that already exists, please send it in its entirety with a note on the expressed permission to publish from the owner of content.
- Once your submission has been approved, it will be added to the Node.js Foundation Medium publication publishing calendar and a publish date will be provided, so you may plan to promote accordingly through your personal and company’s social media channels.
- Please create a Google Doc with a brief summary and the topic of the post.
- Send the Google Doc to `medium@nodejs.org` for consideration.
- Members of the Node.js Collection Technical Review Team and OpenJS Foundation PR team will review your submission in a timely manner and provide the green light to draft the entire article or provide feedback or direction.
- A task will be created in [Trello Board](https://trello.com/b/M9VUQl9S/nodejs-collection) with current status of the submission.
- If you are submitting an article or presentation that already exists, please send it in its entirety with a note on the expressed permission to publish from the owner of the content.
- Once your submission has been approved, it will be added to the Node.js Collection Medium publication publishing calendar and a publish date will be provided, so you may plan to promote accordingly through your personal and company’s social media channels.

## Review Process for Original Posts
- The review team will provide comments and edits.
- Once the review team has made suggested edits, they will share all suggested edits with the author who has final sign off on content.
- If the author feels comfortable, we would also like to list out the names of the technical editors of the post.
- The review team will share all suggested edits with the author, who has final sign off on content.
- Zibby Keaton will then post to the Node.js Foundation Medium publication.
- The review process may take between two to three weeks depending on the number of edits and revisions involved.
## About This Team
The Node.js Collection Team is overseen by the [Node.js Community Committee](https://github.com/nodejs/community-committee).

## Review Process for Created Medium Posts
- Members from the evangelism working group are invited to become editors on Medium. If interested, contact Zibby Keaton here: zkeaton@linuxfoundation.org.
- Editors are allowed to request to put already available public content on the Node.js Foundation Medium publication if they follow the above guidelines.
- If you are interested in becoming a technical editor, please file an issue.

## About This Team
The Node.js Collection Team is overseen by the [Node.js Community Committee](https://github.com/nodejs/community-committee).
<!-- Source for Markdown links included in this document -->
[bnb]: https://github.com/bnb
[rromoff]: https://github.com/RRomoff
[waleedashraf]: https://github.com/waleedashraf