launchpad-reviewers team mailing list archive

[Raphaël Badin <raphael.badin@xxxxxxxxxxxxx>]

Raphaël Badin has proposed merging lp:~rvb/maas/maas-doc-unif into lp:maas.

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~rvb/maas/maas-doc-unif/+merge/99510

This branch fixes a few quirks in the doc.
-- 
https://code.launchpad.net/~rvb/maas/maas-doc-unif/+merge/99510
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~rvb/maas/maas-doc-unif into lp:maas.

=== modified file 'INSTALL.txt'
--- INSTALL.txt	2012-03-27 11:01:53 +0000
+++ INSTALL.txt	2012-03-27 12:44:17 +0000
@@ -21,7 +21,7 @@
 
 Installing MAAS is straightforward. At the commandline, type::
 
-  sudo apt-get install maas
+    $ sudo apt-get install maas
 
 From a fresh Ubuntu 12.04 LTS install, MAAS will pull down around 200 MB of packages.
 
@@ -32,7 +32,7 @@
 
 At the commandline, type::
 
-  maas createsuperuser
+    $ maas createsuperuser
   
 Follow the prompts and MAAS will create an admin account that you can later use to log in.
 
@@ -45,12 +45,10 @@
 dnsmasq should already be installed. However, if it is not, enter the 
 following::
 
-  sudo apt-get install dnsmasq
+    $ sudo apt-get install dnsmasq
 
 MAAS enlists nodes using a tool called Cobbler. Cobbler provides a 
-configuration file for dnsmasq that you'll find here::
-
-  /etc/cobbler/dnsmasq.template
+configuration file for dnsmasq: `/etc/cobbler/dnsmasq.template`.
   
 Make the following changes:
 
@@ -60,9 +58,7 @@
  * ``dhcp-option=3,next_server``: replace **next_server** with the current 
                                   server's IP address.
  
-Save that file and now edit the Cobbler settings file::
-
-  /etc/cobbler/settings
+Save that file and now edit the Cobbler settings file: `/etc/cobbler/settings`.
 
 You need to change two settings:
 
@@ -71,7 +67,7 @@
  
 Now restart dnsmasq::
 
-  sudo /etc/init.d/dnsmasq restart
+    $ sudo /etc/init.d/dnsmasq restart
 
 
 Import the Ubuntu images
@@ -80,15 +76,15 @@
 MAAS will check for and download new Ubuntu images once a week. However, 
 you'll need to download them manually the first time::
 
-  sudo maas-import-isos
+    $ sudo maas-import-isos
 
 
 Next steps
 ==========
 
 Your MAAS is now ready for use. Visit the MAAS web interface in your browser 
-at::
+at `http://localhost/MAAS`_.
 
-  http://localhost/MAAS
+.. _http://localhost/MAAS: http://localhost/MAAS
   
 Now, :doc:`let's prepare your Juju environment <juju-quick-start>`.

=== modified file 'docs/juju-quick-start.rst'
--- docs/juju-quick-start.rst	2012-03-26 09:50:27 +0000
+++ docs/juju-quick-start.rst	2012-03-27 12:44:17 +0000
@@ -39,13 +39,11 @@
 #. Go to your `MAAS preferences page`_, or go to your `MAAS home
    page`_ and choose *Preferences* from the drop-down menu that
    appears when clicking your username at the top-right of the page.
-
+#. Optionally add a new MAAS key. Do this if you're setting up another
+   environment within the same MAAS cluster.
 .. _MAAS preferences page: http://localhost:5240/account/prefs/
 .. _MAAS home page: http://localhost:5240/
 
-#. Optionally add a new MAAS key. Do this if you're setting up another
-   environment within the same MAAS cluster.
-
 
 Creating environments.yaml
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -81,7 +79,7 @@
 
 As you've not bootstrapped you ought to see::
 
-  juju environment not found: is the environment bootstrapped?
+  $ juju environment not found: is the environment bootstrapped?
 
 Bootstrap::
 
@@ -127,16 +125,16 @@
 
 Now it's possible to deploy a charm::
 
-  juju deploy --repository /usr/share/doc/juju/examples local:mysql
-  juju status
+  $ juju deploy --repository /usr/share/doc/juju/examples local:mysql
+  $ juju status
 
 If you have another node free you can finish off the canonical and by
 now familiar example::
 
-  juju deploy --repository /usr/share/doc/juju/examples local:wordpress
-  juju add-relation wordpress mysql
-  juju expose wordpress
-  juju status
+  $ juju deploy --repository /usr/share/doc/juju/examples local:wordpress
+  $ juju add-relation wordpress mysql
+  $ juju expose wordpress
+  $ juju status
 
 Note that each charm runs on its own host, so each deployment will
 actually take as long as it took to bootstrap. Have a beer, drown your