1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add detail on how api docs are published

Browse Source 
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>
This commit is contained in:
Michael Dawson 2022-11-25 13:56:44 -05:00
parent f9227ffc4b
commit e42425b2d6
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/contributing/api-documentation.md
View File

@ -11,13 +11,21 @@ generate the following:
1. Human-readable HTML in `out/doc/api/*.html` 1. Human-readable HTML in `out/doc/api/*.html`
2. A JSON representation in `out/doc/api/*.json` 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 are published to nodejs.org for multiple versions of
example the latest version of the human-readable HTML is published to Node.js. As an example the latest version of the human-readable HTML
[nodejs.org/en/doc](https://nodejs.org/en/docs/), and the latest version is published to [nodejs.org/en/doc](https://nodejs.org/en/docs/),
of the json documentation is published to and the latest version of the json documentation is published to
[nodejs.org/api/all.json](https://nodejs.org/api/all.json) [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:** **The key things to know about the tooling include:**