Permalink
Browse files

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

  • Loading branch information...
1 parent ea7178e commit 3cb1e9600dbd211c72764213179d52c01c0e3765 @jvlcek jvlcek committed with marios Jan 24, 2013
@@ -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"/>
@@ -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>
@@ -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>
@@ -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>
@@ -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">
@@ -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>
@@ -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>
@@ -126,11 +126,11 @@ <h3 id="command">cURL examples for CIMI Resource Metadata resources</h3>
</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>
@@ -119,7 +119,7 @@ <h3 id="cimi-machine-template">Machine Template</h3>
</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>
@@ -110,14 +110,14 @@ <h3 id="command">deltacloudc is being deprecated</h3>
<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>
@@ -121,7 +121,7 @@ <h3 id="collections">Collections</h3>
<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">
@@ -156,7 +156,7 @@ <h3 id="clients">Clients</h3>
<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>

0 comments on commit 3cb1e96

Please sign in to comment.