Updates the "API Quick Start" to become a better landing for all API docs
- Uses new openstackdocstheme configured with the api_ref sidebar. - Updates intro text to ensure we get the same text as what was in the developer.openstack.org/api_ref.html landing page. - With these changes we should be able to completely remove and redirect developer.openstack.org/api_ref.html to http://developer.openstack.org/api-guide/quick-start/. Change-Id: I5ea811aac3b34774b9cdde6c0d788b12b97977bb
This commit is contained in:
parent
7db8843dee
commit
93daffe410
|
@ -1,11 +1,11 @@
|
||||||
[metadata]
|
[metadata]
|
||||||
name = OpenStack API Quick Start
|
name = OpenStack API Documentation
|
||||||
summary = OpenStack API Quick Start
|
summary = OpenStack API Documentation
|
||||||
description-file =
|
description-file =
|
||||||
README.rst
|
README.rst
|
||||||
author = OpenStack Documentation
|
author = OpenStack Documentation
|
||||||
author-email = openstack-docs@lists.openstack.org
|
author-email = openstack-docs@lists.openstack.org
|
||||||
home-page = http://docs.openstack.org/
|
home-page = http://developer.openstack.org/
|
||||||
classifier =
|
classifier =
|
||||||
Intended Audience :: Developers
|
Intended Audience :: Developers
|
||||||
License :: OSI Approved :: Apache Software License
|
License :: OSI Approved :: Apache Software License
|
||||||
|
|
|
@ -52,9 +52,9 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'API-Quick-Start'
|
project = u'Openstack-API-Documentation'
|
||||||
bug_tag = u'api-site'
|
bug_tag = u'api-site'
|
||||||
copyright = u'2015, OpenStack contributors'
|
copyright = u'2016, OpenStack contributors'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
@ -131,6 +131,14 @@ html_theme = 'openstackdocs'
|
||||||
# documentation.
|
# documentation.
|
||||||
# html_theme_options = {}
|
# html_theme_options = {}
|
||||||
|
|
||||||
|
# To use the API Reference sidebar dropdown menu,
|
||||||
|
# uncomment the html_theme_options parameter. The theme
|
||||||
|
# variable, sidebar_dropdown, should be set to `api_ref`.
|
||||||
|
# Otherwise, the list of links for the User and Ops docs
|
||||||
|
# appear in the sidebar dropdown menu.
|
||||||
|
html_theme_options = {"sidebar_dropdown": "api_ref",
|
||||||
|
"sidebar_mode": "toc"}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||||
|
|
||||||
|
@ -206,7 +214,7 @@ html_show_sourcelink = False
|
||||||
# html_file_suffix = None
|
# html_file_suffix = None
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'API-Quick-Start'
|
htmlhelp_basename = 'OpenStack-API-Documentation'
|
||||||
|
|
||||||
# If true, publish source files
|
# If true, publish source files
|
||||||
html_copy_source = False
|
html_copy_source = False
|
||||||
|
@ -228,7 +236,7 @@ latex_elements = {
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'FirstApp.tex', u'FirstApp Documentation',
|
('index', 'OpenStackAPI.tex', u'OpenStack API Documentation',
|
||||||
u'OpenStack Doc Team', 'manual'),
|
u'OpenStack Doc Team', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -258,7 +266,7 @@ latex_documents = [
|
||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
('index', 'api-quick-start', u'API Quick Start Documentation',
|
('index', 'openstack-api-documentation', u'OpenStack API Documentation',
|
||||||
[u'OpenStack Doc Team'], 1)
|
[u'OpenStack Doc Team'], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -272,8 +280,8 @@ man_pages = [
|
||||||
# (source start file, target name, title, author,
|
# (source start file, target name, title, author,
|
||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
('index', 'api-quick-start', u'API Quick Start Documentation',
|
('index', 'openstack-api-documentation', u'OpenStack API Documentation',
|
||||||
u'OpenStack Doc Team', 'APIQuickStart', 'Describes basic OpenStack API concepts.',
|
u'OpenStack Doc Team', 'OpenStackAPIDocs', 'Describes OpenStack API reference and concepts.',
|
||||||
'Miscellaneous'),
|
'Miscellaneous'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -298,6 +306,6 @@ locale_dirs = ['locale/']
|
||||||
# -- Options for PDF output --------------------------------------------------
|
# -- Options for PDF output --------------------------------------------------
|
||||||
|
|
||||||
pdf_documents = [
|
pdf_documents = [
|
||||||
('index', u'api-quick-start', u'API Quick Start Documentation',
|
('index', u'openstack-api-documentation', u'OpenStack API Documentation',
|
||||||
u'OpenStack contributors')
|
u'OpenStack contributors')
|
||||||
]
|
]
|
||||||
|
|
|
@ -1,13 +1,89 @@
|
||||||
===================
|
===========================
|
||||||
OpenStack API Guide
|
OpenStack API Documentation
|
||||||
===================
|
===========================
|
||||||
|
|
||||||
Although you install each OpenStack service separately, the OpenStack
|
Use the OpenStack APIs to launch server instances, create images, assign
|
||||||
services work together to meet your cloud needs: Identity, Compute,
|
metadata to instances and images, create storage containers and objects, and
|
||||||
Images, Block Storage, Networking (neutron), Object Storage, Databases, and
|
complete other actions in your OpenStack cloud.
|
||||||
Metering. With the `TryStack <http://www.trystack.org/>`__ OpenStack
|
|
||||||
|
Current API versions
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
`Bare Metal API v1 <http://developer.openstack.org/api-ref/baremetal/>`__ (microversions)
|
||||||
|
|
||||||
|
`Block Storage API v2 <http://developer.openstack.org/api-ref/block-storage/v2/>`__
|
||||||
|
|
||||||
|
`Clustering API v1 <http://developer.openstack.org/api-ref/clustering/>`__
|
||||||
|
|
||||||
|
`Compute API <http://developer.openstack.org/api-ref/compute/>`__ (microversions)
|
||||||
|
|
||||||
|
`Data Processing v1.1 <http://developer.openstack.org/api-ref/data-processing/>`__
|
||||||
|
|
||||||
|
`Database Service API v1.0 <http://developer.openstack.org/api-ref/database/>`__
|
||||||
|
|
||||||
|
`Domain Name Server (DNS) API v2 <http://developer.openstack.org/api-ref/dns/>`__
|
||||||
|
|
||||||
|
`Identity API v3 <http://developer.openstack.org/api-ref/identity/v3>`__
|
||||||
|
|
||||||
|
`Identity API v3 extensions <http://developer.openstack.org/api-ref/identity/v3-ext>`__
|
||||||
|
|
||||||
|
`Image service API v2 <http://developer.openstack.org/api-ref/image/v2>`__
|
||||||
|
|
||||||
|
`Networking API v2.0 <http://developer.openstack.org/api-ref/networking/v2>`__
|
||||||
|
|
||||||
|
`Object Storage API v1 <http://developer.openstack.org/api-ref/object-storage>`__
|
||||||
|
|
||||||
|
`Orchestration API v1 <http://developer.openstack.org/api-ref/orchestration/v1/>`__
|
||||||
|
|
||||||
|
`Shared File Systems API v2 <http://developer.openstack.org/api-ref/shared-file-systems>`__ (microversions)
|
||||||
|
|
||||||
|
.. note:: The Shared File Systems API v1 is functionally identical to the
|
||||||
|
Shared File Systems API v2. Subsequent API v2 microversions, such as v2.1,
|
||||||
|
differ from API v1.
|
||||||
|
|
||||||
|
Supported API versions
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
`Block Storage API v1 <http://developer.openstack.org/api-ref/block-storage/v1/>`__
|
||||||
|
|
||||||
|
`Image service API v1 <http://developer.openstack.org/api-ref/image/v1>`__
|
||||||
|
|
||||||
|
Deprecated API versions
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
`Identity API v2.0 <http://developer.openstack.org/api-ref/identity/v2>`__
|
||||||
|
|
||||||
|
`Identity admin API v2.0 <http://developer.openstack.org/api-ref/identity/v2-admin>`__
|
||||||
|
|
||||||
|
`Identity API v2.0 extensions <http://developer.openstack.org/api-ref/identity/v2-ext>`__
|
||||||
|
|
||||||
|
.. todo: telemetry link
|
||||||
|
|
||||||
|
The API status reflects the state of the endpoint on the service.
|
||||||
|
|
||||||
|
* Current indicates a stable version that is up-to-date, recent, and might
|
||||||
|
receive future versions. This endpoint should be prioritized over all
|
||||||
|
others.
|
||||||
|
* Supported is a stable version that is available on the server. However, it
|
||||||
|
is not likely the most recent available and might not be updated or might
|
||||||
|
be deprecated at some time in the future.
|
||||||
|
* Deprecated is a stable version that is still available but is being
|
||||||
|
deprecated and might be removed in the future.
|
||||||
|
* Experimental is not a stable version. This version is under development or
|
||||||
|
contains features that are otherwise subject to change. For more
|
||||||
|
information about API status values and version information, see
|
||||||
|
`Version Discovery <https://wiki.openstack.org/wiki/VersionDiscovery>`__.
|
||||||
|
* Microversions indicates that the API follows a `pattern established by
|
||||||
|
the Compute service <http://developer.openstack.org/api-guide/compute/microversions.html>`__ to
|
||||||
|
enable small, documented changes to the API on a resource-by-resource
|
||||||
|
basis.
|
||||||
|
|
||||||
|
API quick-start examples
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
With the `TryStack <http://www.trystack.org/>`__ OpenStack
|
||||||
installation, these services work together in the background of the
|
installation, these services work together in the background of the
|
||||||
installation.
|
installation, and many of these examples work on TryStack.
|
||||||
|
|
||||||
After you authenticate through Identity, you can use the other OpenStack
|
After you authenticate through Identity, you can use the other OpenStack
|
||||||
APIs to create and manage resources in your OpenStack cloud. You can
|
APIs to create and manage resources in your OpenStack cloud. You can
|
||||||
|
@ -46,11 +122,11 @@ To begin sending API requests, use one of the following methods:
|
||||||
SDK <http://docs.openstack.org/user-guide/sdk.html>`__ in the
|
SDK <http://docs.openstack.org/user-guide/sdk.html>`__ in the
|
||||||
*OpenStack End User Guide*.
|
*OpenStack End User Guide*.
|
||||||
|
|
||||||
Learn more
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
api-quick-start
|
api-quick-start
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -7,6 +7,6 @@ doc8 # Apache-2.0
|
||||||
Pygments
|
Pygments
|
||||||
# At least 1.3 is required for dedent in code blocks. Capped to 1.3 to not get an automatic update to any newer versions.
|
# At least 1.3 is required for dedent in code blocks. Capped to 1.3 to not get an automatic update to any newer versions.
|
||||||
sphinx>=1.3,!=1.3b1,<1.4
|
sphinx>=1.3,!=1.3b1,<1.4
|
||||||
openstackdocstheme>=1.4.0
|
openstackdocstheme>=1.5.0
|
||||||
nwdiag
|
nwdiag
|
||||||
sphinxcontrib-nwdiag
|
sphinxcontrib-nwdiag
|
||||||
|
|
Loading…
Reference in New Issue