Distinguish between high and low-level packages

RESOLVED FIXED

Status

RESOLVED FIXED
8 years ago
8 years ago

People

(Reporter: avarma, Assigned: avarma)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Assignee)

Description

8 years ago
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.
(Assignee)

Comment 1

8 years ago
Created attachment 474919 [details] [diff] [review]
patch
(Assignee)

Comment 2

8 years ago
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.
Assignee: nobody → avarma
Status: NEW → ASSIGNED
(Assignee)

Comment 3

8 years ago
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.
(Assignee)

Updated

8 years ago
Attachment #474919 - Flags: review?(myk)
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.
Attachment #474919 - Flags: review?(myk) → review+
(Assignee)

Comment 5

8 years ago
Thanks!

Pushed:

Bug 596089 - Distinguish between high and low-level packages
Atul Varma [:atul]
http://hg.mozilla.org/labs/jetpack-sdk/rev/cbb8d09c8cfa
Status: ASSIGNED → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED
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".
Component: Jetpack SDK → General
Product: Mozilla Labs → Add-on SDK
QA Contact: jetpack-sdk → general
You need to log in before you can comment on or make changes to this bug.