704700 - [AMO] update SDK docs for 1.3 release

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: Public Pages, defect)

Description

[Will Bamberg [:wbamberg]]

Please update the documentation for the Add-on SDK in conjunction with its 1.3 release.

Clone the docs from <git://github.com/mozilla/addon-sdk-sdocs.git>, and check out the 1.3rc1-amo tag, i.e.:

  git clone git://github.com/mozilla/addon-sdk-sdocs.git
  cd addon-sdk-sdocs
  git checkout 1.3rc1-amo

Then push the docs to <https://addons.mozilla.org/en-US/developers/docs/sdk/1.3/>.

The 1.3 release will happen in a week's time, on Tuesday November 29th. It would be great if the docs could be pushed by this Friday (the 25th), so we can check that they look OK, then we have time to fix any problems.

Once we've verified that they look good, update the redirect at <https://addons.mozilla.org/en-US/developers/docs/sdk/latest/> to point to <https://addons.mozilla.org/en-US/developers/docs/sdk/1.3/>: this should not be done until the release is ready to go.

Comment 1

[Jeremy Orem [:oremj]]

This needs to go through the addons team first for tagging.

Comment 2

[Wil Clouser [:clouserw]]

SDK docs in vendor at https://github.com/mozilla/zamboni-lib/commit/b340684a8e0172c4aef9abcf5340fcdad4c93b0a

vendor tagged at https://github.com/mozilla/zamboni/commit/f7488614e521db3b85be7fe11ef317aee5eed19b

Should be on -dev already

Comment 3

[Jeremy Orem [:oremj]]

I added the following to the dev/stage/prod vhosts, so any sdk additions should just work:

AliasMatch /en-US/developers/docs/sdk/(latest|[\d\.]+)(/.*)? /data/www/addons.mozilla.org/zamboni/vendor/src/addon-sdk-docs-$1$2


Assigning to addons for 1.3 switch.

Comment 4

[Wil Clouser [:clouserw]]

(In reply to Jeremy Orem [:oremj] from comment #3)
> I added the following to the dev/stage/prod vhosts, so any sdk additions
> should just work:
> 
> AliasMatch /en-US/developers/docs/sdk/(latest|[\d\.]+)(/.*)?
> /data/www/addons.mozilla.org/zamboni/vendor/src/addon-sdk-docs-$1$2
> 
> 
> Assigning to addons for 1.3 switch.

Can you revert that change (or adjust it) until we do our push on Thursday?  It seems to have broken us: https://addons.mozilla.org/en-US/developers/docs/sdk/latest/

Comment 5

[Jeremy Orem [:oremj]]

Fixed that.

Comment 6

[Wil Clouser [:clouserw]]

1.3 is switched.  As far as I know these are the right docs: https://addons-dev.allizom.org/en-US/developers/docs/sdk/latest/

I don't see a way to see what version of docs are shown on the page though.

Comment 7

[Will Bamberg [:wbamberg]]

(In reply to Wil Clouser [:clouserw] from comment #6)
> 1.3 is switched.  As far as I know these are the right docs:
> https://addons-dev.allizom.org/en-US/developers/docs/sdk/latest/
> 
> I don't see a way to see what version of docs are shown on the page though.

Yeah, that's the right version. 1.4 will show the version on each page, but for now the file to look at is https://addons-dev.allizom.org/en-US/developers/docs/sdk/latest/dev-guide/addon-development/installation.html, which says:

"At the moment, the latest stable version of the Add-on SDK is 1.3."

The styles are broken and the links don't work, because the docs don't expect to be at "allizom.org", but that should be fixed when they are at addons.mozilla.org.