Merge lp:~bkerensa/pyjuju/docs into lp:~charm-contributors/pyjuju/docs

[Benjamin Kerensa]

Improved Casing Consistency

[Marco Ceppi (marcoceppi)]

Make sure "Juju" in the config stanzas (Juju-origin: ppa or control-bucket: Juju09asfa...) remain lower case.

review: Needs Fixing

Unmerged revisions

62. By Benjamin Kerensa on 2012-08-15

Improved Use of Casing for Consistency

=== modified file 'source/about.rst'
--- source/about.rst	2012-06-19 16:52:27 +0000
+++ source/about.rst	2012-08-15 08:56:19 +0000
@@ -1,4 +1,4 @@
-About juju
+About Juju
 ==========
 
 For a long time now Linux server deployments have been moving towards the
@@ -27,7 +27,7 @@
 in deploying, maintaining, and enriching distributed software configurations.
 
 This is the challenge which motivates the research happening through the
-juju project at Canonical. juju aims to be a service deployment and
+Juju project at Canonical. Juju aims to be a service deployment and
 orchestration tool which enables the same kind of collaboration and ease of
 use which today is seen around package management to happen on a higher
 level, around services.  With juju, different authors are able to create

=== modified file 'source/charm.rst'
--- source/charm.rst	2012-05-15 00:22:43 +0000
+++ source/charm.rst	2012-08-15 08:56:19 +0000
@@ -6,7 +6,7 @@
 
 Charms define how services integrate and how their service units
 react to events in the distributed environment, as orchestrated by
-juju.
+Juju.
 
 This specification describes how charms are defined, including their
 metadata and hooks. It also describes the resources available to hooks
@@ -106,7 +106,7 @@
 Hooks
 -----
 
-juju uses hooks to notify a service unit about changes happening
+Juju uses hooks to notify a service unit about changes happening
 in its lifecycle or the larger distributed environment. A hook running
 for a service unit can query this environment, make any desired local
 changes on its underlying machine, and change the relation

=== modified file 'source/faq.rst'
--- source/faq.rst	2012-06-20 17:37:44 +0000
+++ source/faq.rst	2012-08-15 08:56:19 +0000
@@ -4,16 +4,16 @@
 Frequently Asked Questions
 ==========================
 
-Where does the name juju come from?
+Where does the name Juju come from?
 -----------------------------------
 
   It means magic in the same african roots where the word ubuntu comes from.
   Please see http://afgen.com/juju.html for a more detailed explanation.
 
-Why is juju useful?
+Why is Juju useful?
 -------------------
 
-  juju is a next generation service deployment and orchestration
+  Juju is a next generation service deployment and orchestration
   framework.  It has been likened to APT for the cloud. With juju,
   different authors are able to create service charms independently, and
   make those services coordinate their communication through a simple
@@ -22,25 +22,25 @@
   multiple machines and components transparently collaborating towards
   providing the requested service.  Read more :doc:`about`
 
-When will it be ready for production?
+When will Juju be ready for production?
 -------------------------------------
 
-  As of Ubuntu 12.04, juju is considered beta. It is not yet
+  As of Ubuntu 12.04, Juju is considered beta. It is not yet
   ready to be used in production. However, adventurous users are encouraged to
   evaluate it, study it, start writing charms for it or start hacking on
-  juju internals.
+  Juju internals.
 
-What language is juju developed in?
+What language is Juju developed in?
 -----------------------------------
 
-  juju itself is developed using Python. However, writing charms for
-  juju can be done in any language. All juju cares about is finding a
+  Juju itself is developed using Python. However, writing charms for
+  Juju can be done in any language. All Juju cares about is finding a
   set of executable files, which it will trigger appropriately
 
 Does juju start from a pre-configured AMI Image?
 ------------------------------------------------
 
-  No, juju uses a plain Ubuntu image. All needed components are installed
+  No, Juju uses a plain Ubuntu image. All needed components are installed
   at run-time. Then the juju charm is sent to the machine and hooks start
   getting executed in response to events. If you need a custom AMI you can
   specify it in the environments.yaml file. 
@@ -49,23 +49,23 @@
 -------------------------------------------------------
 
   Currently each service unit is deployed to a separate machine that can relate
-  to other services running on different nodes. This was done to get juju into a
-  working state faster. juju will definitely support multiple services per
+  to other services running on different nodes. This was done to get Juju into a
+  working state faster. Juju will definitely support multiple services per
   machine in the future
 
-Is it possible to pass parameters to juju charms?
+Is it possible to pass parameters to Juju charms?
 -------------------------------------------------
 
-  Tunables are landing very soon in juju. Once ready you will be able to use
+  Tunables are landing very soon in Juju. Once ready you will be able to use
   "juju set service key=value" and respond to that from within the juju charm.
   This will enable dynamic features to be added to charms
 
-Does juju only deploy to the Amazon EC2 cloud?
+Does Juju only deploy to the Amazon EC2 cloud?
 ----------------------------------------------
 
   No. juju can deploy to EC2, OpenStack, and bare metal (`MAAS
   <https://wiki.ubuntu.com/ServerTeam/MAAS/Juju>`_) via LXC containers or
-  Orchestra .
+  Orchestra.
   When using LXC you are able to run juju charms on a single local machine.
   This is the recommended method for prototyping charms as it's quicker to
   iterate locally and then deploy on the cloud when you're ready to test.

@@ -81,7 +81,7 @@
 How are charms licensed?
 ------------------------
 
-  Charms are effectively data inputs to juju, and are therefore
+  Charms are effectively data inputs to Juju, and are therefore
   licensed/copyrighted by the author as an independent work. You are free to
   claim copyright solely for yourself if it's an independent work, and to
   license it as you see fit. If you as the charm author are performing the work
@@ -100,19 +100,19 @@
   subcommands accept an ``-e`` parameter that can be used to specify the name
   of the desired environment.
 
-How can I contact the juju team?
+How can I contact the Juju team?
 --------------------------------
 
   User and charm author oriented resources
    * Mailing list: https://lists.ubuntu.com/mailman/listinfo/juju 
   Ubuntu Cloud IRC (Freenode)
    * irc://irc.freenode.net/#ubuntu-server
-  juju development
+  Juju development
    * Mailing list: https://lists.ubuntu.com/mailman/listinfo/juju-devel 
-  juju IRC (Freenode)
+  Juju IRC (Freenode)
    * irc://irc.freenode.net/#juju & irc://irc.freenode.net/#juju-dev
 
-Where can I find out more about juju?
+Where can I find out more about Juju?
 -------------------------------------
 
   * Portal Site: http://juju.ubuntu.com/

=== modified file 'source/getting-started.rst'
--- source/getting-started.rst	2012-08-13 18:49:36 +0000
+++ source/getting-started.rst	2012-08-15 08:56:19 +0000
@@ -6,11 +6,11 @@
 Introduction
 ------------
 
-This tutorial gets you started with juju. A prerequisite is the
+This tutorial gets you started with Juju. A prerequisite is the
 access credentials to a dedicated computing environment such as what
 is offered by a virtualized cloud hosting environment.
 
-juju has been designed for environments which can provide a
+Juju has been designed for environments which can provide a
 new machine with an Ubuntu cloud operating system image
 on-demand. This includes services such as `Amazon EC2
 <http://aws.amazon.com/ec2/>`_ , `HP Cloud <http://hpcloud.com>_` or `RackSpace
@@ -24,13 +24,13 @@
 Installation
 ----------------
 
-The juju team's Personal Package Archive (PPA) installation is
-currently the preferred installation mechanism for juju. To install juju from the PPA, execute the following in a shell::
+The Juju team's Personal Package Archive (PPA) installation is
+currently the preferred installation mechanism for Juju. To install Juju from the PPA, execute the following in a shell::
 
   sudo add-apt-repository ppa:juju/pkgs
   sudo apt-get update && sudo apt-get install juju
 
-The juju environment can now be configured.
+The Juju environment can now be configured.
 
 
 Configuring your environment using EC2
@@ -51,12 +51,12 @@
       control-bucket: juju-faefb490d69a41f0a3616a4808e0766b
       admin-secret: 81a1e7429e6847c4941fda7591246594
       default-series: precise
-      juju-origin: ppa
+      Juju-origin: ppa
       ssl-hostname-verification: true
 
 Which is a sample environment configured to run with EC2 machines and S3
 permanent storage.  To make this environment actually useful, you will need
-to tell juju about an AWS access key and secret key.  To do this, you
+to tell Juju about an AWS access key and secret key.  To do this, you
 can either set the ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``
 environment variables (as usual for other EC2 tools) or you can add
 ``access-key`` and ``secret-key`` options to your ``environments.yaml``.
@@ -68,10 +68,10 @@
       type: ec2
       access-key: YOUR-ACCESS-KEY-GOES-HERE
       secret-key: YOUR-SECRET-KEY-GOES-HERE
-      control-bucket: juju-faefb490d69a41f0a3616a4808e0766b
+      control-bucket: Juju-faefb490d69a41f0a3616a4808e0766b
       admin-secret: 81a1e7429e6847c4941fda7591246594
       default-series: precise
-      juju-origin: ppa
+      Juju-origin: ppa
       ssl-hostname-verification: true
 
 The S3 bucket does not need to exist already.
@@ -90,7 +90,7 @@
 
 - Most local machines aren't configured to use LXC out of the box, this requires a reboot and for some network configurations a bit of manual set up. The network bridging that is necessary might not be ideal for some users.  
 - The first `juju bootstrap` will take a long time, as up to 300mb of Ubuntu server packages are downloaded. These are cached so subsequent deployments are very fast, but the initial set up might take longer.
-- `juju debug-log` isn't as useful as tailing `$data-dir/machine-agent.log`
+- `Juju debug-log` isn't as useful as tailing `$data-dir/machine-agent.log`
 - Services that are running don't necessarily appear in netstat. 
 
 
@@ -119,7 +119,7 @@
         control-bucket: juju-a14dfae3830142d9ac23c499395c2785999
         admin-secret: 6608267bbd6b447b8c90934167b2a294999
         default-series: precise
-        juju-origin: ppa
+        Juju-origin: ppa
         data-dir: /home/jorge/whatever
 
 The ``data-dir`` is going to be where the containers and stuff will keep their data. As far as I can tell `control-bucket` and `admin-secret` can be whatever you want. 
@@ -134,7 +134,7 @@
   juju deploy wordpress
   juju add-relation wordpress mysql
 
-When it's deployed juju should return something like this in status::
+When it's deployed Juju should return something like this in status::
 
   machines:
     0:

=== modified file 'source/marketing.html'
--- source/marketing.html	2012-06-28 23:00:18 +0000
+++ source/marketing.html	2012-08-15 08:56:19 +0000
@@ -1,6 +1,6 @@
 <div class="row-fluid">
 <img alt="devops.png" class="attachment" src="_static/images/devops.png" title="devops.png" style="float:left;padding: 5px;" />
-<strong>Juju is <em><a href="/DevOps">DevOps</a> Distilled</em></strong><small><sup>TM</sup></small>. Through the use of <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>, juju provides you with shareable, re-usable, and repeatable expressions of <a href="/DevOps">DevOps</a> best practices.  You can use them unmodified, or easily change and connect them to fit your needs. Deploying a <a class="http" href="http://juju.ubuntu.com/Charms">charm</a> is similar to installing a package on Ubuntu: ask for it and it’s there, remove it and it’s completely gone.
+<strong>Juju is <em><a href="/DevOps">DevOps</a> Distilled</em></strong><small><sup>TM</sup></small>. Through the use of <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>, Juju provides you with shareable, re-usable, and repeatable expressions of <a href="/DevOps">DevOps</a> best practices.  You can use them unmodified, or easily change and connect them to fit your needs. Deploying a <a class="http" href="http://juju.ubuntu.com/Charms">charm</a> is similar to installing a package on Ubuntu: ask for it and it’s there, remove it and it’s completely gone.
 </div>
 
 <div class="row-fluid">
@@ -9,7 +9,7 @@
 
 <div class="row-fluid">
 <img alt="community.png" class="attachment" src="_static/images/community.png" title="community.png" style="float:left;padding: 5px;" />
-<strong>Juju is a community of <a href="/DevOps">DevOps</a> expertise.</strong> Most of the applications you want will be available in juju.  Juju provides direct and free access to a <a href="/DevOps">DevOps</a> community-contributed collection of <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>
+<strong>Juju is a community of <a href="/DevOps">DevOps</a> expertise.</strong> Most of the applications you want will be available in Juju.  Juju provides direct and free access to a <a href="/DevOps">DevOps</a> community-contributed collection of <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>
 </div>
 
 
@@ -37,7 +37,7 @@
 
 <div class="row-fluid">
 <img alt="easy.png" class="attachment" src="_static/images/easy.png" title="easy.png" style="float:left;padding: 5px;" />
-<strong>Juju is easy.</strong>  There’s no need to learn a domain specific language (DSL) to use juju or create <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>.  You can be up and running with your own <a class="http" href="http://juju.ubuntu.com/Charms">charm</a> in minutes.
+<strong>Juju is easy.</strong>  There’s no need to learn a domain specific language (DSL) to use Juju or create <a class="http" href="http://juju.ubuntu.com/Charms">charms</a>.  You can be up and running with your own <a class="http" href="http://juju.ubuntu.com/Charms">charm</a> in minutes.
 </div>
 
 <div class="row-fluid">

=== modified file 'source/provider-configuration-local.rst'
--- source/provider-configuration-local.rst	2012-01-30 14:49:36 +0000
+++ source/provider-configuration-local.rst	2012-08-15 08:56:19 +0000
@@ -2,7 +2,7 @@
 ----------------------------
 
 The local provider allows for deploying services directly against the local/host machine
-using LXC containers with the goal of experimenting with juju and developing formulas.
+using LXC containers with the goal of experimenting with Juju and developing formulas.
 
 The local provider has some additional package dependencies. Attempts to use
 this provider without these packages installed will terminate with a message