doc: update with recommended integration into package.json #281
Conversation
Fixes: nodejs#241 (comment) Update to add recommended integration with package.json as outlined in: nodejs#241 (comment)
|
@ljharb, @dominykas, @nodejs/package-maintenance |
|
Also @Eomm |
| [repository](https://docs.npmjs.com/files/package.json#repository) entry. In this case the filapath for the file containing the support information will be | ||
| `./package-support.json` | ||
| * a string: a relative path, starting with ./, that points to a file within the | ||
| repository specified in the [repository](https://docs.npmjs.com/files/package.json#repository) |
There was a problem hiding this comment.
(it'd be nicer to review if these weren't hard-wrapped)
docs/drafts/PACKAGE-SUPPORT.md
Outdated
| entry which contains the canonical support information. | ||
| * object, with repository key matching the schema for the existing | ||
| [repository](https://docs.npmjs.com/files/package.json#repository) entry, and optional | ||
| path field that comnplies with the format described above under `a string` |
There was a problem hiding this comment.
| path field that comnplies with the format described above under `a string` | |
| `path` field that complies with the format described above under `a string` |
| “no external internet” use cases as best as can be achieved. | ||
|
|
||
| In the future, we hope that the developer experience could be further inproved | ||
| through itegration with the npm client. For validation could be integrated into |
There was a problem hiding this comment.
Should we open a draft RFC (in both - yarn and npm - possibly other managers?) so that we can link to it?
There was a problem hiding this comment.
That sounds reasonable to me, although I don't think we need to block this PR on that. We can add the links once we open the issues.
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Dominykas Blyžė <hello@dominykas.com>
Co-Authored-By: Dominykas Blyžė <hello@dominykas.com>
Co-Authored-By: Dominykas Blyžė <hello@dominykas.com>
Co-Authored-By: Dominykas Blyžė <hello@dominykas.com>
Co-Authored-By: Dominykas Blyžė <hello@dominykas.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
Co-Authored-By: Vincent Weevers <mail@vincentweevers.nl>
Co-Authored-By: Jordan Harband <ljharb@gmail.com>
|
@nodejs/package-maintenance we'll need a few more reviewers to get to the 4 needed to land. |
docs/drafts/PACKAGE-SUPPORT.md
Outdated
| This recommendation is designed to meet the following | ||
| conflicting requirements: | ||
| * ability to review and process the support information | ||
| off-line with access to only the package itself. |
There was a problem hiding this comment.
can we remove the hard-wrapping throughout the doc? it's easier to review and suggest when arbitrary newlines aren't inserted all over the place :-)
There was a problem hiding this comment.
This is a subjective thing, which I am guessing causes the thumbs down. Depending on your editor and configuration, these newlines can make this document legible where otherwise it would not be. In this particular line it might not matter, but I know sometimes when I have vim open on a wide screen, a long single line paragraph is painful to read. Just my 2c.
EDIT: I am not saying it should be one way or another, I just wanted to point out it is heavily subjective.
There was a problem hiding this comment.
Sure, but the GitHub UI always wraps by default, and suggestions are single line, and vim/editors can easily be configured to soft wrap if desired.
Co-Authored-By: John Muhl <johnmuhl@users.noreply.github.com>
Co-Authored-By: John Muhl <johnmuhl@users.noreply.github.com>
Co-Authored-By: John Muhl <johnmuhl@users.noreply.github.com>
Co-Authored-By: John Muhl <johnmuhl@users.noreply.github.com>
Co-Authored-By: John Muhl <johnmuhl@users.noreply.github.com>
|
Ok we have 4th reviewer but need 7 days to pass so will wait to land until then. |
|
7 Days have passed, landing ! |
Fixes: #241 (comment)
Update to add recommended integration with package.json
as outlined in: #241 (comment)