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

doc: document major finished changes in v14 #33065

Closed
wants to merge 5 commits into from
Closed

doc: document major finished changes in v14 #33065

wants to merge 5 commits into from

Conversation

ronag
Copy link
Member

@ronag ronag commented Apr 25, 2020

Added description of semver-major changes to finished in v14.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@ronag ronag added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Apr 25, 2020
@ronag ronag requested a review from mcollina April 25, 2020 19:18
@ronag ronag mentioned this pull request Apr 25, 2020
Closed
@ronag ronag force-pushed the finished-changes-history branch 6 times, most recently from ba4897e to 329583b Compare April 25, 2020 19:25
@ronag
doc: document major finished changes in v14
9392877 
Added description of semver-major changes to finished in v14.
@ronag
Copy link
Member Author

ronag commented Apr 25, 2020 •
edited
Loading

@nodejs/documentation make lint-md succeeds, but build-docs fails. I might need a little help figuring out the proper formatting.

https://github.com/nodejs/node/pull/33065/checks?check_run_id=618533325

mcollina
mcollina approved these changes Apr 25, 2020
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30991/

@ronag
Copy link
Member Author

ronag commented Apr 26, 2020 •
edited
Loading

Stuck at formatting issue.

@addaleax
Copy link
Member

@ronag You probably want to indent the description: blocks, e.g. like this:

node/doc/api/assert.md

Lines 15 to 17 in 5ee1e31

description: Changed "strict mode" to "strict assertion mode" and "legacy
mode" to "legacy assertion mode" to avoid confusion with the
more usual meaining of "strict mode".

Otherwise the YAML parser doesn’t know that the subsequent lines still belong to the description: value.

addaleax
addaleax approved these changes Apr 26, 2020
View reviewed changes
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

LGTM with the linter/doc build passing

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30997/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30999/

@ronag
Copy link
Member Author

ronag commented Apr 27, 2020

Still formatting issues 😕

@addaleax
Copy link
Member

@ronag Ah yeah, YAML is not a fan of strings starting with backticks … you can make the first line description: > and then put the rest of the text in subsequent lines, I think

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/31010/

@ronag
Copy link
Member Author

ronag commented Apr 27, 2020

Landed in e5512ac

@ronag ronag closed this Apr 27, 2020
ronag added a commit that referenced this pull request Apr 27, 2020
@ronag
doc: document major finished changes in v14
e5512ac 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
@ronag @BethGriggs
doc: document major finished changes in v14
9e7b6ae 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
@ronag @BridgeAR
doc: document major finished changes in v14
16bd300 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
@ronag @BridgeAR
doc: document major finished changes in v14
6b6c8d0 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Apr 28, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
@ronag @BethGriggs
doc: document major finished changes in v14
47440bd 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
@BethGriggs BethGriggs mentioned this pull request Apr 28, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Apr 28, 2020
@ronag @BethGriggs
doc: document major finished changes in v14
401ab61 
Added description of semver-major changes to finished in v14.

PR-URL: #33065
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Juan José Arboleda <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 left review comments

@juanarbol juanarbol juanarbol approved these changes

@trivikr trivikr trivikr approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@jasnell jasnell jasnell approved these changes

@mcollina mcollina mcollina approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@ronag @nodejs-github-bot @addaleax @mcollina @jasnell @lpinca @aduh95 @trivikr @juanarbol @targos