596089 - Distinguish between high and low-level packages

Status: RESOLVED FIXED

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

Description

[Atul Varma [:atul]]

Currently there's a number of packages that are low-level and/or part of the SDK's implementation, and don't really need to be shown to new developers lest it confuse them. It may still be useful to developers of low-level APIs, however, so the documentation should still be visible somewhere.

I propose that if a package.json's "keywords" array contains a particular entry, say "jetpack-low-level", then the documentation browser should use this as a hint to de-prioritize the display of the package's documentation, potentially putting it "under the fold" or somesuch.

Comment 1

[Atul Varma [:atul]]

Attachment: patch

Comment 2

[Atul Varma [:atul]]

This patch classifies 'test-harness', 'nsjetpack', and 'development-mode' as low-level packages using the "jetpack-low-level" keyword and adds a "More..." link at the bottom of the left-hand column of the documentation browser that, once clicked, slides-down the entries for all low-level packages.

Comment 3

[Atul Varma [:atul]]

Assuming folks are okay with this patch, once it's pushed I'd like to then move all the low-level modules out of jetpack-core and into a new low-level package called "foundation" (or something similar), which would take care of bug 592848.

Comment 4

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

Comment on attachment 474919 [details] [diff] [review]
patch

This is good, as far as it goes, although I'd like to see us providing a bit more context to readers about why those packages are hidden.

Comment 5

[Atul Varma [:atul]]

Thanks!

Pushed:

Bug 596089 - Distinguish between high and low-level packages
Atul Varma [:atul]
http://hg.mozilla.org/labs/jetpack-sdk/rev/cbb8d09c8cfa

Comment 6

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