Status

Add-on SDK
Documentation
P1
normal
RESOLVED FIXED
5 years ago
5 years ago

People

(Reporter: wbamberg, Assigned: wbamberg)

Tracking

unspecified
1.15
x86
Mac OS X

Firefox Tracking Flags

(Not tracked)

Details

(Assignee)

Description

5 years ago
For context, here's the current status and next steps for the SDK:

* SDK APIs are currently in Firefox 21 (as of yesterday, the Firefox Beta)
* these APIs are the same as the APIs in SDK 1.14
* SDK 1.14 is the last SDK release that will include the APIs
* at some point, tbd, there will be an SDK 1.15, consisting only of cfx
* Firefox 22 (shipping June 25) will be the first version in which the SDK APIs shipping in Firefox will diverge from the APIs shipped in SDK 1.14

I think we should from now on stop shipping the docs in the downloadable SDK. There are two reasons for this:

1) the SDK docs need to track the APIs: but if the downloadable SDK doesn't release in sync with Firefox any more, and the APIs are in Firefox, then they can't
2) the SDK doc generator uses the modules for various things (primarily metadata) so expects them to be present

This means that on June 25, or a few weeks earlier, we should publish the "Firefox 22" release of the SDK docs, which documents the APIs in Firefox 22 as well as the corresponding version of cfx.

We should disentangle the doc generation code from cfx, and retire cfx docs in the version of cfx that ships in 1.15 (or cfx docs could just launch a browser pointed at the online docs, if that's desirable).

This bug is for that disentangling work. We should have another bug for publishing the Firefox 22 docs.

Updated

5 years ago
Priority: -- → P1
(Assignee)

Updated

5 years ago
Assignee: nobody → wbamberg
(Assignee)

Comment 1

5 years ago
cfx docs was retired by this pull request: https://github.com/mozilla/addon-sdk/commit/c56dae93167df97d4b112c535d83a566cd6d1c61 (warning, this is a link to a very huge pull request).
Status: NEW → RESOLVED
Last Resolved: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.