Merge lp:~adam-collard/landscape-charm/fix-landscape-readme into lp:~landscape/landscape-charm/stable

[Adam Collard]

Update the README to fix some formatting issues and update out of date text.

Update the README to fix some formatting issues and update out of date text.

http://markable.in/editor/ is a handy way of checking formatting

[🤖 Landscape Builder (landscape-builder)]

Command: make test
Result: Success
Revno: 224
Branch: lp:~adam-collard/landscape-charm/fix-landscape-readme
Jenkins: https://ci.lscape.net/job/latch-test/428/

review: Approve (test results)

[David Britton (dpb)]

+1 with small format changes inline

review: Approve

[Alberto Donato (ack)]

+1, just one formatting suggestion.

review: Approve

[lp:~adam-collard/landscape-charm/fix-landscape-readme]

225. By Adam Collard on 2015-04-09

Incorporate formatting suggestions from dpb and ack

=== modified file 'README.md'
--- README.md	2015-03-23 19:23:57 +0000
+++ README.md	2015-04-09 11:01:32 +0000
@@ -10,7 +10,7 @@
 connected to other charms to be fully functional. Example deployments are given
 below.
 
-For more information about Landscape, go to http://www.ubuntu.com/management
+For more information about Landscape, go to [Ubuntu Advantage](http://www.ubuntu.com/management)
 
 Standard Usage
 ==============
@@ -20,15 +20,16 @@
 
 Please use one of the following bundle types depending on your needs:
 
-  https://jujucharms.com/u/landscape/landscape-scalable/
-  https://jujucharms.com/u/landscape/landscape-dense-maas/
-  https://jujucharms.com/u/landscape/landscape-dense/
-
-For the landscape-scalable case:
-
-  sudo apt-add-repository ppa:juju/stable
-  sudo apt-get update
-  juju quickstart u/landscape/landscape-scalable
+ * [landscape-scalable](https://jujucharms.com/u/landscape/landscape-scalable/)
+ * [landscape-dense-maas](https://jujucharms.com/u/landscape/landscape-dense-maas/)
+ * [landscape-dense](https://jujucharms.com/u/landscape/landscape-dense/)
+
+For the `landscape-scalable` case:
+
+    $ sudo apt-add-repository ppa:juju/stable
+    $ sudo apt-get update
+    $ sudo apt-get install juju-quickstart
+    $ juju quickstart u/landscape/landscape-scalable
 
 
 Customized Deployments
@@ -45,17 +46,21 @@
 Configuration
 =============
 
-Landscape is a commercial product and as such it needs configuration of a 
-license and password protected repository before deployment.  Please login to 
-your "hosted account" (on landscape.canonical.com) to gather these details 
-after purchasing seats for LDS.  All information is found by following a link 
-on the left side of the page called "access the Landscape Dedicated Server 
-archive"
+Landscape is a commercial product which is bundled with a license
+allowing management of up to 10 physical machines and 10 more virtual
+machines, for a total of 20.
+
+If you need to manage more machines then you'll need to configure a
+license and password protected repository before deployment.  Please
+login to your [hosted account](https://landscape.canonical.com/) to
+gather these details after purchasing seats for LDS.  All information
+is found by following a link on the left side of the page called
+"access the Landscape Dedicated Server archive"
 
 license-file
 ------------
 
-You can set this as a juju configuration option after deployment
+You can set this as a Juju configuration option after deployment
 on each deployed landscape-service like:
 
     $ juju set <landscape-service> "license-file=$(cat license-file)"
@@ -68,15 +73,15 @@
 While useful for testing, this must not be used for production deployments.
 
 For production deployments, you should include a "real" SSL certificate key
-pair that has been signed by a CA that your clients trust in the apache charm
+pair that has been signed by a CA that your clients trust in the Apache charm
 configuration.
 
 
 Unit Testing
 ============
 
-The Landscape charm is fairly well unit tested and new code changes
-should be submitted with unit tests.  You can run them like this:
+The Landscape charm is unit tested and new code changes should be
+submitted with unit tests.  You can run them like this:
 
     $ sudo apt-get install python-twisted-core
     $ make test
@@ -85,9 +90,11 @@
 Integration Testing
 ===================
 
-This charm makes use of juju-deployer and the charm-tools package to enable
-end-to-end integration testing.  This is how you proceed with running
-them:
+This charm makes use of
+[juju-deployer](http://pythonhosted.org/juju-deployer/) and
+[charm-tools](https://jujucharms.com/docs/1.20/tools-charm-tools) to
+enable end-to-end integration testing.  This is how you proceed with
+running them:
 
     # Make sure your JUJU_ENV is *not* bootstrapped, and:
     $ sudo apt-get install python-pyscopg2 python-mocker python-psutil