diff options
| author | Michael Dawson <mdawson@devrus.com> | 2022-11-25 13:56:44 -0500 |
|---|---|---|
| committer | Danielle Adams <adamzdanielle@gmail.com> | 2023-01-04 20:31:50 -0500 |
| commit | e940662b27d2fe9b01e6582cb71138b0c874e08a (patch) | |
| tree | 00aa13ed9d0bbfdf42cf8824b8d9822099ad0045 | |
| parent | e1af8ba7a91444c01ff2aa0babd8819280c03320 (diff) | |
| download | node-new-e940662b27d2fe9b01e6582cb71138b0c874e08a.tar.gz | |
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: https://github.com/nodejs/node/pull/45626
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
| -rw-r--r-- | doc/contributing/api-documentation.md | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index 8bce952929..1ba8daaf18 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 -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) -<!-- TODO: Add docs about how the publishing process happens --> +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 +`scp` to copy them onto the staging/www server into a directory of the form +`/home/staging/nodejs/<type>/<full_version>/docs` where <type> 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/\<full\_version>` where they are served by node.org. **The key things to know about the tooling include:** |