From 72c8ecf927fba5d5df1ba6cc44bce3e3a0441199 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Fri, 25 Nov 2022 13:56:44 -0500 Subject: [PATCH 1/7] doc: add detail on how api docs are published Add some details that Richard shared with me on how the docs are published to the website. Signed-off-by: Michael Dawson --- doc/contributing/api-documentation.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 8bce952929b705..5eae5b2c6b743d 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -11,13 +11,21 @@ generate the following: 1. Human-readable HTML in `out/doc/api/*.html` 2. A JSON representation in `out/doc/api/*.json` -These are published to nodejs.org for multiple versions of Node.js. As an +These artifacts published to nodejs.org for multiple versions of Node.js. As an example the latest version of the human-readable HTML is published to [nodejs.org/en/doc](https://nodejs.org/en/docs/), and the latest version of the json documentation is published to [nodejs.org/api/all.json](https://nodejs.org/api/all.json) - +The artifacts are built as part of release builds by running the doc-upload +Makefile target as part of the release-sources part of the +[iojs+release job](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224). +This target runs the doc target to build the docs and then uses +scp to copy them onto the staging/www server into a directory of the form +`/home/staging/nodejs///docs` where is e.g. +release, nightly, etc. The promotion step (either automatic for +nightlies or manual for releases) then moves the docs to +/home/dist/nodejs/docs/\ where they are served by node.org. **The key things to know about the tooling include:** From 3b0ccd9e50a3ea708f4d05232f08618bbc643e9a Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 28 Nov 2022 17:26:30 -0500 Subject: [PATCH 2/7] Update doc/contributing/api-documentation.md Co-authored-by: Luigi Pinca --- doc/contributing/api-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 5eae5b2c6b743d..77ed902214fb1a 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -11,7 +11,7 @@ generate the following: 1. Human-readable HTML in `out/doc/api/*.html` 2. A JSON representation in `out/doc/api/*.json` -These artifacts published to nodejs.org for multiple versions of Node.js. As an +These artifacts are published to nodejs.org for multiple versions of Node.js. As an example the latest version of the human-readable HTML is published to [nodejs.org/en/doc](https://nodejs.org/en/docs/), and the latest version of the json documentation is published to From 25368bb6fb5d6868f1c77e67d262f1356e1601db Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 28 Nov 2022 17:26:35 -0500 Subject: [PATCH 3/7] Update doc/contributing/api-documentation.md Co-authored-by: Luigi Pinca --- doc/contributing/api-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 77ed902214fb1a..24d0b78dbb14bd 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -25,7 +25,7 @@ scp to copy them onto the staging/www server into a directory of the form `/home/staging/nodejs///docs` where is e.g. release, nightly, etc. The promotion step (either automatic for nightlies or manual for releases) then moves the docs to -/home/dist/nodejs/docs/\ where they are served by node.org. +`/home/dist/nodejs/docs/\` where they are served by node.org. **The key things to know about the tooling include:** From af3b4fdaeb4692e06ab461a5db250770a6432179 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 28 Nov 2022 17:27:08 -0500 Subject: [PATCH 4/7] Update doc/contributing/api-documentation.md Co-authored-by: Richard Lau --- doc/contributing/api-documentation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 24d0b78dbb14bd..3ccd001785c99c 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -17,9 +17,9 @@ example the latest version of the human-readable HTML is published to of the json documentation is published to [nodejs.org/api/all.json](https://nodejs.org/api/all.json) -The artifacts are built as part of release builds by running the doc-upload +The artifacts are built as part of release builds by running the [doc-upload](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224) Makefile target as part of the release-sources part of the -[iojs+release job](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224). +iojs+release job. This target runs the doc target to build the docs and then uses scp to copy them onto the staging/www server into a directory of the form `/home/staging/nodejs///docs` where is e.g. From be34ef88d8568c84909392770eada3d99a7fac16 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 28 Nov 2022 17:27:20 -0500 Subject: [PATCH 5/7] Update doc/contributing/api-documentation.md Co-authored-by: Luigi Pinca --- doc/contributing/api-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 3ccd001785c99c..3d6f7fef2b96f5 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -21,7 +21,7 @@ The artifacts are built as part of release builds by running the [doc-upload](ht Makefile target as part of the release-sources part of the iojs+release job. This target runs the doc target to build the docs and then uses -scp to copy them onto the staging/www server into a directory of the form +`scp` to copy them onto the staging/www server into a directory of the form `/home/staging/nodejs///docs` where is e.g. release, nightly, etc. The promotion step (either automatic for nightlies or manual for releases) then moves the docs to From 45aed40578316f6c5f201211c355255fe7c9e5c3 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 28 Nov 2022 17:27:58 -0500 Subject: [PATCH 6/7] Update doc/contributing/api-documentation.md Co-authored-by: Richard Lau --- doc/contributing/api-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 3d6f7fef2b96f5..2ceb9f9fafe99b 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -20,7 +20,7 @@ of the json documentation is published to The artifacts are built as part of release builds by running the [doc-upload](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224) Makefile target as part of the release-sources part of the iojs+release job. -This target runs the doc target to build the docs and then uses +This target runs the `doc` target to build the docs and then uses `scp` to copy them onto the staging/www server into a directory of the form `/home/staging/nodejs///docs` where is e.g. release, nightly, etc. The promotion step (either automatic for From 19a67bd54a00176d862502ef8b44eb32f4cb1001 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 1 Dec 2022 09:27:59 -0500 Subject: [PATCH 7/7] fixued linter issues --- doc/contributing/api-documentation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 2ceb9f9fafe99b..1ba8daaf18e851 100644 --- a/doc/contributing/api-documentation.md +++ b/doc/contributing/api-documentation.md @@ -11,10 +11,10 @@ generate the following: 1. Human-readable HTML in `out/doc/api/*.html` 2. A JSON representation in `out/doc/api/*.json` -These artifacts are published to nodejs.org for multiple versions of Node.js. As an -example the latest version of the human-readable HTML is published to -[nodejs.org/en/doc](https://nodejs.org/en/docs/), and the latest version -of the json documentation is published to +These artifacts are published to nodejs.org for multiple versions of +Node.js. As an example the latest version of the human-readable HTML +is published to [nodejs.org/en/doc](https://nodejs.org/en/docs/), +and the latest version of the json documentation is published to [nodejs.org/api/all.json](https://nodejs.org/api/all.json) The artifacts are built as part of release builds by running the [doc-upload](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224)