summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorJohn Garbutt <john.garbutt@rackspace.com>2016-08-08 10:14:49 +0100
committerJohn Garbutt <john.garbutt@rackspace.com>2016-08-08 10:26:08 +0100
commitddeb0e88c50a910c3ab4aab257af19e1ba080501 (patch)
treebac86afde26bca32d8c9dd4173dbbb4897c73430 /README.rst
parente99c3665431462fc32877b71ba876da81cb61f3a (diff)
downloadnova-ddeb0e88c50a910c3ab4aab257af19e1ba080501.tar.gz
Refresh README and its docs links
The current README still mentions EC2 and over-duplicates information that now lives in other files, like CONTRIBUTING.rst. This patch re-focused the README on three key groups of folks: * API users * Operators * Developers Change-Id: I9df445ca0c800f0985900dcb00466c15e8d5570f
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst66
1 files changed, 33 insertions, 33 deletions
diff --git a/README.rst b/README.rst
index 317ab1e00a..b74a3d9f2b 100644
--- a/README.rst
+++ b/README.rst
@@ -1,33 +1,42 @@
-OpenStack Nova README
-=====================
+OpenStack Nova
+==============
OpenStack Nova provides a cloud computing fabric controller,
-supporting a wide variety of virtualization technologies,
-including KVM, Xen, LXC, VMware, and more. In addition to
-its native API, it includes compatibility with the commonly
-encountered Amazon EC2 and S3 APIs.
+supporting a wide variety of compute technologies, including:
+libvirt (KVM, Xen, LXC and more), Hyper-V, VMware, XenServer
+and OpenStack Ironic.
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.
-Nova primarily consists of a set of Python daemons, though
-it requires and integrates with a number of native system
-components for databases, messaging and virtualization
-capabilities.
+API
+---
-To keep updated with new developments in the OpenStack project
-follow `@openstack <http://twitter.com/openstack>`_ on Twitter.
-
-To learn how to deploy OpenStack Nova, consult the documentation
+To learn how to use Nova's API, consult the documentation
available online at:
- http://docs.openstack.org
+ http://developer.openstack.org/api-guide/compute/
+ http://developer.openstack.org/api-ref/compute/
+
+For more information on OpenStack APIs, SDKs and CLIs,
+please see:
+
+ http://www.openstack.org/appdev/
+ http://developer.openstack.org/
+
+Operators
+---------
+
+To learn how to deploy and configure OpenStack Nova, consult the
+documentation available online at:
+
+ http://docs.openstack.org
For information about the different compute (hypervisor) drivers
-supported by Nova, read this page on the wiki:
+supported by Nova, please read:
- https://wiki.openstack.org/wiki/HypervisorSupportMatrix
+ http://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
@@ -38,24 +47,15 @@ available at:
http://bugs.launchpad.net/nova
-Developers wishing to work on the OpenStack Nova project should
-always base their work on the latest Nova code, available from
-the master GIT repository at:
-
- https://git.openstack.org/cgit/openstack/nova
+Developers
+----------
-Developers should also join the discussion on the mailing list,
-at:
-
- http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
+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:
-
- http://docs.openstack.org/developer/nova/
+in the HACKING.rst file, and pass all unit tests.
-For information on how to contribute to Nova, please see the
-contents of the CONTRIBUTING.rst file.
+Further developer focused documentation is available at:
--- End of broadcast
+ http://docs.openstack.org/developer/nova/