MAAS

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

  1. doc-bug-1391191
  2. Merge into trunk
Proposed by Raphaël Badin
Status: Merged
Approved by: Raphaël Badin
Approved revision: no longer in the source branch.
Merged at revision: 3358
Proposed branch: lp:~rvb/maas/doc-bug-1391191
Merge into: lp:~maas-committers/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
Graham Binns (community) Approve
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.
Revision history for this message
Graham Binns (gmb) wrote :

Nice fix, ta!

review: Approve
Revision history for this message
Gavin Panella (allenap) wrote :

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

review: Approve
Revision history for this message
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
=== modified file 'INSTALL.txt'
--- INSTALL.txt 2014-10-24 05:53:08 +0000
+++ INSTALL.txt 2014-11-10 16:39:25 +0000
@@ -4,7 +4,7 @@
4Installing MAAS4Installing MAAS
5===============5===============
66
7There are two main ways to install MAAS7There are two main ways to install MAAS:
88
9 * :ref:`From Ubuntu's package archive on an existing Ubuntu9 * :ref:`From Ubuntu's package archive on an existing Ubuntu
10 install. <pkg-install>`10 install. <pkg-install>`
@@ -12,7 +12,15 @@
12 media. <disc-install>`12 media. <disc-install>`
1313
14If you are interested in testing the latest development version you14If you are interested in testing the latest development version you
15can also check out the very latest source and build MAAS yourself.15can also check out the very latest source and build MAAS — see
16the :doc:`hacking guide <hacking>` — or use the `Testing PPA`_ or the
17`Daily PPA`_. Note that these PPAs contain development versions of
18MAAS that are potentially unstable, so use with caution.
19
20.. _Testing PPA:
21 https://launchpad.net/~maas-maintainers/+archive/ubuntu/testing
22.. _Daily PPA:
23 https://launchpad.net/~maas-maintainers/+archive/ubuntu/dailybuilds
1624
1725
18.. _pkg-install:26.. _pkg-install:
1927
=== modified file 'docs/about.rst'
--- docs/about.rst 2013-08-06 05:38:39 +0000
+++ docs/about.rst 2014-11-10 16:39:25 +0000
@@ -15,15 +15,18 @@
15----------15----------
1616
17In a cunning move, the current documentation always lives, and is17In a cunning move, the current documentation always lives, and is
18built from, the main MAAS source code. That means that whatever MAAS18built from, the main MAAS source code (in the top-level ``docs/``
19package you have installed, or even if you are really living life on19directory). That means that whatever MAAS package you have installed,
20the edge and have checked out a development version from Launchpad,20or even if you are really living life on the edge and have checked out
21this documentation should be the latest and most appropriate version21a development version from Launchpad, this documentation should be the
22for the software you are running. However, it is also possible that22latest and most appropriate version for the software you are running.
23there have been further sections or more helpful, or clearer bits23However, it is also possible that there have been additional sections,
24added since the package you are using was made. For this reason you24or more helpful and clearer bits added since the package you are using
25can always find the latest documentation online here:25was made. For this reason you can always find the latest documentation
26http://maas.ubuntu.com26online here: `http://maas.ubuntu.com`_.
27
28.. _http://maas.ubuntu.com:
29 http://maas.ubuntu.com
2730
2831
29Contributing32Contributing
@@ -44,4 +47,4 @@
44Download the source to MAAS by following the instructions in47Download the source to MAAS by following the instructions in
45:doc:`the hacking guide <hacking>`, make your changes, and propose a merge48:doc:`the hacking guide <hacking>`, make your changes, and propose a merge
46against lp:maas on Launchpad. The documentation source lives in the top-level49against lp:maas on Launchpad. The documentation source lives in the top-level
47``doc/`` directory.50``docs/`` directory.