openstack/js-openstack-lib
Code Issues Proposed changes
Files
74b664e0591186ad9e394f87ce2ec4762d1524c4
js-openstack-lib/doc/source/specs.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

1.0 KiB
Raw Blame History

Design Specifications

Priority Specifications

This is a list of approved design specifications, which are considered high-priority for this project. It is very likely that work is already in progress, however contributions and reviews are always welcome.

Gerrit query for all changes related to priority efforts:

status:open AND project:openstack/js-openstack-lib

https://review.openstack.org/#/q/status:open+AND+project:openstack/js-openstack-lib,n,z

Approved Specifications

These are specifications that have been approved; work may or may not have started on these. Reviewers will review related changes as time permits.

Implemented Specifications

These specifications have already been implemented and are listed here for historical purposes.