Stephen Finucane
1d60cd7e05
We want to remove a level of indirection. Preserve the useful things here, specifically, the docstrings. This was managed using the following script: >>> from nova.db import api as api_a >>> from nova.db.sqlalchemy import api as api_b >>> from inspect import getmembers, isfunction >>> members_a = dict(getmembers(api_a, isfunction)) >>> members_b = dict(getmembers(api_b, isfunction)) >>> mismatch_members = [] >>> for member in members_a: ... if member in members_b: ... doc_a = members_a[member].__doc__ ... doc_a = doc_a.strip() if doc_a else doc_a ... doc_b = members_b[member].__doc__ ... doc_b = doc_b.strip() if doc_b else doc_b ... if doc_a and doc_a != doc_b: ... mismatch_members.append(member) >>> for member in mismatch_members: ... print(member) The docstrings are still missing a lot of information about parameters, but that can be addressed another time/never. Change-Id: I9f414cf831316b624132d9e06192f1ecbbd3dd78 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
==============
OpenStack Nova
==============
.. image:: https://governance.openstack.org/tc/badges/nova.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
OpenStack Nova provides a cloud computing fabric controller, supporting a wide
variety of compute technologies, including: libvirt (KVM, Xen, LXC and more),
Hyper-V, VMware, OpenStack Ironic and PowerVM.
Use the following resources to learn more.
API
---
To learn how to use Nova's API, consult the documentation available online at:
- `Compute API Guide <https://docs.openstack.org/api-guide/compute/>`__
- `Compute API Reference <https://docs.openstack.org/api-ref/compute/>`__
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
- `OpenStack for App Developers <https://www.openstack.org/appdev/>`__
- `Development resources for OpenStack clouds
<https://developer.openstack.org/>`__
Operators
---------
To learn how to deploy and configure OpenStack Nova, consult the documentation
available online at:
- `OpenStack Nova <https://docs.openstack.org/nova/>`__
In the unfortunate event that bugs are discovered, they should be reported to
the appropriate bug tracker. If you obtained the software from a 3rd party
operating system vendor, it is often wise to use their own bug tracker for
reporting problems. In all other cases use the master OpenStack bug tracker,
available at:
- `Bug Tracker <https://bugs.launchpad.net/nova>`__
Developers
----------
For information on how to contribute to Nova, please see the contents of the
CONTRIBUTING.rst.
Any new code must follow the development guidelines detailed in the HACKING.rst
file, and pass all unit tests.
Further developer focused documentation is available at:
- `Official Nova Documentation <https://docs.openstack.org/nova/>`__
- `Official Client Documentation
<https://docs.openstack.org/python-novaclient/>`__
Other Information
-----------------
During each `Summit`_ and `Project Team Gathering`_, we agree on what the whole
community wants to focus on for the upcoming release. The plans for nova can
be found at:
- `Nova Specs <http://specs.openstack.org/openstack/nova-specs/>`__
.. _Summit: https://www.openstack.org/summit/
.. _Project Team Gathering: https://www.openstack.org/ptg/