764894 - Improve TBPL's docs for setting up a dev environment

Status: RESOLVED FIXED

(Tree Management Graveyard :: TBPL, defect)

Description

[Ed Morley [:emorley]]

http://hg.mozilla.org/users/mstange_themasta.com/tinderboxpushlog/file/tip/README
and
http://hg.mozilla.org/users/mstange_themasta.com/tinderboxpushlog/file/tip/README.vagrant

Bug 759313 removed the out of date steps of creating cache & summaries directories, but there are still several more changes I'd like to make, particularly for the Windows & Vagrant cases.

Note to self: Also need to adjust README.vagrant to account for bug 757036.

Comment 1

[Ed Morley [:emorley]]

Attachment: Patch v1

Various tweaks to readme + readme.vagrant

Requesting review from a few people to make sure I haven't missed anything (and rhelmer knows more about Vagrant than I do).

Thank you! :-)

Comment 2

[Markus Stange [:mstange]]

Comment on attachment 652220 [details] [diff] [review]
Patch v1

looks good to me

Comment 3

[Robert Helmer [:rhelmer]]

Comment on attachment 652220 [details] [diff] [review]
Patch v1

Looks great

Comment 4

[Ed Morley [:emorley]]

Thank you for the reviews :-)

http://hg.mozilla.org/users/mstange_themasta.com/tinderboxpushlog/rev/9d98bcd79213

Comment 5

[Ed Morley [:emorley]]

Attachment: Further tweaks

Whilst helping ewong set up a TBPL environment using README.vagrant, I was asked whether he needed to install an OS in the VM himself or not & also how much free space was required.

This patch:
* Makes the purpose of Vagrant clearer & explicitly states no manual OS required.
* Mentions the free space required.
* Adjusts the order of the steps slightly to be more clear.
* Adds the hg clone step, which whilst obvious once you have the repo, is useful for when I give people a link to README.vagrant on hgweb, via IRC etc.
* Makes the SSH steps more clearly optional, by separating them out into their own section.

Just going to land this with r=me, since just copy/order/formatting changes on the whole.

Comment 6

[Ed Morley [:emorley]]

Comment on attachment 654549 [details] [diff] [review]
Further tweaks

http://hg.mozilla.org/users/mstange_themasta.com/tinderboxpushlog/rev/3fe5fa1631bc