Skip to content
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

[v14.x backport] doc: refactor fs docs structure #39706

Closed
wants to merge 6 commits into from
Closed

[v14.x backport] doc: refactor fs docs structure #39706

wants to merge 6 commits into from

Conversation

targos
Copy link
Member

@targos targos commented Aug 8, 2021

  • squash: make fs.md identical to master
  • squash: restore lost changes entry in dgram.md
  • doc: refactor fs docs structure
  • squash: revert bad changes from d963269
  • doc: change lang info string in fs JS snippets

@github-actions github-actions bot added doc Issues and PRs related to the documentations. v14.x labels Aug 8, 2021
@targos
Copy link
Member Author

targos commented Aug 8, 2021

Backport of #37170 and #37605

The first 4 commits are supposed to be squashed together.
Here's what I did:

  • Copy the version of fs.md from the master branch at the commit before the restructuring (creating d963269)
  • Fixed dgram.md (I realized the history entry was lost in a previous backport along with two others in fs.md)
  • Cherry-picked doc: refactor fs docs structure #37170 cleanly
  • Reverted the changes from d963269 that do not apply to v14.x or adapted them for v14.x

@targos
Copy link
Member Author

targos commented Aug 8, 2021

/cc @jasnell as you did the original changes. I haven't verified if everything that is in the new version of the docs applies to v14.x except for what is in d963269.

@targos
Copy link
Member Author

targos commented Aug 12, 2021

@nodejs/documentation @nodejs/fs

@targos
Copy link
Member Author

targos commented Aug 13, 2021

Anyone? Trying @nodejs/backporters

@targos
Copy link
Member Author

targos commented Aug 21, 2021

Maybe @nodejs/lts ?

@targos targos added the release-agenda Issues and PRs to discuss during the meetings of the Release team. label Aug 25, 2021
@targos targos mentioned this pull request Aug 25, 2021
Closed
@BethGriggs BethGriggs added the review wanted PRs that need reviews. label Aug 26, 2021
@targos
Copy link
Member Author

targos commented Aug 29, 2021

/cc @nodejs/collaborators

See the explanation in #39706 (comment)
I'm not necessarily looking for a review of the diff (which is probably impossible).

@Trott
Copy link
Member

Trott commented Aug 29, 2021

/cc @nodejs/collaborators

See the explanation in #39706 (comment)
I'm not necessarily looking for a review of the diff (which is probably impossible).

Did you mean to link to the comment in #39706 (comment)?

@Trott Trott requested a review from jasnell August 29, 2021 14:07
@targos
Copy link
Member Author

targos commented Aug 29, 2021

@Trott no

aduh95
aduh95 reviewed Sep 1, 2021
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

I've only reviewed fs.md, found a few inconsistencies:

doc/api/fs.md Outdated Show resolved Hide resolved
doc/api/fs.md Show resolved Hide resolved
doc/api/fs.md Outdated Show resolved Hide resolved
doc/api/fs.md Outdated Show resolved Hide resolved
doc/api/fs.md Show resolved Hide resolved
@targos
Copy link
Member Author

targos commented Sep 1, 2021

@aduh95 okay, thank you. do these changes only apply to v14.x or should they also land on master?

@targos targos closed this Sep 1, 2021
@targos targos reopened this Sep 1, 2021
targos and others added 5 commits September 1, 2021 19:28
@targos
squash: make fs.md identical to master
2ed0c3f
@targos
squash: restore lost changes entry in dgram.md
136c98d
@jasnell @targos
doc: refactor fs docs structure
6a5c4c5 
* Convert examples to esm to help promote that pattern with users
* Make Promises APIs more prominent to help promite that pattern
* Separate callback/sync apis into distinct sections to make those
  more consistent with the Promises api
* Improve other bits and pieces

Signed-off-by: James M Snell <[email protected]>

PR-URL: nodejs#37170
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@targos
squash: revert bad changes from d963269
29dafe9
@aduh95 @targos
doc: change lang info string in fs JS snippets
e912108 
Refs: nodejs/remark-preset-lint-node#176

PR-URL: nodejs#37605
Refs: nodejs#37162
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Danielle Adams <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@aduh95
Copy link
Contributor

aduh95 commented Sep 1, 2021

@aduh95 okay, thank you. do these changes only apply to v14.x or should they also land on master?

These are the changes that are already on master and should be in this PR IMHO (either because those were part of #37170, or because they happened in a PR that has already been backported to v14.x-staging).

@targos @aduh95
Apply suggestions from code review
2f751eb 
Co-authored-by: Antoine du Hamel <[email protected]>
@aduh95 aduh95 mentioned this pull request Sep 1, 2021
Closed
targos added a commit that referenced this pull request Sep 1, 2021
@targos
doc: refactor fs docs structure
307c1d8 
* Convert examples to esm to help promote that pattern with users
* Make Promises APIs more prominent to help promite that pattern
* Separate callback/sync apis into distinct sections to make those
  more consistent with the Promises api
* Improve other bits and pieces

Signed-off-by: James M Snell <[email protected]>

PR-URL: #37170
Backport-PR-URL: #39706
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@targos
Copy link
Member Author

targos commented Sep 1, 2021

Landed in 307c1d8 and f5b2fe1

@targos targos closed this Sep 1, 2021
@targos targos deleted the restructure-fs-docs-v14 branch September 1, 2021 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

@aymen94 aymen94 aymen94 approved these changes

@jasnell jasnell Awaiting requested review from jasnell

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. release-agenda Issues and PRs to discuss during the meetings of the Release team. review wanted PRs that need reviews.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@targos @Trott @aduh95 @aymen94 @BethGriggs @jasnell