Skip to content

fix(docs): revert auto-generated portion of docs #3654

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

Jump to bottom
Merged
merged 1 commit into from
Aug 17, 2021
Merged

fix(docs): revert auto-generated portion of docs #3654

merged 1 commit into from
Aug 17, 2021

Conversation

@wraithgar
Copy link
Member

The content in this portion of the docs is auto-generated.

References

Reverts #3630
@wraithgar wraithgar requested a review from a team as a code owner August 16, 2021 14:40
isaacs added a commit that referenced this pull request Aug 16, 2021
@isaacs
chore(docs): add more 'autogenerated' comments
af29f62 
This should prevent the kind of thing we've seen where people edit the generated docs, as in #3654 and #3630, and provide them with a helpful pointer so they put the config documentation changes in the right place.
@isaacs isaacs mentioned this pull request Aug 16, 2021
Merged
isaacs added a commit that referenced this pull request Aug 16, 2021
@isaacs
chore(docs): add more 'autogenerated' comments
dd2de43 
This should prevent the kind of thing we've seen where people edit the generated docs, as in #3654 and #3630, and provide them with a helpful pointer so they put the config documentation changes in the right place.
isaacs added a commit that referenced this pull request Aug 16, 2021
@isaacs
chore(ci): check that docs are up to date in ci
8ce76de 
When we accidentally edit the auto-generated portions of the docs, this will catch the error and cause CI to fail. Later phase automated safety check that the early-stage human commenting in the last commit also addresses. Re: #3654 Re: #3630
@darcyclarke darcyclarke added semver:patch semver patch level for changes Release 7.x work is associated with a specific npm 7 release labels Aug 17, 2021
@isaacs
Copy link
Contributor

isaacs commented Aug 17, 2021

RSLGTM. Would be nice to also re-add it to the spot where it belongs, maybe pull in the commit from #3630 and edit it to be in the right place?
@ljharb
Copy link
Contributor

ljharb commented Aug 17, 2021

Does generated content need to be in the repo at all? Or could it be generated on prepack
@wraithgar
Copy link
Member Author

Does generated content need to be in the repo at all? Or could it be generated on prepack

Ideally yes the generated content will be separate from its source components. We made an iterative step to swap out the generated content inside already existing files, and eventually will want to take the next step.
@wraithgar
Copy link
Member Author

RSLGTM. Would be nice to also re-add it to the spot where it belongs, maybe pull in the commit from #3630 and edit it to be in the right place?

Yeah I added a comment to the original PR but for now this gets us back to being able to cut the nodejs/node pr
@wraithgar
fix(docs): revert auto-generated portion of docs
4314490 
The content in this portion of the docs is auto-generated. PR-URL: #3654 Credit: @wraithgar Close: #3654 Reviewed-by: @nlf
@wraithgar wraithgar force-pushed the gar/publish-docs-fix branch from 0c6188c to 4314490 Compare August 17, 2021 16:00
@wraithgar wraithgar merged commit 4314490 into release-next Aug 17, 2021
@wraithgar wraithgar deleted the gar/publish-docs-fix branch August 17, 2021 16:00
wraithgar pushed a commit that referenced this pull request Aug 17, 2021
@isaacs @wraithgar
chore(docs): add more 'autogenerated' comments
22f3bbb 
This should prevent the kind of thing we've seen where people edit the generated docs, as in #3654 and #3630, and provide them with a helpful pointer so they put the config documentation changes in the right place.
wraithgar pushed a commit that referenced this pull request Aug 17, 2021
@isaacs @wraithgar
chore(ci): check that docs are up to date in ci
7a58264 
When we accidentally edit the auto-generated portions of the docs, this will catch the error and cause CI to fail. Later phase automated safety check that the early-stage human commenting in the last commit also addresses. Re: #3654 Re: #3630 PR-URL: #3655 Credit: @isaacs Close: #3655 Reviewed-by: @nlf
isaacs added a commit that referenced this pull request Aug 17, 2021
@isaacs
chore(docs): add more 'autogenerated' comments
880cefd 
This should prevent the kind of thing we've seen where people edit the generated docs, as in #3654 and #3630, and provide them with a helpful pointer so they put the config documentation changes in the right place.
isaacs added a commit that referenced this pull request Aug 17, 2021
@isaacs
chore(ci): check that docs are up to date in ci
ac8bdbf 
When we accidentally edit the auto-generated portions of the docs, this will catch the error and cause CI to fail. Later phase automated safety check that the early-stage human commenting in the last commit also addresses. Re: #3654 Re: #3630
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Release 7.x work is associated with a specific npm 7 release semver:patch semver patch level for changes

5 participants

@wraithgar @isaacs @ljharb @nlf @darcyclarke