553064 - Make older versions of the Jetpack SDK docs prominently display a link to the latest docs

Status: RESOLVED WONTFIX

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

Description

[Atul Varma [:atul]]

Once we release the SDK 0.2, a banner should be prominently displayed at the top of the static 0.1 docs [1] mentioning that the documentation is outdated, with a link to the 0.2 docs. This will allow the 0.1 docs to still be archived and viewable/usable while letting people know that a newer version of the SDK is available.

Potentially this could be done on the client-side via a cross-site XHR, e.g. by loading jetpack.mozillalabs.com/sdk/latest.json, and then dynamically displaying the banner if the version specified in latest.json isn't the same as the version of the docs being displayed.

[1] https://jetpack.mozillalabs.com/sdk/0.1/docs/

Comment 1

[Brian Warner [:warner :bwarner]]

Zandr and I were talking about a form of "cfx docs" that writes out a directory of static files, so that we could serve them from apache without leaving a "cfx" process running all the time. Perhaps we could put a footer.html or latest_docs_link.html in this directory, normally empty, and when we release a new version of the SDK, we go back through the statically-rendered old docs trees and update this file with a pointer to the latest ones.

Might be easier than cross-site XHR, I'd imagine..

Comment 2

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

This is important to do, but I don't think it actually blocks the release of the SDK, since we can change it afterwards and still get the benefits of migrating users at that point (i.e. it's not now or never).  Thus removing it from the blocking list, but let's still prioritize making this happen so we can get those 0.1 users migrated to 0.2!

Comment 3

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

Comment 4

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

Rather than make SDK changes, we're going to make sure existing docs get updated to point to the 1.0 docs once 1.0 is released.