Skip to content
This repository has been archived by the owner on Mar 25, 2018. It is now read-only.

build: use doc-tool module #84

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

robertkowalski
Copy link
Contributor

delete old checked in doc-tool. run npm i -g node-doc-generator
before building the docs.

@misterdjules i don't remember how you double checked if something for the doc changed exactly (it was a rsync dry run) can you send me a hint - so far i just verified by looking at the results and by writing the tests

@misterdjules
Copy link

@robertkowalski I use rsync -v -n -c -u -r out/doc/ node@nodejs.org:~/web/nodejs.org/ to check what changes would be deployed after making changes to the API docs.

@misterdjules
Copy link

Instead of invoking a global node-doc-generator, would it be better to install it locally and update/install it every time the documentation is generated so that we don't run the risk of generating documentation with an outdated generator?

delete old checked in doc-tool. run `npm i -g node-doc-generator`
before building the docs.
@robertkowalski
Copy link
Contributor Author

good point.

i also created diffs of the content, the only change i could find is this one which is a wanted one, according to nodejs/node-v0.x-archive@6174ea6 which was applied after the code was copied from the main repo

77c77
< <li>I&#39;m still waiting for a fixed SSl Cert for <a href="https://blog.nodejs.org/">https://blog.nodejs.org/</a> to
---
> <li>I&apos;m still waiting for a fixed SSl Cert for <a href="https://blog.nodejs.org/">https://blog.nodejs.org/</a> to
90c90
< <p>Trevor: Yes, I&#39;m currently investigating.
---
> <p>Trevor: Yes, I&apos;m currently investigating.
97c97
< <p>TJ: We&#39;ll float the patch as it&#39;s pretty uncontroversial.
---
> <p>TJ: We&apos;ll float the patch as it&apos;s pretty uncontroversial.
127,128c127,128
< <p>Trevor: there&#39;s a case with some developers add-on where calling
< <code>MakeCallback</code> processes next tick callbacks. I&#39;m working on a fix that would
---
> <p>Trevor: there&apos;s a case with some developers add-on where calling
> <code>MakeCallback</code> processes next tick callbacks. I&apos;m working on a fix that would
137c137
< <p>Colin: abort on uncaught exception fix hasn&#39;t been forward ported to 0.12.0,
---
> <p>Colin: abort on uncaught exception fix hasn&apos;t been forward ported to 0.12.0,
141c141
< <p>Julien: There&#39;s an issue in the 0.12.1 milestone that tracks this. See
---
> <p>Julien: There&apos;s an issue in the 0.12.1 milestone that tracks this. See
172c172
< <p>TJ: what&#39;s the status on the bug with data customiser.
---
> <p>TJ: what&apos;s the status on the bug with data customiser.
189c189
< <p>Steven: It would be nice to know what&#39;s the focus on a release, so that we
---
> <p>Steven: It would be nice to know what&apos;s the focus on a release, so that we
212c212
< ABI issue, not sure if it&#39;s an actual issue or not. Would like to get more
---
> ABI issue, not sure if it&apos;s an actual issue or not. Would like to get more
221c221
< <p>TJ: also, probably doesn&#39;t affect a lot of packages since it affects only the
---
> <p>TJ: also, probably doesn&apos;t affect a lot of packages since it affects only the
237c237
< <p>TJ: we want to publish every meeting&#39;s minutes on the website.
---
> <p>TJ: we want to publish every meeting&apos;s minutes on the website.
252c252
< <p>TJ: Historically, we&#39;ve run them when building nightlies for instance. Some
---
> <p>TJ: Historically, we&apos;ve run them when building nightlies for instance. Some

@misterdjules
Copy link

@robertkowalski It's not clear what the lines in red and green represent. Which are the ones generated by the current doc-tool module and which are the ones currently deployed on nodejs.org?

Also, I don't understand what you mean by "according to nodejs/node-v0.x-archive@6174ea6 which was applied after the code was copied from the main repo". Could you please provide me with more details?

Thank you!

@robertkowalski
Copy link
Contributor Author

ok, let me try:

so this repo was once part of joyent/node. At one point, it got copied over, the code for generating the docs was duplicated into this repo. While time went on other folks changed the code in the joyent/node repo further, and there were also some changes to the doc generator in this repository. the new module is merging the changes again.

one change that got not pulled over into this repository is nodejs/node-v0.x-archive@6174ea6 which changed &apos to #39

when i now use scp to get /about from the production env and test the new doc generator which merges the latest joyent/node doc-tool with the doc-tool in this repo, and use

diff about/core-team/meetings//2015-02-19/minutes.html out/doc/about/core-team/meetings/2015-02-19/minutes.html

i get the diff i pasted.

@misterdjules
Copy link

@robertkowalski What's the reason for not pulling over nodejs/node-v0.x-archive@6174ea6?

@robertkowalski
Copy link
Contributor Author

sounds good, will do

robertkowalski referenced this pull request in robertkowalski/node-documentation-generator Jul 12, 2015
 - marked is a bundled dep as it got patched some years ago,
   this ensures our patched version is used, see
   nodejs/nodejs.org#84
 - add repo url to remove warning
 - remove superfluous optional-deps key
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants