Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated docs have different node_modules #106

Closed
justinsb opened this issue Jul 21, 2017 · 5 comments
Closed

Generated docs have different node_modules #106

justinsb opened this issue Jul 21, 2017 · 5 comments

Comments

@justinsb
Copy link

justinsb commented Jul 21, 2017

I mentioned this in kops, but it's probably better to track it here.

After generating the API docs, there are some changes in the node_modules.

        modified:   docs/apireference/build/node_modules/ejs/Jakefile
        modified:   docs/apireference/build/node_modules/ejs/README.md
        modified:   docs/apireference/build/node_modules/ejs/ejs.js
        modified:   docs/apireference/build/node_modules/ejs/ejs.min.js
        modified:   docs/apireference/build/node_modules/ejs/lib/ejs.js
        modified:   docs/apireference/build/node_modules/ejs/lib/utils.js
        modified:   docs/apireference/build/node_modules/ejs/package.json
        modified:   docs/apireference/build/node_modules/ejs/test/ejs.js
        modified:   docs/apireference/build/node_modules/highlight.js/docs/css-classes-reference.rst
        modified:   docs/apireference/build/node_modules/highlight.js/lib/highlight.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/index.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/cpp.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/gauss.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/kotlin.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/lua.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/python.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/rust.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/scheme.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/typescript.js
        modified:   docs/apireference/build/node_modules/highlight.js/lib/languages/yaml.js
        modified:   docs/apireference/build/node_modules/highlight.js/package.json
        modified:   docs/apireference/build/node_modules/jquery/AUTHORS.txt
        modified:   docs/apireference/build/node_modules/jquery/LICENSE.txt
        modified:   docs/apireference/build/node_modules/jquery/README.md
        modified:   docs/apireference/build/node_modules/jquery/dist/core.js
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.js
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.min.js
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.min.map
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.slim.js
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.slim.min.js
        modified:   docs/apireference/build/node_modules/jquery/dist/jquery.slim.min.map
        modified:   docs/apireference/build/node_modules/jquery/package.json
        modified:   docs/apireference/build/node_modules/jquery/src/.eslintrc.json
        modified:   docs/apireference/build/node_modules/jquery/src/attributes/attr.js
        modified:   docs/apireference/build/node_modules/jquery/src/attributes/val.js
        modified:   docs/apireference/build/node_modules/jquery/src/callbacks.js
        modified:   docs/apireference/build/node_modules/jquery/src/core.js
        modified:   docs/apireference/build/node_modules/jquery/src/core/init.js
        modified:   docs/apireference/build/node_modules/jquery/src/core/ready-no-deferred.js
        modified:   docs/apireference/build/node_modules/jquery/src/core/ready.js
        modified:   docs/apireference/build/node_modules/jquery/src/css.js
        modified:   docs/apireference/build/node_modules/jquery/src/css/curCSS.js
        modified:   docs/apireference/build/node_modules/jquery/src/data/Data.js
        modified:   docs/apireference/build/node_modules/jquery/src/deferred.js
        modified:   docs/apireference/build/node_modules/jquery/src/deprecated.js
        modified:   docs/apireference/build/node_modules/jquery/src/effects.js
        modified:   docs/apireference/build/node_modules/jquery/src/event.js
        modified:   docs/apireference/build/node_modules/jquery/src/manipulation.js
        modified:   docs/apireference/build/node_modules/jquery/src/manipulation/getAll.js
        modified:   docs/apireference/build/node_modules/jquery/src/offset.js
        modified:   docs/apireference/build/node_modules/jquery/src/queue.js
        modified:   docs/apireference/build/node_modules/jquery/src/serialize.js
        modified:   docs/apireference/build/node_modules/jquery/src/traversing.js

It just looks like different versions - I have older versions than the docs you generated:

ejs:

...
-  "version": "2.5.6"
+  "version": "2.5.5"

highlightjs:

...
-  "version": "9.10.0"
+  "version": "9.9.0"

jquery:

...
-  "version": "3.2.1"
+  "version": "3.1.1"
@justinsb justinsb changed the title Generated docs change Generated docs have different node_modules Jul 21, 2017
@justinsb
Copy link
Author

One possible thing I'm looking into, is that this was also in jquery:

-  "_nodeVersion": "7.7.3",
+  "_nodeVersion": "6.6.0",

Going to try updating my nodejs; I have

>node --version
v6.9.2

@justinsb
Copy link
Author

(Updating nodejs didn't fix it)

Another theory: the pwittrock brodocs fork has a different package.json than upstream:

https://github.com/Birdrock/brodocs/blob/master/package.json
https://github.com/pwittrock/brodocs/blob/master/package.json

kops seems to have the upstream one: https://github.com/kubernetes/kops/blob/master/docs/apireference/build/package.json

Looking at package.json though, I think both version sets are valid choices (?)

@pwittrock
Copy link
Contributor

@justinsb I probably need to rebuild the brodocs docker container I use.

How were you using brodocs? Was it through my docker container, or using the framework directly?

@pwittrock
Copy link
Contributor

@justinsb Both should be valid choices. apiserver-builder uses a docker container / image to run brodocs. I just upgraded the container so it should be at the most recent version.

@pwittrock
Copy link
Contributor

Closing, let me know if this is still true.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants