Update Glance landing pages
Currently https://docs.openstack.org/glance/latest/ is a long unorganized list of documentation links. This patch revises that page and the 'Glance Contribution Guidelines' page to make it easier to locate content. Also updates the main heading on other index pages. Change-Id: Ieea44dd05f8d164ed4c27f1205fb29b6e66d9660
This commit is contained in:
Brian Rosmaita
parent
bbeb15d9c5
commit
b13987cd41
|
|
@ -1,6 +1,6 @@
|
|||
======================
|
||||
Administration guide
|
||||
======================
|
||||
===========================
|
||||
Glance Administration Guide
|
||||
===========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
========================
|
||||
Command Line Interface
|
||||
========================
|
||||
=======================
|
||||
Glance Utility Programs
|
||||
=======================
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
|
|
|||
|
|
@ -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 <http://wiki.openstack.org>`_.
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<http://developer.openstack.org/api-ref/image/v2/>`_ instead of version 1
|
||||
of the API. The Images API v1 will ultimately be removed, following the
|
||||
`OpenStack standard deprecation policy
|
||||
<https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html>`_.
|
||||
.. note:: The Images API v1, DEPRECATED in the Newton release, has been
|
||||
removed.
|
||||
|
|
|
|||
|
|
@ -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 <https://developer.openstack.org/api-ref/image/>`_
|
||||
* `Image Service API Guide <https://specs.openstack.org/openstack/glance-specs/specs/api/v2/image-api-v2.html>`_
|
||||
* :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
|
||||
|
|
|
|||
|
|
@ -14,9 +14,9 @@
|
|||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
==============
|
||||
Installation
|
||||
==============
|
||||
===================
|
||||
Glance Installation
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
============
|
||||
User guide
|
||||
============
|
||||
=================
|
||||
Glance User Guide
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
|
|||
Loading…
Reference in New Issue