doc: add detail on how api docs are published #45626
Closed
+13
−5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>
|
Review requested:
|
|
@ovflowd FYI some additional info on how the api docs make it on to nodejs.org. |
lpinca
approved these changes
Nov 25, 2022
ovflowd
reviewed
Nov 25, 2022
| <!-- TODO: Add docs about how the publishing process happens --> | ||
| 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). |
There was a problem hiding this comment.
Not without losing the highlighting (the line numbers are specific to that revision of the makefile).
ovflowd
reviewed
Nov 25, 2022
| 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 |
There was a problem hiding this comment.
Do we need to go that deep into the specifics here? Isn't that visible by reading the Makefile?
There was a problem hiding this comment.
I think the few lines are worth avoiding people having to click into the link.
richardlau
reviewed
Nov 25, 2022
richardlau
reviewed
Nov 25, 2022
| [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/<type>/<full_version>/docs` where <type> is e.g. |
There was a problem hiding this comment.
I'm undecided whether the details of where the files are on the server are useful here or not as it's only useful to people with root access to the server (e.g. the build-infra team).
There was a problem hiding this comment.
That's kinda what I meant, this kind of text feels like it should belong on nodejs/build?
There was a problem hiding this comment.
I don't think we have this documented anywhere else and I don't think it's too much of a distraction so the value of having it documented somewhere easy to find is worth it.
Co-authored-by: Luigi Pinca <luigipinca@gmail.com>
Co-authored-by: Luigi Pinca <luigipinca@gmail.com>
Co-authored-by: Richard Lau <rlau@redhat.com>
Co-authored-by: Luigi Pinca <luigipinca@gmail.com>
Co-authored-by: Richard Lau <rlau@redhat.com>
mhdawson
added a commit
that referenced
this pull request
Dec 2, 2022
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>
|
Landed in e42425b |
targos
pushed a commit
that referenced
this pull request
Dec 12, 2022
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>
danielleadams
pushed a commit
that referenced
this pull request
Dec 30, 2022
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>
danielleadams
pushed a commit
that referenced
this pull request
Dec 30, 2022
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>
danielleadams
pushed a commit
that referenced
this pull request
Jan 3, 2023
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>
danielleadams
pushed a commit
that referenced
this pull request
Jan 4, 2023
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>
danielleadams
pushed a commit
that referenced
this pull request
Jan 5, 2023
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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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