opendev/storyboard

Go to file

Ruslan Kamaldinov fff51b88cc Added documentation for REST API layer.

The goal of this patch is to setup infrastructure and organization
of docs in the project.

Changes:
* Added documentation for REST objects along with examples
* Added documentation for REST endpoints
* Added auto-generation of REST API docs

Note(1):
New API endpoint will not be auto-added to the docs. It is responibility
of committer to add new endpoint to the docs.

Note(2):
Usage examples still need to be added manually.

Change-Id: I080a6daba2fdb8a1a6a18087c7b3929da5b4bf1a

2014-01-28 16:42:51 +04:00

Added documentation for REST API layer.

2014-01-28 16:42:51 +04:00

Add a sample config file

2014-01-23 16:09:22 +04:00

Added documentation for REST API layer.

2014-01-28 16:42:51 +04:00

.gitignore

Add a sample config file

2014-01-23 16:09:22 +04:00

.gitreview

Add .gitreview file.

2013-07-18 12:03:46 +02:00

.testr.conf

API tests for rest

2014-01-23 17:23:58 +04:00

babel.cfg

Add SQLalchemy database model

2014-01-13 18:52:47 +04:00

CONTRIBUTING.rst

Update documentation

2014-01-27 18:54:18 +04:00

LICENSE

Initial import

2013-07-01 18:09:56 +02:00

manage.py

Initial import

2013-07-01 18:09:56 +02:00

MANIFEST.in

Introducing basic REST API

2014-01-22 11:37:54 -08:00

openstack-common.conf

Introducing basic REST API

2014-01-22 11:37:54 -08:00

README.rst

Update documentation

2014-01-27 18:54:18 +04:00

requirements.txt

Introducing basic REST API

2014-01-22 11:37:54 -08:00

setup.cfg

Don't try to install file that doesn't exist

2014-01-27 08:26:26 -08:00

setup.py

Update setup code past d2to1

2013-09-25 12:06:40 -04:00

test-requirements.txt

Add tests for Alembic migrations

2014-01-22 10:54:32 -08:00

tox.ini

API tests for rest

2014-01-23 17:23:58 +04:00

README.rst

Storyboard

Storyboard is a task tracker for OpenStack.

Project Resources

Project status, bugs, and blueprints are tracked at:

http://storyboard.openstack.org

Source code can be found at:

https://git.openstack.org/cgit/openstack-infra/storyboard/

Documentation can be found here:

http://ci.openstack.org/storyboard/

Additional resources are linked from the project wiki page:

https://wiki.openstack.org/wiki/StoryBoard

Anyone wishing to contribute to an OpenStack project should find plenty of helpful resources here:

https://wiki.openstack.org/wiki/HowToContribute

All OpenStack projects use Gerrit for code reviews. A good reference for that is here:

https://wiki.openstack.org/wiki/GerritWorkflow