openstack/glance
Code Issues Proposed changes
glance/doc/source/contributor/index.rst
Doug Hellmann a2df410e76 fix the autodoc instructions 
Use autodoc_index_modules instead of autodoc_tree_index_modules so only
one copy of the API docs are generated.

Exclude the tests subpackage because it's not part of the Glance Python
API.

Exclude the glance.db.sqlalchemy subpackage to avoid issues caused when
parts of it cannot be imported during the doc build because they rely on
alembic setting up values that are not configured for a simple import.

Change-Id: I127b812bc879fc39533b39df1785d93835142430
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00

1.3 KiB
Raw Blame History

Glance Contribution Guidelines

In the Contributions Guide, you will find documented policies for developing with Glance. This includes the processes we use for blueprints and specs, bugs, contributor onboarding, core reviewer memberships, and other procedural items.

Glance, as with all OpenStack projects, is written with the following design guidelines in mind:

  • Component based architecture: Quickly add new behaviors
  • Highly available: Scale to very serious workloads
  • Fault tolerant: Isolated processes avoid cascading failures
  • Recoverable: Failures should be easy to diagnose, debug, and rectify
  • Open standards: Be a reference implementation for a community-driven api

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Glance and other components of OpenStack can be found on the OpenStack wiki.

Developer reference

architecture database_architecture database_migrations domain_model domain_implementation api/autoindex

Policies

blueprints documentation minor-code-changes refreshing-configs release-cpl