559251 - clarify documentation for install guide for the sdk

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Noelle Murata]

User-Agent:       Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3
Build Identifier: jetpack-sdk 0.2rc2

Modify the documentation to include stepwise instructions for installing and activating the sdk; particular clarity to path definition.

Reproducible: Always

Steps to Reproduce:
if the path does not include the python libs directory, windows (particularly) is not able to run cfx or any of the tools properly
Actual Results:  
'python' not defined...

Expected Results:  
installing and operating the cfx tool

Comment 1

[Myk Melez [:myk] [@mykmelez]]

Noelle mentioned to me that she can take this on, so assigning it to her.

Comment 2

[Noelle Murata]

Attachment: proposed patch, see comment

I added a small section about verifying/adding python to the path and did a little bit of wordsmithing for a bit more clarity. I don't want to fully overhaul it as it seems to be working out okay as it is.

Comment 3

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 441657 [details] [diff] [review]
proposed patch, see comment

Looks good, with the nit that it looks like a couple lines sprung extra trailing spaces unnecessarily.

r=myk, and this is low-risk so acceptable during the 0.3 freeze.  Thus I'll commit it before spinning the 0.3rc2 build.

Comment 4

[Myk Melez [:myk] [@mykmelez]]

Fixed by changeset https://hg.mozilla.org/labs/jetpack-sdk/rev/06031b56312a.

Comment 5

[Myk Melez [:myk] [@mykmelez]]

The Add-on SDK is no longer a Mozilla Labs experiment and has become a big enough project to warrant its own Bugzilla product, so the "Add-on SDK" product has been created for it, and I am moving its bugs to that product.

To filter bugmail related to this change, filter on the word "looptid".