Merge lp:~rvb/maas/doc-bug-1391191 into lp:maas/trunk

Proposed by Raphaël Badin on 2014-11-10
Status: Merged
Approved by: Raphaël Badin on 2014-11-10
Approved revision: 3358
Merged at revision: 3358
Proposed branch: lp:~rvb/maas/doc-bug-1391191
Merge into: lp:maas/trunk
Diff against target: 67 lines (+23/-12)
2 files modified
INSTALL.txt (+10/-2)
docs/about.rst (+13/-10)
To merge this branch: bzr merge lp:~rvb/maas/doc-bug-1391191
Reviewer Review Type Date Requested Status
Gavin Panella (community) Approve on 2014-11-10
Graham Binns (community) 2014-11-10 Approve on 2014-11-10
Review via email: mp+241284@code.launchpad.net

Commit message

Fix documentation to point to the hacking guide (which explain where to get the source and how to build MAAS) and add reference to the development PPAs.

To post a comment you must log in.
Graham Binns (gmb) wrote :

Nice fix, ta!

review: Approve
Gavin Panella (allenap) wrote :

Nice improvements. I've suggested a couple of tweaks.

review: Approve
lp:~rvb/maas/doc-bug-1391191 updated on 2014-11-10
3358. By Raphaël Badin on 2014-11-10

Review fixes.

Raphaël Badin (rvb) wrote :

Thanks for the review(s)!

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'INSTALL.txt'
2--- INSTALL.txt 2014-10-24 05:53:08 +0000
3+++ INSTALL.txt 2014-11-10 16:39:25 +0000
4@@ -4,7 +4,7 @@
5 Installing MAAS
6 ===============
7
8-There are two main ways to install MAAS
9+There are two main ways to install MAAS:
10
11 * :ref:`From Ubuntu's package archive on an existing Ubuntu
12 install. <pkg-install>`
13@@ -12,7 +12,15 @@
14 media. <disc-install>`
15
16 If you are interested in testing the latest development version you
17-can also check out the very latest source and build MAAS yourself.
18+can also check out the very latest source and build MAAS — see
19+the :doc:`hacking guide <hacking>` — or use the `Testing PPA`_ or the
20+`Daily PPA`_. Note that these PPAs contain development versions of
21+MAAS that are potentially unstable, so use with caution.
22+
23+.. _Testing PPA:
24+ https://launchpad.net/~maas-maintainers/+archive/ubuntu/testing
25+.. _Daily PPA:
26+ https://launchpad.net/~maas-maintainers/+archive/ubuntu/dailybuilds
27
28
29 .. _pkg-install:
30
31=== modified file 'docs/about.rst'
32--- docs/about.rst 2013-08-06 05:38:39 +0000
33+++ docs/about.rst 2014-11-10 16:39:25 +0000
34@@ -15,15 +15,18 @@
35 ----------
36
37 In a cunning move, the current documentation always lives, and is
38-built from, the main MAAS source code. That means that whatever MAAS
39-package you have installed, or even if you are really living life on
40-the edge and have checked out a development version from Launchpad,
41-this documentation should be the latest and most appropriate version
42-for the software you are running. However, it is also possible that
43-there have been further sections or more helpful, or clearer bits
44-added since the package you are using was made. For this reason you
45-can always find the latest documentation online here:
46-http://maas.ubuntu.com
47+built from, the main MAAS source code (in the top-level ``docs/``
48+directory). That means that whatever MAAS package you have installed,
49+or even if you are really living life on the edge and have checked out
50+a development version from Launchpad, this documentation should be the
51+latest and most appropriate version for the software you are running.
52+However, it is also possible that there have been additional sections,
53+or more helpful and clearer bits added since the package you are using
54+was made. For this reason you can always find the latest documentation
55+online here: `http://maas.ubuntu.com`_.
56+
57+.. _http://maas.ubuntu.com:
58+ http://maas.ubuntu.com
59
60
61 Contributing
62@@ -44,4 +47,4 @@
63 Download the source to MAAS by following the instructions in
64 :doc:`the hacking guide <hacking>`, make your changes, and propose a merge
65 against lp:maas on Launchpad. The documentation source lives in the top-level
66-``doc/`` directory.
67+``docs/`` directory.