From 53f752a6693e81535a62bc582af8a10e7c438783 Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Tue, 8 Aug 2017 08:38:23 -0400 Subject: [PATCH] Create For End Users index section This reorganizes the pieces that are for end users into a convenient chunk up front in the main index page. Part of bp: doc-migration Change-Id: Ic2fcabbf3faa531fccb19cffa2564f005142e463 --- doc/source/index.rst | 59 +++++++++++++++++++++++++++----------------- 1 file changed, 37 insertions(+), 22 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index e8be6668e761..056c2bb4dede 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -38,33 +38,48 @@ decisions we have made in order to support that scope. We also document our plans for evolving our architecture over time. Finally, we documented our current development process and policies. -Compute API References -====================== +For End Users +============= -The Nova compute API is quite large, we provide a concept guide which -gives some of the high level details, as well as a more detailed API -reference. +As an end user of nova, you'll use nova to create and manage servers with +either tools or the API directly. -The API reference covers all versions of the API. Version 2.0 and -Version 2.1 are actually the same API, and Version 2.1 evolves forward -with microversions. The API ref starts with the base API version, and -specifies all changes that exist to it as microversions roll -forward. You can also see a history of our microversions here: +Tools for using Nova +-------------------- -.. toctree:: - :maxdepth: 1 +* `Horizon + `_: The + official web ui for the OpenStack Project. +* `OpenStack Client + `_: The official + CLI for OpenStack Projects. You should use this as your CLI for most things, + it includes not just nova commands but also commands for most of the projects + in OpenStack. +* `Nova Client + `_: For + some very advanced features (or administrative commands) of nova you may need + to use nova client. It is still supported, but the ``openstack`` cli is + recommended. - reference/api-microversion-history +Writing to the API +------------------ -.. note:: - Only Version 2.1 APIs should be used from this point forward, Version 2.0 - APIs are only provided for backward compatibility purposes. +All end user (and some administrative) features of nova are exposed via a REST +API, which can be used to build more complicated logic or automation with +nova. This can be consumed directly, or via various SDKs. The following +resources will help you get started with consuming the API directly. -.. _`Compute API Guide`: http://developer.openstack.org/api-guide/compute/ -.. _`Compute API Reference`: http://developer.openstack.org/api-ref/compute/ - -There was a session on the v2.1 API at the Liberty summit which you can watch -`here `_. +* `Compute API Guide: `_: The + concept guide for the API. This helps lay out the concepts behind the API to + make consuming the API reference easier. +* `Compute API Reference `_: + The complete reference for the API, including all methods and request / + response parameters and their meaning. +* `API Microversion History `_: The + compute API evolves over time through `Microversions + `_. This + provides the history of all those changes. Consider it a "what's new" in the + compute API. Feature Status @@ -200,6 +215,7 @@ Man Pages contributor/process contributor/project-scope user/cells + reference/api-microversion-history.rst reference/gmr reference/i18n reference/notifications @@ -210,7 +226,6 @@ Man Pages reference/stable-api reference/threading reference/vm-states - reference/i18n Installation Guide ==================