565204 - Restructure SDK docs

Status: RESOLVED FIXED

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

Description

[Noelle Murata]

As per a deliverable of 0.4; tracked in bugzilla for patch reviews/etc.

Comment 1

[Noelle Murata]

Attachment: cfx docs restructure proposal

Comment 2

[Noelle Murata]

Can you review & provide feedback?

Comment 3

[Atul Varma [:atul]]

Comment on attachment 444803 [details]
cfx docs restructure proposal

Looks great to me, thanks!

Comment 4

[Dietrich Ayala (:dietrich)]

I really like the 0.5 plan for the tutorial part. Breaking out the Packaging page into more focused pages sounds awesome.

Per IRC: The How-to section looks little odd at this point, because the only item it has is something that we want to be available, but don't want to highlight.

"here's how to hack Jetpack into your old crufty extensions" is something that belongs in the Reference section, I think.

I'd expect the How-to section to have cool examples that we want to showcase.

Comment 5

[Brian Warner [:warner :bwarner]]

Comment on attachment 444803 [details]
cfx docs restructure proposal

looks good to me too. I don't know what "LLJAPI" is (I can guess), but I figure the real table of contents will expand that a bit more.

Comment 6

[Atul Varma [:atul]]

LLJAPI is defined in our glossary:

  https://jetpack.mozillalabs.com/sdk/0.3/docs/#guide/glossary

Er, so actually, "Low-Level Jetpack API" is defined, but LLJAPI isn't mentioned as an acronym for it. I should change that.

Comment 7

[Drew Willcoxon :adw]

Noelle, any updates on this?  As it pertains to bug 571114, I can write the actual text (unless you'd like to of course) for both Plan A in this bug and the Plan B mentioned in bug 571114, if that would help.  Either way, we should try to land before freeze on Friday to make sure it gets in.

Comment 8

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

Erm, the freeze is actually tomorrow, Tuesday, June 15 (11:59pm PT).

Comment 9

[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".

Comment 10

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

We've restructured SDK docs since!