You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by ma...@apache.org on 2013/01/24 18:20:38 UTC

[2/2] git commit: Review input for SITE: fix nits in CIMI docs - update links and nav bar

Updated Branches:
  refs/heads/master ab0183f6d -> 3cb1e9600


Review input for SITE: fix nits in CIMI docs - update links and nav bar


Project: http://git-wip-us.apache.org/repos/asf/deltacloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltacloud/commit/3cb1e960
Tree: http://git-wip-us.apache.org/repos/asf/deltacloud/tree/3cb1e960
Diff: http://git-wip-us.apache.org/repos/asf/deltacloud/diff/3cb1e960

Branch: refs/heads/master
Commit: 3cb1e9600dbd211c72764213179d52c01c0e3765
Parents: ea7178e
Author: Joe VLcek <jv...@redhat.com>
Authored: Thu Jan 24 11:07:43 2013 -0500
Committer: marios <ma...@redhat.com>
Committed: Thu Jan 24 19:12:27 2013 +0200

----------------------------------------------------------------------
 site/content/about.md                              |    6 +++---
 .../cimi-curl/cimi-curl-resource_metadata.md       |    4 ++--
 .../cimi-rest/cimi-rest-machine-templates.md       |    2 +-
 site/content/command-tools.md                      |    4 ++--
 site/content/rest-api.md                           |    2 +-
 site/content/usage.md                              |    2 +-
 site/output/about.html                             |    6 +++---
 .../cimi-curl/cimi-curl-resource_metadata.html     |    4 ++--
 .../cimi-rest/cimi-rest-machine-templates.html     |    2 +-
 site/output/command-tools.html                     |    4 ++--
 site/output/rest-api.html                          |    2 +-
 site/output/usage.html                             |    2 +-
 12 files changed, 20 insertions(+), 20 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/about.md
----------------------------------------------------------------------
diff --git a/site/content/about.md b/site/content/about.md
index 71ae4d5..2d6c6f6 100644
--- a/site/content/about.md
+++ b/site/content/about.md
@@ -14,7 +14,7 @@ title: About
 
 <p>Deltacloud maintains <strong>long-term stability</strong> for scripts, tools and applications and <strong>backward compatibility</strong> across different versions.</p>
 
-<p>Using a single API Deltacloud enables management of resources in different clouds. This 'single API' can be the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API.</p>
+<p>Deltacloud enables management of resources in different clouds by the use of one of three supported APIs. The supported  APIs are the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API.</p>
 
 <p>All of this means you can start an instance on an internal cloud and with the same code start another on EC2 or RHEV-M.</p>
 </div>
@@ -31,9 +31,9 @@ title: About
 <br/>
 <h3>How does Deltacloud work?</h3>
 <br/>
-<p>Deltacloud contains a cloud abstraction API - whether the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every <a href="/supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" cloud provider's native API. It frees you from dealing with the particulars of each cloud's API.</p>
+<p>Deltacloud contains a cloud abstraction API - whether the <a href="/rest-api.html">Deltacloud</a> classic API, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every cloud <a href="/supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" that cloud provider's native API, freeing you from dealing with the particulars of each cloud's API.</p>
 
-<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the <a href="/rest-api.html">Deltacloud REST API</a>, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. Deltacloud even comes with a HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box. The HTML interface is written with the <a href="http://jquerymobile.com/">jQuery mobile</a> framework, so it is compatible with your mobile or tablet devices.</p>
+<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the <a href="/rest-api.html">Deltacloud REST API</a>, the DMTF <a href="/cimi-rest.html">CIMI API</a> or even the EC2 API. Deltacloud even comes with an HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box. The HTML interface is written with the <a href="http://jquerymobile.com/">jQuery mobile</a> framework, so it is compatible with your mobile or tablet devices.</p>
 <br/>
 
 <img src="/assets/img/deltacloud_concept.gif" alt="Deltacloud concept scheme"/>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/cimi-curl/cimi-curl-resource_metadata.md
----------------------------------------------------------------------
diff --git a/site/content/cimi-curl/cimi-curl-resource_metadata.md b/site/content/cimi-curl/cimi-curl-resource_metadata.md
index 72b0b66..2d21161 100644
--- a/site/content/cimi-curl/cimi-curl-resource_metadata.md
+++ b/site/content/cimi-curl/cimi-curl-resource_metadata.md
@@ -36,10 +36,10 @@ title: CIMI cURL Examples - Resource Metadata Resources
 
   <pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/xml" http://localhost:3001/cimi/resource_metadata</pre>
 
-  <p> Retrieve the Resource Metadata resource corresponding to the Cloud Entry Point resource, in json format:</p>
+  <p> Retrieve the Resource Metadata as it corresponding to the Cloud Entry Point resource, in json format:</p>
 
   <pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/json" http://localhost:3001/cimi/resource_metadata/cloud_entry_point </pre>
 
-  <p> Retrieve the Resource Metadata resource corresponding to the Machine resource, in xml format:</p>
+  <p> Retrieve the Resource Metadata as it corresponding to the Machine resource, in xml format:</p>
 
   <pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/xml" http://localhost:3001/cimi/resource_metadata/machine </pre>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/cimi-rest/cimi-rest-machine-templates.md
----------------------------------------------------------------------
diff --git a/site/content/cimi-rest/cimi-rest-machine-templates.md b/site/content/cimi-rest/cimi-rest-machine-templates.md
index aab606a..cd61fa5 100644
--- a/site/content/cimi-rest/cimi-rest-machine-templates.md
+++ b/site/content/cimi-rest/cimi-rest-machine-templates.md
@@ -27,7 +27,7 @@ machineConfiguration + machineImage = machineTemplate ===> machine
 </pre>
 
 <p>
-A CIMI client (a <strong>consumer</strong> in CIMI terminology) uses a Machine Template to <a href="/cimi-rest/cimi-rest-collections.html#create-machine"> create a new Machine</a>; a Machine Template consists of (amongst other attributes) a Machine Configuration and a Machine Image. Generally speaking - many CIMI resources require use of a template for their creation and a template will typically consist of an image plus a configuration resource.
+A CIMI client (a <strong>consumer</strong> in CIMI terminology) uses a Machine Template to <a href="/cimi-rest/cimi-rest-collections.html#create-machine"> create a new Machine</a>; a Machine Template consists of (amongst other attributes) a Machine Configuration and a Machine Image. Generally speaking - many CIMI resources require the use of a template for their creation and a template will typically consist of an image plus a configuration resource.
 </p>
 
   </div>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/command-tools.md
----------------------------------------------------------------------
diff --git a/site/content/command-tools.md b/site/content/command-tools.md
index 18bc20e..90670a6 100644
--- a/site/content/command-tools.md
+++ b/site/content/command-tools.md
@@ -21,14 +21,14 @@ The deltacloud core developers use (almost exclusively) <a href="http://curl.hax
 
 <h3 id="command">Using Deltacloud command tool</h3>
 
-<p>Installing the Deltacloud Ruby client also gives you the <strong>deltacloudc</strong> command line tool. This executable uses the Deltacloud client library to speak to the Deltacloud server through the <a href="/rest-api.html">REST API</a>. This means that you can control your cloud infrastructure from the command line. The general usage pattern for deltacloudc is:<p>
+<p>Installing the Deltacloud Ruby client also gives you the <strong>deltacloudc</strong> command line tool. This executable uses the Deltacloud client library to speak to the Deltacloud server through the <a href="/rest-api.html">Deltacloud REST API</a>. This means that you can control your cloud infrastructure from the command line. The general usage pattern for deltacloudc is:<p>
 
 <pre>$ deltacloudc collection operation [options]</pre>
 
 <dl>
   <dt>Collection</dt>
   <dd>
-  refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc., as described in a greater detail in the <a href="/rest-api.html">REST API documentation</a>.
+  refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc., as described in a greater detail in the <a href="/rest-api.html">Deltacloud REST API documentation</a>.
   </dd>
   <dt>Operation</dt>
   <dd>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/rest-api.md
----------------------------------------------------------------------
diff --git a/site/content/rest-api.md b/site/content/rest-api.md
index e9a8dff..7b449ef 100644
--- a/site/content/rest-api.md
+++ b/site/content/rest-api.md
@@ -29,7 +29,7 @@ The following terms describe abstractions used in the Apache Deltacloud API. Eac
 
 <ul class="nav nav-list well">
   <li class="nav-header">
-    REST API
+    Deltacloud REST API
   </li>
   <li class="active"><a href="#rest">Introduction</a></li>
   <ul class="nav nav-list">

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/content/usage.md
----------------------------------------------------------------------
diff --git a/site/content/usage.md b/site/content/usage.md
index bf5d2cb..8b781e9 100644
--- a/site/content/usage.md
+++ b/site/content/usage.md
@@ -66,7 +66,7 @@ openstack = client.with_config(:driver => :openstack)
 <h3>HTTP clients - cURL</h3>
 
 <p>
-Basically, you interact with the Deltacloud server via HTTP calls, so you can use any HTTP client to talk to Deltacloud using the <a href="/rest-api.html">REST API</a>.
+Basically, you interact with the Deltacloud server via HTTP calls, so you can use any HTTP client to talk to Deltacloud using the <a href="/rest-api.html">Deltacloud REST API</a>.
 </p>
 
 <p>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/about.html
----------------------------------------------------------------------
diff --git a/site/output/about.html b/site/output/about.html
index 4bb7796..23922a2 100644
--- a/site/output/about.html
+++ b/site/output/about.html
@@ -104,7 +104,7 @@
 
 <p>Deltacloud maintains <strong>long-term stability</strong> for scripts, tools and applications and <strong>backward compatibility</strong> across different versions.</p>
 
-<p>Using a single API Deltacloud enables management of resources in different clouds. This 'single API' can be the <a href="rest-api.html">Deltacloud</a> classic API, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API.</p>
+<p>Deltacloud enables management of resources in different clouds by the use of one of three supported APIs. The supported  APIs are the <a href="rest-api.html">Deltacloud</a> classic API, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API.</p>
 
 <p>All of this means you can start an instance on an internal cloud and with the same code start another on EC2 or RHEV-M.</p>
 </div>
@@ -116,9 +116,9 @@
 <div class="span12">
 
 <br><br><h3>How does Deltacloud work?</h3>
-<br><p>Deltacloud contains a cloud abstraction API - whether the <a href="rest-api.html">Deltacloud</a> classic API, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every <a href="supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" cloud provider's native API. It frees you from dealing with the particulars of each cloud's API.</p>
+<br><p>Deltacloud contains a cloud abstraction API - whether the <a href="rest-api.html">Deltacloud</a> classic API, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API. The API works as a wrapper around a large number of clouds, abstracting their differences. For every cloud <a href="supported-providers.html" rel="tooltip" title="currently supported providers">provider</a> there is a driver "speaking" that cloud provider's native API, freeing you from dealing with the particulars of each cloud's API.</p>
 
-<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the <a href="rest-api.html">Deltacloud REST API</a>, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API. Deltacloud even comes with a HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box. The HTML interface is written with the <a href="http://jquerymobile.com/">jQuery mobile</a> framework, so it is compatible with your mobile or tablet devices.</p>
+<p>Install Deltacloud and start the <strong>deltacloudd</strong> daemon server. You can use your favourite HTTP client to talk to the server using the <a href="rest-api.html">Deltacloud REST API</a>, the DMTF <a href="cimi-rest.html">CIMI API</a> or even the EC2 API. Deltacloud even comes with an HTML interface so you can simply use your web browser to control your cloud infrastructure straight out of the box. The HTML interface is written with the <a href="http://jquerymobile.com/">jQuery mobile</a> framework, so it is compatible with your mobile or tablet devices.</p>
 <br><img src="assets/img/deltacloud_concept.gif" alt="Deltacloud concept scheme"><br><a class="btn btn-inverse btn-large" style="float: right" href="install-deltacloud.html">Get Deltacloud</a>
 
 </div>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/cimi-curl/cimi-curl-resource_metadata.html
----------------------------------------------------------------------
diff --git a/site/output/cimi-curl/cimi-curl-resource_metadata.html b/site/output/cimi-curl/cimi-curl-resource_metadata.html
index fb4f68a..7a6edc2 100644
--- a/site/output/cimi-curl/cimi-curl-resource_metadata.html
+++ b/site/output/cimi-curl/cimi-curl-resource_metadata.html
@@ -126,11 +126,11 @@
 
   </p><pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/xml" http://localhost:3001/cimi/resource_metadata</pre>
 
-  <p> Retrieve the Resource Metadata resource corresponding to the Cloud Entry Point resource, in json format:</p>
+  <p> Retrieve the Resource Metadata as it corresponding to the Cloud Entry Point resource, in json format:</p>
 
   <pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/json" http://localhost:3001/cimi/resource_metadata/cloud_entry_point </pre>
 
-  <p> Retrieve the Resource Metadata resource corresponding to the Machine resource, in xml format:</p>
+  <p> Retrieve the Resource Metadata as it corresponding to the Machine resource, in xml format:</p>
 
   <pre>curl -v --user "mockuser:mockpassword" -H "Accept: application/xml" http://localhost:3001/cimi/resource_metadata/machine </pre>
 

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/cimi-rest/cimi-rest-machine-templates.html
----------------------------------------------------------------------
diff --git a/site/output/cimi-rest/cimi-rest-machine-templates.html b/site/output/cimi-rest/cimi-rest-machine-templates.html
index 33c2554..4dabb57 100644
--- a/site/output/cimi-rest/cimi-rest-machine-templates.html
+++ b/site/output/cimi-rest/cimi-rest-machine-templates.html
@@ -119,7 +119,7 @@ machineConfiguration + machineImage = machineTemplate ===&gt; machine
 </pre>
 
 <p>
-A CIMI client (a <strong>consumer</strong> in CIMI terminology) uses a Machine Template to <a href="cimi-rest-collections.html#create-machine"> create a new Machine</a>; a Machine Template consists of (amongst other attributes) a Machine Configuration and a Machine Image. Generally speaking - many CIMI resources require use of a template for their creation and a template will typically consist of an image plus a configuration resource.
+A CIMI client (a <strong>consumer</strong> in CIMI terminology) uses a Machine Template to <a href="cimi-rest-collections.html#create-machine"> create a new Machine</a>; a Machine Template consists of (amongst other attributes) a Machine Configuration and a Machine Image. Generally speaking - many CIMI resources require the use of a template for their creation and a template will typically consist of an image plus a configuration resource.
 </p>
 
   </div>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/command-tools.html
----------------------------------------------------------------------
diff --git a/site/output/command-tools.html b/site/output/command-tools.html
index e1dbac5..93d18bf 100644
--- a/site/output/command-tools.html
+++ b/site/output/command-tools.html
@@ -110,14 +110,14 @@
 
 <h3 id="command">Using Deltacloud command tool</h3>
 
-<p>Installing the Deltacloud Ruby client also gives you the <strong>deltacloudc</strong> command line tool. This executable uses the Deltacloud client library to speak to the Deltacloud server through the <a href="rest-api.html">REST API</a>. This means that you can control your cloud infrastructure from the command line. The general usage pattern for deltacloudc is:</p><p>
+<p>Installing the Deltacloud Ruby client also gives you the <strong>deltacloudc</strong> command line tool. This executable uses the Deltacloud client library to speak to the Deltacloud server through the <a href="rest-api.html">Deltacloud REST API</a>. This means that you can control your cloud infrastructure from the command line. The general usage pattern for deltacloudc is:</p><p>
 
 </p><pre>$ deltacloudc collection operation [options]</pre>
 
 <dl>
 <dt>Collection</dt>
   <dd>
-  refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc., as described in a greater detail in the <a href="rest-api.html">REST API documentation</a>.
+  refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc., as described in a greater detail in the <a href="rest-api.html">Deltacloud REST API documentation</a>.
   </dd>
   <dt>Operation</dt>
   <dd>

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/rest-api.html
----------------------------------------------------------------------
diff --git a/site/output/rest-api.html b/site/output/rest-api.html
index f394d5f..06e4643 100644
--- a/site/output/rest-api.html
+++ b/site/output/rest-api.html
@@ -121,7 +121,7 @@ The following terms describe abstractions used in the Apache Deltacloud API. Eac
 
 <ul class="nav nav-list well">
 <li class="nav-header">
-    REST API
+    Deltacloud REST API
   </li>
   <li class="active"><a href="#rest">Introduction</a></li>
   <ul class="nav nav-list">

http://git-wip-us.apache.org/repos/asf/deltacloud/blob/3cb1e960/site/output/usage.html
----------------------------------------------------------------------
diff --git a/site/output/usage.html b/site/output/usage.html
index 8c597c6..15d23ac 100644
--- a/site/output/usage.html
+++ b/site/output/usage.html
@@ -156,7 +156,7 @@ openstack = client.with_config(:driver =&gt; :openstack)
 <br><br><h3>HTTP clients - cURL</h3>
 
 <p>
-Basically, you interact with the Deltacloud server via HTTP calls, so you can use any HTTP client to talk to Deltacloud using the <a href="rest-api.html">REST API</a>.
+Basically, you interact with the Deltacloud server via HTTP calls, so you can use any HTTP client to talk to Deltacloud using the <a href="rest-api.html">Deltacloud REST API</a>.
 </p>
 
 <p>