Skip to content

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

Closed
targos wants to merge 6 commits into
nodejs:v14.x-stagingfrom
targos:restructure-fs-docs-v14
Closed

[v14.x backport] doc: refactor fs docs structure#39706
targos wants to merge 6 commits into
nodejs:v14.x-stagingfrom
targos:restructure-fs-docs-v14

Conversation

@targos

@targostargos commented Aug 8, 2021

Copy link
Copy Markdown
Member
  • 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-actionsgithub-actionsBot added doc Issues and PRs related to the documentations. v14.x labels Aug 8, 2021
@targos

targos commented Aug 8, 2021

Copy link
Copy Markdown
MemberAuthor

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

targos commented Aug 8, 2021

Copy link
Copy Markdown
MemberAuthor

/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

targos commented Aug 12, 2021

Copy link
Copy Markdown
MemberAuthor

@nodejs/documentation @nodejs/fs

@targos
targosforce-pushed the restructure-fs-docs-v14 branch from e5744a3 to fd0d821CompareAugust 13, 2021 08:28
@targos

targos commented Aug 13, 2021

Copy link
Copy Markdown
MemberAuthor

Anyone? Trying @nodejs/backporters

@targos

targos commented Aug 21, 2021

Copy link
Copy Markdown
MemberAuthor

Maybe @nodejs/lts ?

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

targos commented Aug 29, 2021

Copy link
Copy Markdown
MemberAuthor

/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

Trott commented Aug 29, 2021

Copy link
Copy Markdown
Member

/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 jasnellAugust 29, 2021 14:07
@targos

targos commented Aug 29, 2021

Copy link
Copy Markdown
MemberAuthor

@Trott no

aduh95
aduh95 reviewed Sep 1, 2021
View reviewed changes

@aduh95aduh95 left a comment

Copy link
Copy Markdown
Contributor

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:

Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
Comment threaddoc/api/fs.md Outdated
@targos

targos commented Sep 1, 2021

Copy link
Copy Markdown
MemberAuthor

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

@targostargos closed this Sep 1, 2021
@targostargos reopened this Sep 1, 2021
targosand 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 <jasnell@gmail.com>
PR-URL: nodejs#37170
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@targos
squash: revert bad changes fromd963269
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 <rtrott@gmail.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@targos
targosforce-pushed the restructure-fs-docs-v14 branch from fd0d821 to e912108CompareSeptember 1, 2021 17:28
@aduh95

aduh95 commented Sep 1, 2021

Copy link
Copy Markdown
Contributor

@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 <duhamelantoine1995@gmail.com>
@aduh95aduh95 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 <jasnell@gmail.com>
PR-URL: #37170
Backport-PR-URL: #39706
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@targos

targos commented Sep 1, 2021

Copy link
Copy Markdown
MemberAuthor

Landed in 307c1d8 and f5b2fe1

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

Reviewers

@aduh95aduh95aduh95 approved these changes
@jasnelljasnellAwaiting requested review from jasnell
+1 more reviewer
@aymen94aymen94aymen94 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.release-agendaIssues and PRs to discuss during the meetings of the Release team.review wantedPRs 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