diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 24656e0499..d9d4504350 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -1,6 +1,6 @@ -====================== - Administration guide -====================== +=========================== +Glance Administration Guide +=========================== .. toctree:: :maxdepth: 2 diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 66065a6e56..ab6ad55266 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -1,6 +1,6 @@ -======================== - Command Line Interface -======================== +======================= +Glance Utility Programs +======================= .. toctree:: :glob: diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index fab5da5828..2445293cae 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -6,20 +6,33 @@ developing with Glance. This includes the processes we use for blueprints and specs, bugs, contributor onboarding, core reviewer memberships, and other procedural items. -Glance, as with all OpenStack projects, is written with the following design -guidelines in mind: - -* **Component based architecture**: Quickly add new behaviors -* **Highly available**: Scale to very serious workloads -* **Fault tolerant**: Isolated processes avoid cascading failures -* **Recoverable**: Failures should be easy to diagnose, debug, and rectify -* **Open standards**: Be a reference implementation for a community-driven api - This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Glance and other components of OpenStack can be found on the `OpenStack wiki `_. -Developer reference +Development Policies +-------------------- + +.. toctree:: + :maxdepth: 2 + + minor-code-changes + refreshing-configs + +Development Practices +--------------------- +.. toctree:: + :maxdepth: 3 + + blueprints + documentation + database_migrations +.. bugs + contributor-onboarding + gate-failure-triage + code-reviews + +Developer Reference ------------------- .. toctree:: @@ -27,7 +40,6 @@ Developer reference architecture database_architecture - database_migrations domain_model domain_implementation .. toctree:: @@ -35,18 +47,11 @@ Developer reference modules -Policies --------- -.. toctree:: - :maxdepth: 3 +Development Roles +----------------- + +.. toctree:: + :maxdepth: 2 - blueprints - documentation - minor-code-changes - refreshing-configs release-cpl -.. bugs - contributor-onboarding - core-reviewers - gate-failure-triage - code-reviews +.. core-reviewers diff --git a/doc/source/deprecation-note.inc b/doc/source/deprecation-note.inc index c3fe751a26..9152cc5dc7 100644 --- a/doc/source/deprecation-note.inc +++ b/doc/source/deprecation-note.inc @@ -1,6 +1,2 @@ -.. note:: The Images API v1 has been DEPRECATED in the Newton release. The - migration path is to use the `Images API v2 - `_ instead of version 1 - of the API. The Images API v1 will ultimately be removed, following the - `OpenStack standard deprecation policy - `_. +.. note:: The Images API v1, DEPRECATED in the Newton release, has been + removed. diff --git a/doc/source/index.rst b/doc/source/index.rst index 22ca7f8dbc..12593e5afd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,9 @@ Welcome to Glance's documentation! ================================== +About Glance +============ + The Image service (glance) project provides a service where users can upload and discover data assets that are meant to be used with other services. This currently includes images and metadata definitions. @@ -32,17 +35,53 @@ VM images made available through Glance can be stored in a variety of locations from simple filesystems to object-storage systems like the OpenStack Swift project. -.. toctree:: - :maxdepth: 2 +Glance, as with all OpenStack projects, is written with the following design +guidelines in mind: - user/index +* **Component based architecture**: Quickly add new behaviors +* **Highly available**: Scale to very serious workloads +* **Fault tolerant**: Isolated processes avoid cascading failures +* **Recoverable**: Failures should be easy to diagnose, debug, and rectify +* **Open standards**: Be a reference implementation for a community-driven api + +Glance Documentation +==================== + +The Glance Project Team has put together the following documentation for you. +Pick the documents that best match your user profile. + +.. list-table:: + :header-rows: 1 + + * - User Profile + - Links + * - | **Contributor** + | You want to contribute code, documentation, reviews, or + ideas to the Glance Project. + - * :doc:`contributor/index` + * - | **Administrator** + | You want to administer and maintain a Glance installation. + - * :doc:`admin/index` + * :doc:`cli/index` + * - | **Operator** + | You want to install and configure Glance for your cloud. + - * :doc:`install/index` + * :doc:`configuration/index` + * - | **End User** or **Third-party Developer** + | You want to use the Image Service APIs provided by Glance. + - * `Image Service API Reference `_ + * `Image Service API Guide `_ + * :doc:`user/index` + * - **Everyone** + - Here's a handy :doc:`glossary` of terms related to Glance + +.. toctree:: + :hidden: + + contributor/index admin/index + cli/index install/index configuration/index - cli/index - contributor/index - -.. toctree:: - :maxdepth: 1 - + user/index glossary diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index dabb61c77e..f131b9602b 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -14,9 +14,9 @@ License for the specific language governing permissions and limitations under the License. -============== - Installation -============== +=================== +Glance Installation +=================== .. toctree:: diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index f798f14538..a8c186d26e 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -1,6 +1,6 @@ -============ - User guide -============ +================= +Glance User Guide +================= .. toctree:: :maxdepth: 2