summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2017-07-04 10:00:20 +0100
committerMatt Riedemann <mriedem.os@gmail.com>2017-08-03 16:06:08 -0400
commitcf52fc21ccce559c2b233b56f827d7bf061fb786 (patch)
treeb1391367f58709d51470f46d6636f5a2f713c40f /README.rst
parent7bc2ca1f28d502b9662e0c0e2c95c655dbfde529 (diff)
downloadnova-cf52fc21ccce559c2b233b56f827d7bf061fb786.tar.gz
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>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst72
1 files changed, 38 insertions, 34 deletions
diff --git a/README.rst b/README.rst
index 48455105c0..96dcb1cce0 100644
--- a/README.rst
+++ b/README.rst
@@ -10,61 +10,65 @@ Team and repository tags
OpenStack Nova
==============
-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, XenServer
-and OpenStack Ironic.
+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, XenServer, OpenStack Ironic and PowerVM.
-OpenStack Nova is distributed under the terms of the Apache
-License, Version 2.0. The full terms and conditions of this
-license are detailed in the LICENSE file.
+Use the following resources to learn more.
API
---
-To learn how to use Nova's API, consult the documentation
-available online at:
+To learn how to use Nova's API, consult the documentation available online at:
- https://developer.openstack.org/api-guide/compute/
- https://developer.openstack.org/api-ref/compute/
+- `Compute API Guide <https://developer.openstack.org/api-guide/compute/>`__
+- `Compute API Reference <https://developer.openstack.org/api-ref/compute/>`__
-For more information on OpenStack APIs, SDKs and CLIs,
-please see:
+For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
- https://www.openstack.org/appdev/
- https://developer.openstack.org/
+- `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:
-
- https://docs.openstack.org
-
-For information about the different compute (hypervisor) drivers
-supported by Nova, please read:
+To learn how to deploy and configure OpenStack Nova, consult the documentation
+available online at:
- https://docs.openstack.org/developer/nova/feature_classification.html
+- `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,
+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:
- https://bugs.launchpad.net/nova
+- `Bug Tracker <https://bugs.launchpad.net/nova>`__
Developers
----------
-For information on how to contribute to Nova, please see the
-contents of the CONTRIBUTING.rst.
+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.
+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:
- 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/