openstack/js-openstack-lib
Code Issues Proposed changes
Files
b033ad652e35d71e7baf3dd1238991e067d2ec2c
js-openstack-lib/doc/source/dev_get_started.rst
Michael Krotscheck 4c80eab9e7 Added Sphinx-based documentation framework and specs repo. 
All of openstack'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: I40eab962d4e4c6eafd1b1499bb00e6af5d72ede0
2016-06-23 06:55:17 -07:00

618 B
Raw Blame History

Contributing to js-openstack-lib

If you would like to contribute to the development of OpenStack, you must follow the steps in this page:

http://docs.openstack.org/infra/manual/developers.html

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

More TBD.