Skip to content

doc: document process for sharing project news #47189

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

Closed
mhdawson wants to merge 10 commits into from
Closed

doc: document process for sharing project news #47189

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d6bd72c
doc: document process for sharing project news
mhdawson Mar 21, 2023
293b0d3
Update doc/contributing/sharing-project-news.md
mhdawson Mar 22, 2023
369cf1a
Update doc/contributing/sharing-project-news.md
mhdawson Mar 22, 2023
e1acbd0
Update doc/contributing/sharing-project-news.md
mhdawson Mar 22, 2023
d452967
Update doc/contributing/sharing-project-news.md
mhdawson Mar 22, 2023
64175e1
Update doc/contributing/sharing-project-news.md
mhdawson Mar 22, 2023
d75eaea
address comments
mhdawson Mar 22, 2023
dc0db2c
Update doc/contributing/sharing-project-news.md
mhdawson Mar 24, 2023
5014723
Update doc/contributing/sharing-project-news.md
mhdawson Mar 24, 2023
0ff4e46
squash: address comments
mhdawson Mar 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions doc/contributing/sharing-project-news.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Sharing project news

The project aims to make it easy
to share project news with those who publish newsletters
that cover Node.js.

The project's approach is as follows:

* The project will create one "What's new in YYYY" discussion item in
the `nodejs/node` repo for news related to Node.js core.
Copy link
Member

@mcollina mcollina Mar 28, 2023

Choose a reason for hiding this comment

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

I think it might be better to use a separate repo for these news. In this way, publications could subscribe to the notifications on that repository to receive the updates.

Copy link
Member Author

@mhdawson mhdawson Mar 28, 2023

Choose a reason for hiding this comment

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

That could make it easier for publications but the goal is to make it easy for the teams and the project both in terms of workflow and discoverability. In the case of the node-api team looking for an issue in a different repo would be more work due to the way we use a milestone to review work each week.

Even if there was a separate repo the ask was not that a new issue be created for each piece of news, only update an existing issue/discussion so once the publication subscribes to an issue I don't think it will be any different in respect to notifications.

Therefore I think using an issue/discussion item in the existing repos is better.

Copy link
Member

@mcollina mcollina Mar 28, 2023

Choose a reason for hiding this comment

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

ok!!

* Teams/groups can create a "what's new in YYYY" issue or discussion item
in one or more of their repositories. As an example see
[What's new in the Node-API and node-addon-api world? - 2023 version](https://github.com/nodejs/abi-stable-node/issues/446).
* Collaborators periodically add news as additional comments on these
issues throughout the year.
* At the end of each year the issue is closed and if appropriate a
new one is created.
* A list of these documents is maintained in the section below as a
quick way to find them.
* The next-10 team reaches out to teams/groups on an ad hoc basis
to ensure teams know about the option for sharing news.
* The next-10 team reaches out to those who publish newsletters ad hoc
to let them know about this approach and how they can find the updates.

We trust/expect collaborators to post project related news versus news
that promotes a specific company or commercial interest.

## Teams doing updates

* [node-api/node-addon-api](https://github.com/nodejs/abi-stable-node/issues/446).