613336 - remove Tutorial > Programs > Your First Program > Using the SDK's Built-in Libraries section of docs

Status: RESOLVED FIXED

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

Description

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

The Tutorial > Programs > Your First Program > Using the SDK's Built-in Libraries section of the docs is no longer necessary and should be removed.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: Patch for bug613336, and a few other bugs in the same file

Since there are a few small but important change in this file I thought it made sense to apply several at once rather than one at a time. So this patch only changes "programs.md" but includes fixes for the following bugs:

Blocker bugs:
613336 	remove Tutorial > Programs > Your First Program > Using the SDK's Built-in Libraries section of docs
613339 	Tutorial > Programs document should have Trying It Out section
613340 	Checking the Package section of Tutorial > Programs document should not reference mozrunner

Non-blocker, but very closely related bugs:
613611 	tutorial should reference my-first-package.xpi rather than test.xpi
613616 	Checking the Package section should explain how to install addon in more detail

Let me know if you would prefer separate patches for all these and I could do that. 

This code is also available in non-patch form at https://github.com/wbamberg/jetpack-sdk/tree/bug613336 .

Comment 2

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

Comment on attachment 492359 [details] [diff] [review]
Patch for bug613336, and a few other bugs in the same file

(In reply to comment #1)
> Let me know if you would prefer separate patches for all these and I could do
> that. 

No need for separate patches, this is great!


>+Select some text on that page and right-click to activate the context menu.
>+You should see a new item labelled "Translate Selection". Select that item and
>+the text you selected should be replaced with its English translation.

Nit: elsewhere (i.e. in the context-menu docs) we use the single-l spelling variant of the word "labeled", so we should do so here as well (or change those other references to be consistent.


>+You can do this by pressing the Ctrl+O key combination from within Firefox.
>+This will bring up a file selection dialog: navigate to the
>+my-first-package.xpi file, open it and follow the prompts to install the
>+add-on.

Nit: when referencing a keyboard shortcut, it's handy to include the Mac variant in a parenthetical reference, i.e.:

  You can do this by pressing the Ctrl+O key combination (Cmd+O on Mac)
  from within Firefox.

Otherwise looks good, r=myk.

Comment 3

[Will Bamberg [:wbamberg]]

Fixed by: https://github.com/mozilla/addon-sdk/commit/3b076246a5c4d31687647ddd517149da341f1579