Permalink
Browse files

cleaning up docs, some is just wrong

  • Loading branch information...
1 parent fb60f4c commit 14d0a03595e1b78e3b344220ab2f8800583a46b5 @timf timf committed Jul 17, 2010
Showing with 29 additions and 53 deletions.
  1. +5 −5 docs/src/changelog.html
  2. +24 −48 docs/src/faq.html
View
10 docs/src/changelog.html
@@ -26,7 +26,7 @@
<i>We are happy to announce the first version of Cumulus!</i>
</p>
<p>
- Cumulus is a storage cloud implementation compatible with the Amazon Web Services S3 REST API (with small exceptions), it works seamlessy with S3 clients such as s3cmd, jets3t, and boto. In addition, it offers extra functionality such as disk quota enforcement.
+ Cumulus is a storage cloud implementation compatible with the Amazon Web Services S3 REST API (with small exceptions), it works seamlessly with S3 clients such as s3cmd, jets3t, and boto. In addition, it offers extra functionality such as disk quota enforcement.
</p>
<p>
Cumulus replaces the current GridFTP-based upload and download of VM images: it integrates tightly in a Nimbus installation as the VM image repository solution. And it can be also installed on its own to manage a storage cloud: a Nimbus IaaS installation needs Cumulus but not vice versa.
@@ -212,13 +212,13 @@
<ul>
<li>
<p>
- The build system now forces the Java pieces to be 1.5
+ The build system now forces the Java pieces to be JRE 1.5
compatible. (<b>New in RC2</b>)
</p>
</li>
<li>
<p>
- <i>scripts/check-jars.sh</i> makes it easy to check 1.5
+ <i>scripts/check-jars.sh</i> makes it easy to check JRE 1.5
compatibility on any directory of jars (including
subdirectories). For example, a Nimbus installation.
(<b>New in RC2</b>)
@@ -231,7 +231,7 @@
<p>
Lets you change Java source code and just build and install
the jars and get the changes straight into an existing
- installation for more immediate non-automated testing.
+ installation for immediate experimentation/testing.
</p>
</li>
<li>
@@ -749,7 +749,7 @@
</p>
<p>
This means one less user step in many of the common ways people use
- the cloud client. The new <b>optional</b>'nimbus.cert' and
+ the cloud client. The new (optional) 'nimbus.cert' and
'nimbus.key' properties also makes toggling between clouds easier.
</p>
</li>
View
72 docs/src/faq.html
@@ -65,9 +65,6 @@
<a href="#ctxagent">What is the Context Agent</a>?
</li>
<li>
- <a href="#defcloudkit">What is the cloudkit</a>?
- </li>
- <li>
<a href="#nimbusweb">What is Nimbus Web</a>?
</li>
<li>
@@ -142,15 +139,12 @@
<p>
Options aren't always a good thing, especially to start with. The
- main way to deploy Nimbus is the "cloudkit" configuration. This
+ main way to deploy Nimbus is the cloud configuration. This
involves hosting a site manager service and creating an image
- repository for clients to have their own personal image directories
- (see the
- <a href="doc/cloud.html">cloud
- guide</a> for details). You direct your new users to use the
+ repository (see the
+ <a href="admin/z2c/">Zero To Cloud guide</a> for details). You direct your new users to use the
<a href="clouds/cloudquickstart.html">cloud client</a> which
- gets them up and running in just a few minutes if the credential
- situation is understood.
+ gets them up and running in just a few minutes.
</p>
<p>
@@ -168,21 +162,22 @@
</p>
<p>
Nimbus itself is not hard to install, it has a script driven install
- option that asks you questions (see the
- <a href="admin/index.html">administrator
- guide</a> for details).
+ that asks you two questions.
</p>
<p>
Nimbus requires that some dependencies are installed first. On the
- service node: <b>Java</b> (1.5+) and <b>bash</b>. On the
- hypervisor nodes: <b>Python</b> (2.4+), <b>bash</b>,
- <b>ebtables</b>, <b>DHCPd</b>, <b>libvirt</b> and <b>KVM</b> or <b>Xen</b>
- (2 works but 3 is recommended).
+ service node: Java, Python, and bash. On the
+ hypervisor nodes: Python, bash, ebtables, libvirt and KVM or Xen.
</p>
<p>
All of these things are installable via the package management
system of all the popular Linux distributions.
</p>
+ <p>
+ See the <a href="admin/z2c/">Zero To Cloud</a> guide for details
+ including detailed
+ <a href="admin/z2c/service-dependencies.html">prerequisite information</a>.
+ </p>
</li>
<li>
@@ -264,13 +259,6 @@
interacts with the Context Broker at VM boot.
</p>
</li>
- <li>
- <p>
- The <a href="#ec2-backend">EC2 backend</a> allows the service
- to turn around and secure remote resources from off-site.
- </p>
- </li>
-
</ul>
</div>
@@ -348,7 +336,6 @@
<p>
This is the protocol implementation in longstanding use by previous
workspace services and clients including the popular cloud-client.
- A full protocol guide enumerating differences is forthcoming.
</p>
</li>
@@ -590,7 +577,7 @@
</p>
<p>
- The reference client exposes all features of the <a href="">WSRF
+ The reference client exposes all features of the <a href="#wsrf-frontend">WSRF
frontend</a> as a commandline client. It is relatively complex
to use and thus typically wrapped by task-specific scripts.
</p>
@@ -750,25 +737,14 @@
<li>
<p>
- <a name="defcloudkit"> </a>
- <b>What is the "cloudkit"? _NAMELINK(defcloudkit)</b>
- </p>
-
- <p>
- See <i><a href="#cloudkit">What is the main way to deploy Nimbus</a>?</i>
- </p>
- </li>
-
- <li>
- <p>
<a name="nimbusweb"> </a>
<b>What is Nimbus Web? <span class="namelink"><a href="#nimbusweb">(#)</a></span></b>
</p>
<p>
- Nimbus Web is the rapidly evolving web interface for Nimbus. It provides administrative
- and user functions in a friendly interface. This module is targeted for many exciting
- features and enhancements over the coming months.
+ Nimbus Web is the evolving web interface for Nimbus. Its aim is
+ to provide administrative and user functions in a friendly
+ interface.
</p>
<p>
Nimbus Web is centered around a Python Django web application that is intended to be
@@ -797,7 +773,7 @@
<li>
<p>
<a name="cumulus"> </a>
- <b>What is Cumulus? <span class="namelink"><a href="#cumulus">(#)</a></span></b>
+ <b>What is Cumulus? _NAMELINK(cumulus)</b>
</p>
<p>
@@ -809,7 +785,7 @@
<li>
<p>
<a name="cumulusclients"> </a>
- <b>What clients can I use with Cumulus? <span class="namelink"><a href="#cumulusclients">(#)</a></span></b>
+ <b>What clients can I use with Cumulus? _NAMELINK(cumulusclients)</b>
</p>
<p>
@@ -822,7 +798,7 @@
<li>
<p>
<a name="cumulusnimbus"> </a>
- <b>How are Nimbus and Cumulus related?<span class="namelink"><a href="#cumulusnimbus">(#)</a></span></b>
+ <b>How are Nimbus and Cumulus related? _NAMELINK(cumulusnimbus)</b>
</p>
<p>
@@ -835,7 +811,7 @@
<li>
<p>
<a name="cumulusnonimbus"> </a>
- <b>Can Cumulus be installed without Nimbus?<span class="namelink"><a href="#cumulusnonimbus">(#)</a></span></b>
+ <b>Can Cumulus be installed without Nimbus? _NAMELINK(cumulusnonimbus)</b>
</p>
<p>
@@ -848,7 +824,7 @@
<li>
<p>
<a name="nimbusnocumulus"> </a>
- <b>Can Nimbus be installed without Cumulus?<span class="namelink"><a href="#nimbusnocumulus">(#)</a></span></b>
+ <b>Can Nimbus be installed without Cumulus? _NAMELINK(nimbusnocumulus)</b>
</p>
<p>
@@ -862,7 +838,7 @@
<li>
<p>
<a name="cumulusprop"> </a>
- <b>Does the Nimbus IaaS system directly use Cumulus for image propagation?<span class="namelink"><a href="#cumulusprop">(#)</a></span></b>
+ <b>Does the Nimbus IaaS system directly use Cumulus for image propagation? _NAMELINK(cumulusprop)</b>
</p>
<p>
@@ -878,7 +854,7 @@
<li>
<p>
<a name="cumulusreliable"> </a>
- <b>How reliable is Cumulus?<span class="namelink"><a href="#cumulusreliable">(#)</a></span></b>
+ <b>How reliable is Cumulus? _NAMELINK(cumulusreliable)</b>
</p>
<p>
@@ -890,7 +866,7 @@
<li>
<p>
<a name="cumulusbackend"> </a>
- <b>What type of storage system backs the Cumulus repository?<span class="namelink"><a href="#cumulusbackend">(#)</a></span></b>
+ <b>What type of storage system backs the Cumulus repository? _NAMELINK(cumulusbackend)</b>
</p>
<p>

0 comments on commit 14d0a03

Please sign in to comment.