Link to WinterCG Runtime Keys in export conditions docs #48408

jcbhmr · 2023-06-10T06:22:18Z

This PR would...

Add a link to https://runtime-keys.proposal.wintercg.org/ in the export conditions section
Remove "deno" condition from Node.js docs
Remove "react-native" condition?
Keep "types" condition?
Add a "user would expect it to be in Node.js core docs" criteria to add more conditions to the list

cc @guybedford
follow up of #48407

nodejs-github-bot · 2023-06-10T06:22:22Z

Review requested:

@nodejs/loaders
@nodejs/modules

doc/api/packages.md

guybedford

Thanks for working this through

doc/api/packages.md

anonrig

I feel like we should wait for the proposal to be finalized before merging this.

guybedford · 2023-06-10T18:38:15Z

@Ethan-Arrowood would be great to have your review on this one.

doc/api/packages.md

Ethan-Arrowood

LGTM - fwiw WinterCG is a W3C Community Group. We can't actually "publish" specifications/standards yet beyond "draft". I think runtime keys is in a stable enough place to be referenced here.

anonrig · 2023-06-10T18:45:42Z

LGTM - fwiw WinterCG is a W3C Community Group. We can't actually "publish" specifications/standards yet beyond "draft". I think runtime keys is in a stable enough place to be referenced here.

Thanks @Ethan-Arrowood. We are using the word proposal in the reference and in the URL (https://runtime-keys.proposal.wintercg.org), and the website contains draft, as well as your message. Which one is the correct terminology to define the spec? Shouldn't we be aligned on both node.js docs, runtime-keys URL, and the runtime-keys website content (referring Draft Community Group Report, 14 April 2023)

Ethan-Arrowood · 2023-06-10T18:51:01Z

Proposal and draft are synonymous I believe. I'm not a stickler about it

anonrig · 2023-06-11T15:49:13Z

@jcbhmr can you fix the linter issues?

jcbhmr · 2023-06-11T21:55:22Z

It was that one of the lines was a bit too long. 😆 I think I've fixed it! 👍

anonrig · 2023-06-11T22:09:35Z

@jcbhmr Can you squash all commits and make sure that the first commit explains what this pull request does? If we add commit-queue-squash label, it will be merged into main branch using the commit message doc: remove "deno" export condition because it is the first commit in this pull request.

jcbhmr · 2023-06-12T19:58:18Z

Done! 😊 Now there's a single commit:

[link-to-runtime-keys a3a2cc26cd5] doc: remove non-Node.js export conditions & link to WinterCG Runtime Keys
 Author: Jacob Hummer <jcbhmr@outlook.com>
 1 file changed, 9 insertions(+), 4 deletions(-)

I did this:

git reset --soft origin/main
git commit -m ...

as described here: https://stackoverflow.com/questions/25356810/git-how-to-squash-all-commits-on-branch

anonrig · 2023-06-12T20:59:39Z

Thanks. The commit message is too long. Please take a look at commit message guidelines.

This commit: 1. Adds a link to the WinterCG Runtime Keys proposal draft spec in the documentation for the `export` condition. 2. Adds a criteria to add more export conditions to the Node.js docs: they should be Node.js core-relevant. 3. Removes the "deno" and "react-native" export conditions from the core docs with the expectation that readers will follow the link to the Runtime Keys proposal draft spec to learn about them and more.

jcbhmr · 2023-06-12T21:12:16Z

I've rewritten the commit message. ❤️

nodejs-github-bot · 2023-06-20T02:24:29Z

Landed in 43c3d9f

This commit: 1. Adds a link to the WinterCG Runtime Keys proposal draft spec in the documentation for the `export` condition. 2. Adds a criteria to add more export conditions to the Node.js docs: they should be Node.js core-relevant. 3. Removes the "deno" and "react-native" export conditions from the core docs with the expectation that readers will follow the link to the Runtime Keys proposal draft spec to learn about them and more. PR-URL: #48408 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Jacob Smith <jacob@frende.me> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>

This commit: 1. Adds a link to the WinterCG Runtime Keys proposal draft spec in the documentation for the `export` condition. 2. Adds a criteria to add more export conditions to the Node.js docs: they should be Node.js core-relevant. 3. Removes the "deno" and "react-native" export conditions from the core docs with the expectation that readers will follow the link to the Runtime Keys proposal draft spec to learn about them and more. PR-URL: nodejs#48408 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Jacob Smith <jacob@frende.me> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>

This commit: 1. Adds a link to the WinterCG Runtime Keys proposal draft spec in the documentation for the `export` condition. 2. Adds a criteria to add more export conditions to the Node.js docs: they should be Node.js core-relevant. 3. Removes the "deno" and "react-native" export conditions from the core docs with the expectation that readers will follow the link to the Runtime Keys proposal draft spec to learn about them and more. PR-URL: #48408 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Jacob Smith <jacob@frende.me> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jun 10, 2023

aduh95 reviewed Jun 10, 2023

View reviewed changes

doc/api/packages.md Outdated Show resolved Hide resolved

jcbhmr marked this pull request as ready for review June 10, 2023 07:17

aduh95 reviewed Jun 10, 2023

View reviewed changes

doc/api/packages.md Outdated Show resolved Hide resolved

JakobJingleheimer reviewed Jun 10, 2023

View reviewed changes

doc/api/packages.md Outdated Show resolved Hide resolved

doc/api/packages.md Outdated Show resolved Hide resolved

guybedford approved these changes Jun 10, 2023

View reviewed changes

doc/api/packages.md Outdated Show resolved Hide resolved

jcbhmr changed the title ~~Link to runtime keys in export conditions docs~~ Link to WinterCG Runtime Keys in export conditions docs Jun 10, 2023

lpinca approved these changes Jun 10, 2023

View reviewed changes

anonrig reviewed Jun 10, 2023

View reviewed changes

doc/api/packages.md Outdated Show resolved Hide resolved

Ethan-Arrowood approved these changes Jun 10, 2023

View reviewed changes

GeoffreyBooth approved these changes Jun 11, 2023

View reviewed changes

JakobJingleheimer approved these changes Jun 11, 2023

View reviewed changes

anonrig approved these changes Jun 11, 2023

View reviewed changes

tniessen approved these changes Jun 13, 2023

View reviewed changes

aymen94 approved these changes Jun 19, 2023

View reviewed changes

jasnell approved these changes Jun 20, 2023

View reviewed changes

jasnell added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 20, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 20, 2023

nodejs-github-bot merged commit 43c3d9f into nodejs:main Jun 20, 2023

jcbhmr deleted the link-to-runtime-keys branch June 24, 2023 23:59

RafaelGSS mentioned this pull request Jul 3, 2023

v20.4.0 proposal #48643

Merged

ruyadorno mentioned this pull request Sep 10, 2023

v18.18.0 proposal #49220

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Link to WinterCG Runtime Keys in export conditions docs #48408

Link to WinterCG Runtime Keys in export conditions docs #48408

jcbhmr commented Jun 10, 2023 •

edited

Loading

nodejs-github-bot commented Jun 10, 2023

guybedford left a comment

anonrig left a comment

guybedford commented Jun 10, 2023

Ethan-Arrowood left a comment

anonrig commented Jun 10, 2023

Ethan-Arrowood commented Jun 10, 2023

anonrig commented Jun 11, 2023

jcbhmr commented Jun 11, 2023

anonrig commented Jun 11, 2023

jcbhmr commented Jun 12, 2023 •

edited

Loading

anonrig commented Jun 12, 2023

jcbhmr commented Jun 12, 2023 •

edited

Loading

nodejs-github-bot commented Jun 20, 2023

Link to WinterCG Runtime Keys in export conditions docs #48408

Link to WinterCG Runtime Keys in export conditions docs #48408

Conversation

jcbhmr commented Jun 10, 2023 • edited Loading

nodejs-github-bot commented Jun 10, 2023

guybedford left a comment

Choose a reason for hiding this comment

anonrig left a comment

Choose a reason for hiding this comment

guybedford commented Jun 10, 2023

Ethan-Arrowood left a comment

Choose a reason for hiding this comment

anonrig commented Jun 10, 2023

Ethan-Arrowood commented Jun 10, 2023

anonrig commented Jun 11, 2023

jcbhmr commented Jun 11, 2023

anonrig commented Jun 11, 2023

jcbhmr commented Jun 12, 2023 • edited Loading

anonrig commented Jun 12, 2023

jcbhmr commented Jun 12, 2023 • edited Loading

nodejs-github-bot commented Jun 20, 2023

jcbhmr commented Jun 10, 2023 •

edited

Loading

jcbhmr commented Jun 12, 2023 •

edited

Loading

jcbhmr commented Jun 12, 2023 •

edited

Loading