Closed Bug 764894 Opened 8 years ago Closed 8 years ago

Improve TBPL's docs for setting up a dev environment

Categories

(Tree Management Graveyard :: TBPL, defect)

defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: emorley, Assigned: emorley)

References

Details

Attachments

(2 files)

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.
Attached patch Patch v1Splinter Review
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! :-)
Assignee: nobody → bmo
Status: NEW → ASSIGNED
Attachment #652220 - Flags: review?(rhelmer)
Attachment #652220 - Flags: review?(philringnalda)
Attachment #652220 - Flags: review?(mstange)
Comment on attachment 652220 [details] [diff] [review]
Patch v1

looks good to me
Attachment #652220 - Flags: review?(mstange) → review+
Comment on attachment 652220 [details] [diff] [review]
Patch v1

Looks great
Attachment #652220 - Flags: review?(rhelmer) → review+
Attachment #652220 - Flags: review?(philringnalda) → review+
Thank you for the reviews :-)

http://hg.mozilla.org/users/mstange_themasta.com/tinderboxpushlog/rev/9d98bcd79213
Status: ASSIGNED → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Attached patch Further tweaksSplinter Review
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.
Depends on: 786165
Product: Webtools → Tree Management
Product: Tree Management → Tree Management Graveyard
You need to log in before you can comment on or make changes to this bug.