From d3e820724e1d578003b13e72e753d9b1d75173e1 Mon Sep 17 00:00:00 2001 From: Li Wei Date: Mon, 5 Sep 2016 17:07:58 +0800 Subject: [PATCH] Add more resource url in readme.rst Adding readme.rst information for developers and operators to better learning and development. A lot of information is copied from the new Nova README file. Also updated the description of Glance to be consistent with the current mission statement. Change-Id: I77583203ed88fec8ec598aa9f979502c094fc596 --- README.rst | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 406a999b52..7a0f331a49 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,56 @@ Glance ====== -Glance is a project that defines services for discovering, registering, -retrieving and storing virtual machine images. +Glance is a project that provides services and associated libraries +to store, browse, share, distribute and manage bootable disk images, +other data closely associated with initializing compute resources, +and metadata definitions. Use the following resources to learn more: +API +--- + +To learn how to use Glance's API, consult the documentation available +online at: + +* `Image Service APIs `_ + +Developers +---------- + +For information on how to contribute to Glance, please see the contents +of the CONTRIBUTING.rst in this repository. + +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: + * `Official Glance documentation `_ * `Official Client documentation `_ + +Operators +--------- + +To learn how to deploy and configure OpenStack Glance, consult the +documentation available online at: + +* `Openstack Glance `_ + +In the unfortunate event that bugs are discovered, they should be +reported to the appropriate bug tracker. You can raise bugs here: + +* `Bug Tracker `_ + +Other Information +----------------- + +During each design summit, we agree on what the whole community wants +to focus on for the upcoming release. You can see image service plans: + +* `Image Service Plans `_ + +For more information about the Glance project please see: + +* `Glance Project `_