From cf52fc21ccce559c2b233b56f827d7bf061fb786 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 4 Jul 2017 10:00:20 +0100 Subject: [PATCH] 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 --- README.rst | 72 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 38 insertions(+), 34 deletions(-) diff --git a/README.rst b/README.rst index 48455105c074..96dcb1cce0b4 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 `__ +- `Compute API Reference `__ -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 `__ +- `Development resources for OpenStack clouds + `__ Operators --------- -To learn how to deploy and configure OpenStack Nova, consult the -documentation available online at: +To learn how to deploy and configure OpenStack Nova, consult the documentation +available online at: - https://docs.openstack.org +- `OpenStack Nova `__ -For information about the different compute (hypervisor) drivers -supported by Nova, please read: - - https://docs.openstack.org/developer/nova/feature_classification.html - -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 `__ 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 `__ +- `Official Client Documentation + `__ + +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 `__ + +.. _Summit: https://www.openstack.org/summit/ +.. _Project Team Gathering: https://www.openstack.org/ptg/