Просмотр исходного кода

Fixed some typos and improved formatting.

Nuwan Goonasekera 10 лет назад
Родитель
Сommit
5f16efa822
5 измененных файлов с 34 добавлено и 108 удалено
  1. 5 3
      docs/concepts.rst
  2. 9 9
      docs/getting_started.rst
  3. 0 75
      docs/images/object_relationships_detailed.svg
  4. 4 4
      docs/index.rst
  5. 16 17
      docs/topics/setup.rst

+ 5 - 3
docs/concepts.rst

@@ -1,7 +1,7 @@
 Concepts and Organisation
 =========================
 
-Conceptually, cloudbridge consists of the following types of objects.
+Conceptually, CloudBridge consists of the following types of objects.
 
 1. Providers - Represents a connection to a cloud provider, and is
 the gateway to using its services.
@@ -23,7 +23,7 @@ an instance. Similarly, VolumeService.create() will return a Volume object.
 
 .. image:: images/object_relationships_overview.svg
 
-The actual source code structure of cloudbridge also mirrors this organisation.
+The actual source code structure of CloudBridge also mirrors this organisation.
 
 Detailed class relationships
 ----------------------------
@@ -31,7 +31,9 @@ Detailed class relationships
 The following diagram shows a typical provider object graph and the relationship
 between services.
 
-.. figure:: images/object_relationships_detailed.svg
+.. raw:: html
+
+   <object data="_static/object_relationships_detailed.svg" type="image/svg+xml"></object>
 
 Some services are nested. For example, to access the instance service, you can
 use `provider.compute.instances`. Similarly, to get a list of all instances,

+ 9 - 9
docs/getting_started.rst

@@ -1,8 +1,8 @@
 Getting Started
 ===============
-This getting started guide will provide a quick tour of some Cloudbridge
+This getting started guide will provide a quick tour of some CloudBridge
 features. For more details on individual features, see the
-`Using Cloudbridge <topics/overview.html>`_ section or the
+`Using CloudBridge <topics/overview.html>`_ section or the
 `API reference <api_docs/ref.html>`_.
 
 Installation
@@ -15,7 +15,7 @@ run::
 Create a provider
 -----------------
 To start, you will need to create a reference to a provider object. The
-provider object idetifies the cloud you want to work with and supplies your
+provider object identifies the cloud you want to work with and supplies your
 credentials. In this code snippet, we will be using AWS. For the details on
 other providers, take a look at the `Setup page <topics/setup.html>`_.
 
@@ -38,14 +38,14 @@ Once you have a reference to a provider, explore the cloud platform:
     provider.block_store.snapshots.list()
     provider.object_store.list()
 
-This will demonstrate the fact the library was properly installed and your
-provider object is setup corectly but it is not very interesting. Hence, let's
-create a new instance we can ssh into using a key pair.
+This will demonstrate the fact that the library was properly installed and your
+provider object is setup correctly but it is not very interesting. Therefore,
+let's create a new instance we can ssh into using a key pair.
 
 Create a key pair
 -----------------
 We'll create a new key pair and save the private portion of the key to a file
-on disc as a read-only file.
+on disk as a read-only file.
 
 .. code-block:: python
 
@@ -97,6 +97,6 @@ To wrap things up, let's clean up all the resources we have created
     sg.delete()
     kp.delete()
 
-And that's it - a full circle in a few lines of code. For homework, try to do
-the same but with a different provider. All you will need to change is the
+And that's it - a full circle in a few lines of code. You can now try
+the same with a different provider. All you will need to change is the
 cloud-specific data, namely the provider setup and the image ID.

Разница между файлами не показана из-за своего большого размера
+ 0 - 75
docs/images/object_relationships_detailed.svg


+ 4 - 4
docs/index.rst

@@ -3,17 +3,17 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to cloudbridge's documentation!
+Welcome to CloudBridge's documentation!
 =======================================
 
-cloudbridge aims to provide a simple layer of abstraction over
+CloudBridge aims to provide a simple layer of abstraction over
 different cloud providers, reducing or eliminating the need to write
 conditional code for each cloud.
 
 Usage example
 -------------
 
-The simplest possible example for doing something useful with cloudbridge would
+The simplest possible example for doing something useful with CloudBridge would
 look like the following.
 
 .. code-block:: python
@@ -34,7 +34,7 @@ that they return. Click on any object to drill down into its details.
 
 .. raw:: html
 
-   <object data="_images/object_relationships_detailed.svg" type="image/svg+xml"></object>
+   <object data="_static/object_relationships_detailed.svg" type="image/svg+xml"></object>
 
 Installation
 ------------

+ 16 - 17
docs/topics/setup.rst

@@ -1,7 +1,7 @@
 Setup
 -----
 To initialize a connection to a cloud and get a provider object, you will
-need to provide the cloud's access credentials to Cloudbridge. These may
+need to provide the cloud's access credentials to CloudBridge. These may
 be provided in one of two ways:
 
 1. Environment variables
@@ -13,26 +13,25 @@ The following environment variables must be set, depending on the provider in us
 
 **Amazon**
 
-*Mandatory variables*::
-
-    AWS_ACCESS_KEY
-    AWS_SECRET_KEY
+===================  ==================
+Mandatory variables  Optional Variables
+===================  ==================
+AWS_ACCESS_KEY
+AWS_SECRET_KEY
+===================  ==================
 
 **Openstack**
 
-*Mandatory variables*::
-
-    OS_AUTH_URL
-    OS_USERNAME
-    OS_PASSWORD
-    OS_TENANT_NAME
-    OS_REGION_NAME
-
-*Optional variables*::
+===================  ==================
+Mandatory variables  Optional Variables
+===================  ==================
+OS_AUTH_URL			 NOVA_SERVICE_NAME
+OS_USERNAME			 OS_COMPUTE_API_VERSION
+OS_PASSWORD			 OS_VOLUME_API_VERSION
+OS_TENANT_NAME
+OS_REGION_NAME
+===================  ==================
 
-    NOVA_SERVICE_NAME
-    OS_COMPUTE_API_VERSION
-    OS_VOLUME_API_VERSION
 
 Once the environment variables are set, you can create a connection as follows:
 

Некоторые файлы не были показаны из-за большого количества измененных файлов