GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: add detail on how api docs are published by mhdawson · Pull Request #45626 · nodejs/node

Conversation

@mhdawson

@mhdawson mhdawson commented Nov 25, 2022

Copy link
Copy Markdown
Member

Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson [email protected]

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@mhdawson
doc: add detail on how api docs are published
72c8ecf 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>
@nodejs-github-bot

nodejs-github-bot commented Nov 25, 2022

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Nov 25, 2022
@mhdawson

mhdawson commented Nov 25, 2022

Copy link
Copy Markdown
Member Author

@ovflowd FYI some additional info on how the api docs make it on to nodejs.org.
ovflowd reacted with eyes emoji
All reactions
  • 👀 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
lpinca
lpinca approved these changes Nov 25, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
ovflowd
ovflowd reviewed Nov 25, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Outdated
<!-- 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).

@ovflowd ovflowd Nov 25, 2022

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we reference HEAD here?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@richardlau richardlau Nov 25, 2022

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not without losing the highlighting (the line numbers are specific to that revision of the makefile).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
ovflowd
ovflowd reviewed Nov 25, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Outdated
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

@ovflowd ovflowd Nov 25, 2022

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to go that deep into the specifics here? Isn't that visible by reading the Makefile?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@mhdawson mhdawson Nov 28, 2022

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the few lines are worth avoiding people having to click into the link.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
ovflowd
ovflowd approved these changes Nov 25, 2022
View reviewed changes

@ovflowd ovflowd left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for update here, @mhdawson 🙇

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
richardlau
richardlau reviewed Nov 25, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
richardlau
richardlau reviewed Nov 25, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md
[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.

@richardlau richardlau Nov 25, 2022

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@ovflowd ovflowd Nov 25, 2022

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's kinda what I meant, this kind of text feels like it should belong on nodejs/build?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@mhdawson mhdawson Nov 28, 2022

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
mhdawson and others added 6 commits November 28, 2022 17:26
@mhdawson @lpinca
Update doc/contributing/api-documentation.md
3b0ccd9 
Co-authored-by: Luigi Pinca <[email protected]>
@mhdawson @lpinca
Update doc/contributing/api-documentation.md
25368bb 
Co-authored-by: Luigi Pinca <[email protected]>
@mhdawson @richardlau
Update doc/contributing/api-documentation.md
af3b4fd 
Co-authored-by: Richard Lau <[email protected]>
@mhdawson @lpinca
Update doc/contributing/api-documentation.md
be34ef8 
Co-authored-by: Luigi Pinca <[email protected]>
@mhdawson @richardlau
Update doc/contributing/api-documentation.md
45aed40 
Co-authored-by: Richard Lau <[email protected]>
@mhdawson
fixued linter issues
19a67bd
mhdawson added a commit that referenced this pull request Dec 2, 2022
@mhdawson
doc: add detail on how api docs are published
e42425b 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #45626
Reviewed-By: Luigi Pinca <[email protected]>
@mhdawson

mhdawson commented Dec 2, 2022

Copy link
Copy Markdown
Member Author

Landed in e42425b
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@mhdawson mhdawson closed this Dec 2, 2022
targos pushed a commit that referenced this pull request Dec 12, 2022
@mhdawson @targos
doc: add detail on how api docs are published
801fe30 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #45626
Reviewed-By: Luigi Pinca <[email protected]>
@targos targos mentioned this pull request Dec 12, 2022
v19.3.0 release proposal #45831
Merged
@danielleadams danielleadams mentioned this pull request Dec 30, 2022
v18.13.0 release proposal #46025
Merged
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
@mhdawson @danielleadams
doc: add detail on how api docs are published
e96af6c 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #45626
Reviewed-By: Luigi Pinca <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
@mhdawson @danielleadams
doc: add detail on how api docs are published
c1f90a5 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #45626
Reviewed-By: Luigi Pinca <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 5, 2023
@mhdawson @danielleadams
doc: add detail on how api docs are published
e940662 
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <[email protected]>

PR-URL: #45626
Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@richardlau richardlau richardlau left review comments
@ovflowd ovflowd ovflowd approved these changes
@lpinca lpinca lpinca approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

doc Issues and PRs related to Node.js documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@mhdawson @nodejs-github-bot @lpinca @richardlau @ovflowd
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.