Commit graph

27 commits

Author SHA1 Message Date
Rich Trott
86099a375a tools: avoid unnecessary escaping in markdown formatter
Update mdast-util-to-markdown to 1.2.4 which reduces unnecessary
escaping of `_` and some other characters. Re-run markdown formatter.

PR-URL: https://github.com/nodejs/node/pull/40645
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-10-31 09:36:05 -07:00
Richard Lau
4cb3e06ed8 doc: add updating expected assets to release guide
Add a section to the Major Releases section of the release guide
to cover updating the list of expected files for the promotion tool.

PR-URL: https://github.com/nodejs/node/pull/40470
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
2021-10-20 00:30:47 +00:00
Rich Trott
eb65871ab4 doc: format doc/guides using format-md task
PR-URL: https://github.com/nodejs/node/pull/40358
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-10-09 08:53:46 -07:00
Richard Lau
43502622f5
doc: move NODE_MODULE_VERSION in release guide
Move the section on `NODE_MODULE_VERSION` into the section for
major releases as it should only be updated for a major release.
Add a note to remove the `-pre` suffix from the registry for the
release commit.

PR-URL: https://github.com/nodejs/node/pull/39544
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-29 15:18:01 -04:00
Richard Lau
7fa032b96b
doc: remove outdated ARM information from release guide
We no longer produced ARMv6 builds, and the ARMv7 builds are now
cross compiled and are as quick as builds on the other platforms.

PR-URL: https://github.com/nodejs/node/pull/39544
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-29 15:17:59 -04:00
Richard Lau
a5bc5f7617
doc: fence command examples in release guide
Put the command examples for finding and replacing the `REPLACEME`
tags into code fences so that they are more easily copiable when
viewing the guide in the GitHub web UI.

PR-URL: https://github.com/nodejs/node/pull/39544
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-29 15:17:57 -04:00
Richard Lau
96cd561e09
doc: update backport labels in release guide
Add `backport-open-v1.x,backported-to-v1.x` labels to `branch-diff`
commands as these indicate pull requests that are being manually
backported and should not be cherry-picked.

PR-URL: https://github.com/nodejs/node/pull/39544
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-29 15:17:54 -04:00
Danielle Adams
223625a0b9
doc: add text about moving long commit lists out of PR description
PR-URL: https://github.com/nodejs/node/pull/39186
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-07-12 21:13:08 -04:00
Michael Dawson
4de6f207dc doc: use "repository" in guides versus repo
Fix remaining instances in the guides where we
use repo instead of repository.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/39198
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2021-07-06 08:51:37 -04:00
devsnek
e3ba96053e
doc: remove references to deleted freenode channels
PR-URL: https://github.com/nodejs/node/pull/39047
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2021-06-17 07:43:23 -05:00
Rod Vagg
9b878ecaf3
doc: request default snap track be updated for LTS
PR-URL: https://github.com/nodejs/node/pull/37708
Refs: https://github.com/nodejs/snap/pull/4
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-04-27 08:47:53 +02:00
Danielle Adams
dbe710512f doc: add more commands for cherry-picking and changelog to release docs
PR-URL: https://github.com/nodejs/node/pull/37785
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
2021-03-28 19:19:20 +02:00
Michael Dawson
5421e15bdc doc: use HEAD in links where possible
Where possible used HEAD in links

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/37421
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-19 16:14:54 -05:00
Rich Trott
dd731e26b8 doc: apply sentence case to release doc headers
Our style is to use sentence case for headers and documentation titles.
The documentation for releases uses both sentence case and title case.
This change applies sentence case consistently throughout.

PR-URL: https://github.com/nodejs/node/pull/37349
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-15 05:12:05 -08:00
Rich Trott
4d3e87da3b doc: use _code name_ rather than _codename_
This is excrutiatingly minor, but every authoritative resource I've
checked (which is to say, a few dictionaries) uses "code name" primarily
or exclusively. Let's follow suit.

PR-URL: https://github.com/nodejs/node/pull/36611
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2020-12-26 20:01:09 -08:00
Richard Lau
0b3caadad3 doc: make explicit reverting node_version.h changes
Add an explicit command to revert changes to `node_version.h` when
cherry-picking the release commit to the `master` branch.

PR-URL: https://github.com/nodejs/node/pull/36461
Refs: https://github.com/nodejs/node/pull/36460
Refs: https://github.com/nodejs/node/pull/36385
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Danielle Adams <adamzdanielle@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-12-16 10:57:56 +00:00
Danielle Adams
b15ed65153 doc: add gpg key export directions to releases doc
Adds an extra step with instructions for exporting a gpg key to be
uploaded to the key server.

PR-URL: https://github.com/nodejs/node/pull/35298
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-09-26 06:55:34 -07:00
Antoine du Hamel
7794d36a37 tools,doc: enforce alphabetical order for md refs
PR-URL: https://github.com/nodejs/node/pull/35244
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
2020-09-22 10:25:43 -07:00
Myles Borins
d71b467bbe
doc: put release script specifics in details
Listing all the steps can be confusing an make it seem like
the releaser is meant to run each of these steps manually. In fact
I personally did that my first release.

Let's put those steps in a details block to make it more obvious
that it is informational and not steps to follow

PR-URL: https://github.com/nodejs/node/pull/35260
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2020-09-21 18:13:21 -04:00
Michaël Zasso
ed8af4e938 doc: add issue labels sections to release guide
PR-URL: https://github.com/nodejs/node/pull/35224
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-09-18 03:08:13 -07:00
Derek Lewis
e2d3230565 doc: normalize Markdown code block info strings
Prior to this commit, Markdown fenced code blocks in Markdown
files had inconsistent info strings. This has been corrected to
standardize on the one shown in the CommonMark spec.

Refs: 1103710025/spec.txt (L131)

PR-URL: https://github.com/nodejs/node/pull/33542
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2020-05-30 04:27:31 +02:00
Zeke Sikelianos
f08174c9fb doc: update ``txt `fandamental and ``raw code blocks
These are changed to either ```text or ```console.

PR-URL: https://github.com/nodejs/node/pull/33028
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-05-30 03:43:39 +02:00
Derek Lewis
549812a9a0 doc: normalize Bash code block info strings
Prior to this commit, Bash fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standardize on
the less-obscure variant.

PR-URL: https://github.com/nodejs/node/pull/33510
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-05-25 19:08:45 +02:00
Michaël Zasso
16d794dae6
doc: improve release documentation
Extract the "Cherry-pick the Release Commit to master" part to its own
section and be more precise about what should be done to handle
conflicts.

PR-URL: https://github.com/nodejs/node/pull/33042
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
2020-04-28 00:19:58 +02:00
Nick Schonning
7183d70273 doc: add angle brackets around implicit links
PR-URL: https://github.com/nodejs/node/pull/32676
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-04-23 21:48:17 -07:00
Antoine du HAMEL
19db0e60bd
doc: tests local links in markdown documents
PR-URL: https://github.com/nodejs/node/pull/32359
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-03-30 10:20:59 +02:00
ConorDavenport
bf7409e974
doc: improve doc/markdown file organization coherence
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: https://github.com/nodejs/node/issues/31741

PR-URL: https://github.com/nodejs/node/pull/31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2020-03-04 13:13:07 +00:00
Renamed from doc/releases.md (Browse further)