Closed Bug 548165 Opened 11 years ago Closed 11 years ago

0.1 Release - SDK Documentation

Categories

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

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: dbuchner, Assigned: avarma)

References

Details

(Whiteboard: [release])

Work with Atul to expose whatever exists in the way of SDK documentation in the content we release to the various communication channels.
The Jetpack docs are currently available here, but the location is completely temporary:

  https://ubiquity.mozilla.com/jetpack-sdk-docs/

Because the SDK docs are entirely self-contained in each release, I would really like to do something along the lines of what Django, Python, and other software development tools do, whereby developers can actually see the docs for any version of the platform online. In other words, I'd like to propose a structure like this:

  https://jetpack.mozillalabs.com/docs/0.1/
  https://jetpack.mozillalabs.com/docs/0.2/

And so forth. These would just point to the (totally static) docs for each version.
We could also have https://jetpack.mozillalabs.com/docs/latest/ be either a redirect or an alias to the latest version of the docs.

Perhaps https://jetpack.mozillalabs.com/docs/trunk/ could even point to the latest docs on the hg trunk.
I think those are great ideas, Atul.  But we should be careful to remove wiki pages that become duplicated or obsolete (like the reboot glossary, which is now in the SDK docs).
Cc'ing Zandr, hopefully he can help us get this up on a server before launch.
Blocks: 550214
As long as we don't launch before lunch. (Sorry, that's how I read it the first time)

So, I'm going to install the docs under docs/0.1/ as a wsgi app for now. Supporting multiple versions might be annoying/scale poorly, so we'll cross that bridge shortly.
Thanks Zandr! Do you think you could actually put it under 'sdk/0.1/docs/'?  That way we can potentially associate other things with releases as necessary, e.g. 'sdk/0.1/download', 'sdk/0.1/release-notes', etc.
https://jetpack.mozillalabs.com/sdk/0.1/docs/

Bonus points to someone who can explain the trailing slash problem. :D
Status: NEW → RESOLVED
Closed: 11 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
Version: 0.1 → unspecified
You need to log in before you can comment on or make changes to this bug.