Skip to content

Commit c1f90a5

Browse files
mhdawsondanielleadams
authored andcommittedJan 3, 2023
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 <mdawson@devrus.com> PR-URL: #45626 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 90e9951 commit c1f90a5

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed
 

‎doc/contributing/api-documentation.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,21 @@ generate the following:
1111
1. Human-readable HTML in `out/doc/api/*.html`
1212
2. A JSON representation in `out/doc/api/*.json`
1313

14-
These are published to nodejs.org for multiple versions of Node.js. As an
15-
example the latest version of the human-readable HTML is published to
16-
[nodejs.org/en/doc](https://nodejs.org/en/docs/), and the latest version
17-
of the json documentation is published to
14+
These artifacts are published to nodejs.org for multiple versions of
15+
Node.js. As an example the latest version of the human-readable HTML
16+
is published to [nodejs.org/en/doc](https://nodejs.org/en/docs/),
17+
and the latest version of the json documentation is published to
1818
[nodejs.org/api/all.json](https://nodejs.org/api/all.json)
1919

20-
<!-- TODO: Add docs about how the publishing process happens -->
20+
The artifacts are built as part of release builds by running the [doc-upload](https://github.com/nodejs/node/blob/1a83ad6a693f851199608ae957ac5d4f76871485/Makefile#L1218-L1224)
21+
Makefile target as part of the release-sources part of the
22+
iojs+release job.
23+
This target runs the `doc` target to build the docs and then uses
24+
`scp` to copy them onto the staging/www server into a directory of the form
25+
`/home/staging/nodejs/<type>/<full_version>/docs` where <type> is e.g.
26+
release, nightly, etc. The promotion step (either automatic for
27+
nightlies or manual for releases) then moves the docs to
28+
`/home/dist/nodejs/docs/\<full\_version>` where they are served by node.org.
2129

2230
**The key things to know about the tooling include:**
2331

0 commit comments

Comments
 (0)
Please sign in to comment.