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
88 changes: 62 additions & 26 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 @@ -24,39 +24,75 @@ We are looking for posts that inform, teach, experiment, and generally enrich ou

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](https://trello.com/b/M9VUQl9S/nodejs-collection)
bnb marked this conversation as resolved.
Show resolved Hide resolved
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

### 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.
- 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 Foundation Medium 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).
- 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.
- 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 Foundation Medium posts should be no longer than 1,000 words and no shorter than 300 words.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved
- 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 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 ProjectPR team will review your submission in a timely manner and provide the green light to draft the entire article or provide feedback or direction.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved
- 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 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.

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

## 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.
- Writers submit an abstract via email at medium@nodejs.org.

- Editors have one week to provide approval or feedback - this is done internally on the alias and not to be shared with the writer until a final decision and suggested changes are reached as a group.

- If the abstract is approved, the writer will be informed and a task will be created on the [Trello board](https://trello.com/b/M9VUQl9S/nodejs-collection) for the post
bnb marked this conversation as resolved.
Show resolved Hide resolved

- The contributor will be made a “Writer” on the Node.js Collection medium account.

- The contributor will write the first draft and Write will submit this draft on Medium and an editor or two will be assigned to review. The contributor will ping the medium alias to alert the editors a draft has been submitted. Clear directions on how to submit will be provided to the contributor.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

- Editor from the Node.js Collection will review the post and provide the writer comments or feedback. This process can take up to a month to complete.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

- The writer to approve all content and send a note to medium@nodejs.org once finished.

- Once the piece is complete, and the writer approves the content, an editor from Node.js PR team to review one final time and accept into publication.

- Once the submission has been approved, it will be added to the Node.js Collection Medium publication - a publication date will be provided for proper social planning/ promo.
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

- The writer will be informed about the approval and publication date.

## Review Process for Existing Created Medium Posts (to be republished with permission on the Node.js Collection)

- Members from the evangelism working group are invited to become editors on Medium. If interested, contact here: medium@nodejs.org
WaleedAshraf marked this conversation as resolved.
Show resolved Hide resolved

- Editors are allowed to request to put already available public content on the Node.js Foundation Medium publication if they follow the above guidelines pertaining to “Quality” and “Guidelines/General Tips of Submissions”.

- A writer can send an existing article for consideration to the medium alias.

- The editors decide if the content is acceptable for publication.

- If accepted, a task will be created in the [Trello board](https://trello.com/b/M9VUQl9S/nodejs-collection) and an editor will be assigned to review the content.
bnb marked this conversation as resolved.
Show resolved Hide resolved

- The writer will be alerted of these edits and suggestions; the author of the post has the final sign off on content and can approve/accept all edits.

- If the author feels comfortable, the post should come with a list of those who helped edit the content.

- The review process could take up to a month depending on the number of edits and revisions involved.

- The review process and edits needed will happen on Medium with few exceptions.

- Once approved, the content will be published to Nodejs Collection.

## About This Team
The Node.js Collection Team is overseen by the [Node.js Community Committee](https://github.com/nodejs/community-committee).
The Node.js Collection Team is overseen by the [Node.js Community Committee](https://github.com/nodejs/community-committee).