From e356395605e7642b22eb37134e20c353cc1abdaf Mon Sep 17 00:00:00 2001 From: Joseph Robinson Date: Fri, 30 May 2014 12:55:32 +1000 Subject: [PATCH] Edited Installation Guide Client Overview Clarified the sentences with minor content additions. Added punctuation, and reduced repetition to add clarity. Changed Case. Change-Id: I30dbfef463dc51f2b12ed63a0420b5365cfe9494 backport: none Implements: blueprint installation-guide-improvements --- doc/common/section_cli_overview.xml | 41 +++++++++++++++++------------ 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/doc/common/section_cli_overview.xml b/doc/common/section_cli_overview.xml index 5700cdd944..1b415d5477 100644 --- a/doc/common/section_cli_overview.xml +++ b/doc/common/section_cli_overview.xml @@ -5,23 +5,30 @@ version="5.0" xml:id="section_cli_overview"> Overview - You can use the OpenStack command-line clients to run simple commands - that make API calls. You can run these commands from the command line or - in scripts to automate tasks. If you provide OpenStack credentials, you - can run these commands on any computer. - Internally, each client command runs cURL commands that - embed API requests. The OpenStack APIs are RESTful APIs that - use the HTTP protocol, including methods, URIs, media types, - and response codes. - These open-source Python clients run on Linux or Mac OS X - systems and are easy to learn and use. Each OpenStack service - has its own command-line client. On some client commands, you - can specify a debug - parameter to show the underlying API request for the command. - This is a good way to become familiar with the OpenStack API - calls. - The following table lists the command-line client for each OpenStack - service with its package name and description. + + Each OpenStack project provides a command-line client, which + enables you to access the project API through easy-to-use + commands. For example, the Compute service provides a nova + command-line client. + + You can run the commands from the command line, or include the + commands within scripts to automate tasks. If you provide + OpenStack credentials, such as your user name and password, you + can run these commands on any computer. + + + Internally, each command uses cURL command-line tools, which embed + API requests. OpenStack APIs are RESTful APIs, and use the HTTP + protocol. They include methods, URIs, media types, and response + codes. + + OpenStack APIs are open-source Python clients, and can run on + Linux or Mac OS X systems. On some client commands, you can + specify a debug parameter to show the + underlying API request for the command. This is a good way to + become familiar with the OpenStack API calls. + The following table lists the command-line client for each + OpenStack service with its package name and description.
OpenStack services and clients