doc: Rework README to reflect new doc URLs
We also take the opportunity to clean up the doc and add a few more helpful links. This is mostly based on the blueprint established by Glance [1]. [1] https://github.com/openstack/glance/blob/69555ae/README.rst Change-Id: I819fd2e6d49e00c2f9175dd5b0f4a1bc356d35e6 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
parent
3c5da51602
commit
6b6079f5e9
72
README.rst
72
README.rst
|
@ -10,61 +10,65 @@ Team and repository tags
|
||||||
OpenStack Nova
|
OpenStack Nova
|
||||||
==============
|
==============
|
||||||
|
|
||||||
OpenStack Nova provides a cloud computing fabric controller,
|
OpenStack Nova provides a cloud computing fabric controller, supporting a wide
|
||||||
supporting a wide variety of compute technologies, including:
|
variety of compute technologies, including: libvirt (KVM, Xen, LXC and more),
|
||||||
libvirt (KVM, Xen, LXC and more), Hyper-V, VMware, XenServer
|
Hyper-V, VMware, XenServer, OpenStack Ironic and PowerVM.
|
||||||
and OpenStack Ironic.
|
|
||||||
|
|
||||||
OpenStack Nova is distributed under the terms of the Apache
|
Use the following resources to learn more.
|
||||||
License, Version 2.0. The full terms and conditions of this
|
|
||||||
license are detailed in the LICENSE file.
|
|
||||||
|
|
||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
To learn how to use Nova's API, consult the documentation
|
To learn how to use Nova's API, consult the documentation available online at:
|
||||||
available online at:
|
|
||||||
|
|
||||||
https://developer.openstack.org/api-guide/compute/
|
- `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`__
|
||||||
https://developer.openstack.org/api-ref/compute/
|
- `Compute API Reference <https://developer.openstack.org/api-ref/compute/>`__
|
||||||
|
|
||||||
For more information on OpenStack APIs, SDKs and CLIs,
|
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
|
||||||
please see:
|
|
||||||
|
|
||||||
https://www.openstack.org/appdev/
|
- `OpenStack for App Developers <https://www.openstack.org/appdev/>`__
|
||||||
https://developer.openstack.org/
|
- `Development resources for OpenStack clouds
|
||||||
|
<https://developer.openstack.org/>`__
|
||||||
|
|
||||||
Operators
|
Operators
|
||||||
---------
|
---------
|
||||||
|
|
||||||
To learn how to deploy and configure OpenStack Nova, consult the
|
To learn how to deploy and configure OpenStack Nova, consult the documentation
|
||||||
documentation available online at:
|
available online at:
|
||||||
|
|
||||||
https://docs.openstack.org
|
- `OpenStack Nova <https://docs.openstack.org/nova/>`__
|
||||||
|
|
||||||
For information about the different compute (hypervisor) drivers
|
In the unfortunate event that bugs are discovered, they should be reported to
|
||||||
supported by Nova, please read:
|
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
|
||||||
https://docs.openstack.org/developer/nova/feature_classification.html
|
reporting problems. In all other cases use the master OpenStack bug tracker,
|
||||||
|
|
||||||
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:
|
available at:
|
||||||
|
|
||||||
https://bugs.launchpad.net/nova
|
- `Bug Tracker <https://bugs.launchpad.net/nova>`__
|
||||||
|
|
||||||
Developers
|
Developers
|
||||||
----------
|
----------
|
||||||
|
|
||||||
For information on how to contribute to Nova, please see the
|
For information on how to contribute to Nova, please see the contents of the
|
||||||
contents of the CONTRIBUTING.rst.
|
CONTRIBUTING.rst.
|
||||||
|
|
||||||
Any new code must follow the development guidelines detailed
|
Any new code must follow the development guidelines detailed in the HACKING.rst
|
||||||
in the HACKING.rst file, and pass all unit tests.
|
file, and pass all unit tests.
|
||||||
|
|
||||||
Further developer focused documentation is available at:
|
Further developer focused documentation is available at:
|
||||||
|
|
||||||
https://docs.openstack.org/developer/nova/
|
- `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/
|
||||||
|
|
Loading…
Reference in New Issue