Commit Graph

128 Commits

Author SHA1 Message Date
OpenDev Sysadmins 8212036536 OpenDev Migration Patch
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:49:54 +00:00
Andreas Jaeger f57ebca959 Retire js-generator-openstack
This repository is unused, retire it.

Change-Id: Ib6b55e118b7092a05dfe6bcbb6bcb66a8b20fdc2
Depends-On: https://review.openstack.org/597370/
2018-08-29 09:04:51 +02:00
Yujun Zhang c2cc0eac5d Update gitignore list
Change-Id: I9f49fd1926869a85179766f77213d2aaf6892bcb
2016-11-03 13:47:42 +08:00
Jenkins 1fab1e572e Merge "Add chrome browser in bindep" 2016-11-01 11:08:40 +00:00
Jenkins c6f4c28bf4 Merge "Bump yeoman-generator to elimate warning" 2016-11-01 11:08:35 +00:00
Yujun Zhang 4b55140d6d Include `build` in gitignore template
`doc/build` is the output directory of `npm run docs`

Change-Id: I9b43a0f3cfa3726b650c8a66c06eb395b232e50b
2016-10-21 16:56:47 +08:00
Yujun Zhang 6d418c7011 Add chrome browser in bindep
Chrome is required for testing. It would be good to manage it with
bindep as well as firefox and xvfb.

Change-Id: Ide439f58ebacd4441af9f14e5a26f29b306280cc
2016-10-21 14:54:00 +08:00
Yujun Zhang de7942072f Bump yeoman-generator to elimate warning
Change-Id: I89c8d863cc30eeebae6acdafa1700d500c5d9931
2016-10-20 15:14:22 +08:00
Jenkins c62f7cad76 Merge "Added jsdoc3 output to doc generation" 2016-09-07 12:14:41 +00:00
Yujun Zhang 5237010f0c Update eslint and eslint-config-openstack version
Change-Id: I86118cee2f3a147cdf91978c1f41b3c171545ec1
2016-08-24 10:17:17 +08:00
Michael Krotscheck 977c1c06dc Added jsdoc3 output to doc generation
This patch adds jsdoc3-generated documentation to our docs build.
It does so by using publicly available sphinx.rst templates, writing
them into a .gitignore'd folder in the docs directory, and providing
references to these autogenerated documents in our own site.

There are some notable bugs:
- jsdoc-sphinx templates do not honor @ignore and @private
- jsdoc-sphinx templates do not ignore private variables (listed under
  members at the bottom).
- jsdoc-sphinx templates add superfluous 'Children' section to the
  top as subsection navigation.

It would make quite a bit of sense for us to contribute to
jsdoc-sphinx so that the above mentioned bugs are resolved. However,
as some documentation is better than no documentation, right now this
is fine.

Change-Id: Ie7503f4874c8b4bbb4bb4926cddc578d59ce0613
2016-08-24 09:59:22 +08:00
Yujun Zhang 95bd3089bb Fix missing dependency
`oslosphinx` is required for `npm run docs`

Change-Id: Ifacdbd16b741218e4a338d6c1f88a8232de23da4
2016-08-23 16:48:42 +08:00
Jenkins 1b71c89bb8 Merge "Added python-sphinx to dependencies" 2016-08-18 00:22:48 +00:00
Jenkins e4450702d6 Merge "List system dependencies for running common tests" 2016-08-11 02:11:04 +00:00
Michael Krotscheck bc49889af8 Added python-sphinx to dependencies
This makes sure that python-sphinx, required to build our documentation,
is installed.

Change-Id: Icc0b6abdb640fa67ff3206812c729eac60c5f000
2016-08-09 12:16:32 -07:00
Andreas Jaeger 1ba670aea9 List system dependencies for running common tests
Add a bindep.txt file containing a cross-platform list
of dependencies needed for running included non-devstack tests.

This change is needed since the infra team will not install standard
packages in jobs anymore, projects should use other-requirements.txt
instead. The macros xvfb-install, firefox-install, chrome-install
which are used to run some jobs for this repository will be removed
soon.

This change is self-testing.

For bindep.txt see also
http://docs.openstack.org/infra/manual/drivers.html#package-requirements

[*] http://docs.openstack.org/infra/bindep/

Depends-On: I6d3491c1ee18c579c768ae931a5edb2b783a19a3
Change-Id: If053677bb48898cf56001e6648605b5420567417
2016-08-09 14:29:43 +02:00
Jenkins cd60c644b8 Merge "fix incorrect jsdoc comment section" 2016-07-27 17:00:12 +00:00
Jenkins c36d519ca4 Merge "Renamed doc command to docs." 2016-07-27 06:50:57 +00:00
Yujun Zhang e3a472cfad fix incorrect jsdoc comment section
Change-Id: I87fb4ab927110264a0c9890053df425d1fef9966
2016-07-27 14:25:35 +08:00
Jenkins bb0fe3608d Merge "add jsdoc to component/nsp" 2016-07-22 17:44:44 +00:00
Jenkins 7bb89284b7 Merge "add jsdoc to component/pkg" 2016-07-22 17:44:38 +00:00
Jenkins 292465d921 Merge "add jsdoc to component/structure" 2016-07-22 17:43:48 +00:00
Jenkins d335e609a2 Merge "add jsdoc to component/gerrit" 2016-07-22 17:39:29 +00:00
Jenkins 934e70c335 Merge "add jsdoc to component/gitignore" 2016-07-22 17:39:23 +00:00
Jenkins 8a7b536bb6 Merge "add jsdoc to component/license" 2016-07-22 17:39:17 +00:00
Jenkins 401be7650a Merge "add jsdoc to component/editorconfig" 2016-07-22 17:39:12 +00:00
Michael Krotscheck 1e071bfc45 Renamed doc command to docs.
This patch changes the `npm run doc` command to `npm run docs`.
I'm doing this because throughout infra, most of the job names use
'docs' as a short for 'documentation', and it's useful to remain
consistent.

Change-Id: I713ab3a076f97db92f4227b27486ec565c81ef83
2016-07-22 07:25:26 -07:00
Yujun Zhang c05ee31b8c add jsdoc to component/editorconfig
Change-Id: Ic96a921c574719218c073ecd3d9ee1c829ca5a6f
2016-07-22 11:21:01 +08:00
Yujun Zhang dc83664603 add jsdoc to component/license
Change-Id: Ic489aa50f806e1a14630d4948bc9b3a6b346d8b5
2016-07-22 11:19:44 +08:00
Yujun Zhang a747ec2722 add jsdoc to component/gitignore
Change-Id: I62f50ca36b411ac7fb22334e77d6a7b75c5c1ddd
2016-07-22 11:19:02 +08:00
Yujun Zhang 5f020788d6 add jsdoc to component/gerrit
Change-Id: I9e82cfa3522bd77213fc5521ce504eeed2215c79
2016-07-22 11:18:12 +08:00
Yujun Zhang 7b7f0c7bcc add jsdoc to component/eslint and normalize function names
- remove Eslint from function names since it is redudant in module
- rename `eslintrc` to `rcContent` to keep consistent with `rcFile`

Change-Id: I616e551fc5752e6d61d96f91da556825071d4316
2016-07-22 11:17:19 +08:00
Yujun Zhang f297e2cb39 add jsdoc to component/structure
Change-Id: I4ade632a1a6abc17780d885e971dbfbf14eabb64
2016-07-22 11:13:05 +08:00
Yujun Zhang cab1fcfa3e add jsdoc to component/pkg
Change-Id: Ieaa41958478e1c15e46d93d982a93cf42d4b4f78
2016-07-22 11:11:18 +08:00
Yujun Zhang e3bbe6840a add jsdoc to component/nsp
Change-Id: I339b519db3f61b0d44d83c69316ee673fa0e7c46
2016-07-22 11:08:46 +08:00
Jenkins 57029cdeb1 Merge "add jsdoc for project_builder" 2016-07-22 01:08:25 +00:00
Jenkins 125b775116 Merge "add jsdoc for global_dependencies" 2016-07-22 01:08:20 +00:00
Jenkins 70c4d12527 Merge "exclude build output from istanbul" 2016-07-22 01:07:00 +00:00
Yujun Zhang 8a5eff7b66 add jsdoc for project_builder
inner function names are renamed to keep consistency with export names

Change-Id: I9d121b0c440a9dd1d0c0037dca9298ba1dd156c0
2016-07-21 15:34:07 +00:00
Yujun Zhang f29944ba29 add jsdoc for global_dependencies
inner function names are renamed to keep consistency with exported names

Change-Id: I2f03d160f19ef57dc99d1aff9d1422ca983fb459
2016-07-20 10:19:51 +08:00
Yujun Zhang 559c173567 exclude build output from istanbul
Change-Id: If158b55dba641a8cd41d1d653f986751f8ed949b
2016-07-20 10:04:06 +08:00
Yujun Zhang df050e8b3d rename inner function name to keep consistency with exported name
Change-Id: I59313d296758c505ed6256abe99716d6dee48258
2016-07-20 09:59:09 +08:00
Yujun Zhang df6ee674df add jsdoc comments for pkg_builder
Change-Id: I145adb7638435aa7a2c720848a3af1dd82f0b18e
2016-07-15 10:00:39 +08:00
Yujun Zhang 9a13358061 limit jsdoc to generators/app/lib
> If the module name is not provided, it is derived from the module's path and filename.
So we'd better keep the path short but clear enough.
See: http://usejsdoc.org/tags-module.html

Change-Id: Id1a6069ddb82863e91adff14cec97299ab4a867f
2016-07-15 09:56:09 +08:00
Yujun Zhang 54fed59885 add jsdoc3 build commands
run `npm run jsdoc` to generate api documentation in `jsdoc_build`

Change-Id: Ica8202a10b1d2c2a35453637f600501a71e412b7
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-07-14 17:04:43 +08:00
Yujun Zhang 5c9e5bbeaf Remove IIFE in all scripts
It is not required by node.js, but introduce troubles while
generating documents with jsdoc3.

Refer to https://github.com/jsdoc3/jsdoc/issues/456

Change-Id: I6664f1be0fc3e86f3a7e3843d557786c37df1c5e
2016-07-05 16:38:35 +08:00
Yujun Zhang 9a7e0c3a6e Upgrade eslint version to version 2
version 2 has been released for a long time and stable to be used in prodution

Change-Id: I69219900b4de55aebe5cfa76a5777086ccf49c69
2016-07-04 17:22:54 +08:00
Michael Krotscheck bb0a83f300 Added Sphinx-based documentation framework and specs repo.
All of ospenstack's documentation infrastructure is run via sphinx, including
templates, html parsing, uploading, and more. Thus it behooves us to keep
our javascript documentation build as similar as possible. Since we want to
avoid using tox, and littering the project with pythonic artifacts, we're
instead using Sphinx' own recommended build method: A Makefile.

This patch adds a small but complete documentation tree for this project,
including the build tools needed to create it. It satisfies the need for
narrative documentation, but does not (yet) satisfy the need for code
doc generation. It also includes a section for specifications, as this
effort is not yet large enough to warrant its own specification repo.

Code documentation will need to be added in a subsequent patch, using
Sphinx' jsdoc plugins.

Change-Id: I95afbc7001643a3564961c3b5326df4b35c29be8
2016-06-17 12:58:42 -07:00
Yujun Zhang 601a1c21b9 Add default test harness for nodejs projects
story/2000598

Change-Id: I180f887f29bd378992c1c4678832b47e4e2e497f
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-06-15 22:21:18 +08:00
Michael Krotscheck 60a853aa3c Added copyright header.
I didn't add these headers when I initially implemented this
generator.

Change-Id: I852e4e667e3ff14e9dda2e770b30759fdcecca75
2016-06-15 05:33:31 -07:00