jetpack-core should be marked as a low-level package

RESOLVED FIXED

Status

Add-on SDK
General
RESOLVED FIXED
8 years ago
8 years ago

People

(Reporter: atul, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Reporter)

Description

8 years ago
In bug 596406 we moved all the high-level modules out of jetpack-core into addon-kit, which means jetpack-core is now a 100% low-level module. We should mark it as such by adding the 'jetpack-low-level' keyword to its package.json, which will be processed by the documentation generator as specified in bug 596089.
(Reporter)

Comment 1

8 years ago
Created attachment 480227 [details] [diff] [review]
patch
(Reporter)

Updated

8 years ago
Attachment #480227 - Flags: review?(warner-bugzilla)
Comment on attachment 480227 [details] [diff] [review]
patch

looks good to me. Do you want to also change the description to something like "Low-level helper modules, meant for module authors" ? As it stands, once you've expanded the package list (in 'cfx docs', via the "More.." button), jetpack-core looks more applicable than addon-kit (which reads "Add-on development made easy", and which perhaps should be the one to claim the title "The core Jetpack library").
Attachment #480227 - Flags: review?(warner-bugzilla) → review+
(Reporter)

Comment 3

8 years ago
Good idea, I've set the description to "Foundational infrastructure and utilities." for now.

Pushed:

Bug 601227 - jetpack-core should be marked as a low-level package (r=warner)
Atul Varma
http://hg.mozilla.org/labs/jetpack-sdk/rev/ee3d5c8a5783
Status: NEW → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED
Atul: the tree is currently frozen, so patches for non-blockers like this one need approval before landing.  In this case, the patch is reasonable to land, so no need to back it out, but make sure you get approval from a driver in advance next time.
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.