openstack/nova
Code Issues Proposed changes

Refresh README and its docs links

Browse Source 
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
This commit is contained in:
John Garbutt 2016-08-08 10:14:49 +01:00
parent e99c366543
commit ddeb0e88c5
1 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.rst
View File

@ -1,33 +1,42 @@
OpenStack Nova README OpenStack Nova
===================== ==============
OpenStack Nova provides a cloud computing fabric controller, OpenStack Nova provides a cloud computing fabric controller,
supporting a wide variety of virtualization technologies, supporting a wide variety of compute technologies, including:
including KVM, Xen, LXC, VMware, and more. In addition to libvirt (KVM, Xen, LXC and more), Hyper-V, VMware, XenServer
its native API, it includes compatibility with the commonly and OpenStack Ironic.
encountered Amazon EC2 and S3 APIs.
OpenStack Nova is distributed under the terms of the Apache OpenStack Nova is distributed under the terms of the Apache
License, Version 2.0. The full terms and conditions of this License, Version 2.0. The full terms and conditions of this
license are detailed in the LICENSE file. license are detailed in the LICENSE file.
Nova primarily consists of a set of Python daemons, though API
it requires and integrates with a number of native system ---
components for databases, messaging and virtualization
capabilities.
To keep updated with new developments in the OpenStack project To learn how to use Nova's API, consult the documentation
follow `@openstack <http://twitter.com/openstack>`_ on Twitter.
To learn how to deploy OpenStack Nova, consult the documentation
available online at: 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 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 In the unfortunate event that bugs are discovered, they should
be reported to the appropriate bug tracker. If you obtained be reported to the appropriate bug tracker. If you obtained
@ -38,24 +47,15 @@ available at:
http://bugs.launchpad.net/nova http://bugs.launchpad.net/nova
Developers wishing to work on the OpenStack Nova project should Developers
always base their work on the latest Nova code, available from ----------
the master GIT repository at:
https://git.openstack.org/cgit/openstack/nova
Developers should also join the discussion on the mailing list,
at:
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
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/
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 CONTRIBUTING.rst file. contents of the CONTRIBUTING.rst.
-- End of broadcast 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/