695056 - [AMO] Update Add-on SDK docs for 1.2

Status: RESOLVED FIXED

(Infrastructure & Operations Graveyard :: WebOps: Other, task)

Description

[Will Bamberg [:wbamberg]]

Please update the documentation for the Add-on SDK, for the SDK's 1.2 release. The documentation should be hosted at: https://addons.mozilla.org/en-US/developers/docs/sdk/1.2/.

The repo to pull the docs from is https://github.com/mozilla/addon-sdk-sdocs, and the commit to use is tagged as 1.2rc1-amo. So to fetching the relevant documentation set should just be a matter of:

> git pull
> git checkout 1.2rc1-amo

The 1.2 release is tomorrow (Tuesday), and at that point https://addons.mozilla.org/en-US/developers/docs/sdk/latest/ should be updated to point to https://addons.mozilla.org/en-US/developers/docs/sdk/1.2/ (I'm not sure whether we should have a separate bug for this, but it seems like overkill to me).

But I'd be very, very happy if the docs at https://addons.mozilla.org/en-US/developers/docs/sdk/1.2/ could be updated today, then I could check that they look all right and fix any problems.

Comment 1

[Jeremy Orem [:oremj]]

Wil is going to update this for you.

Comment 2

[Wil Clouser [:clouserw]]

This is done on -dev:

https://addons-dev.allizom.org/en-US/developers/docs/sdk/1.2/

The URL is a 404 though.  It looks like you changed the structure of the docs?  Where should the alias be pointing now?

Comment 3

[Will Bamberg [:wbamberg]]

(In reply to Wil Clouser [:clouserw] from comment #2)
> This is done on -dev:
> 
> https://addons-dev.allizom.org/en-US/developers/docs/sdk/1.2/
> 
> The URL is a 404 though.  It looks like you changed the structure of the
> docs?  Where should the alias be pointing now?

Yes, I changed the structure of the docs, but that should not affect anything. The root is still /index.html: https://github.com/mozilla/addon-sdk-sdocs

Comment 4

[Wil Clouser [:clouserw]]

Got it.  The code is there, the rewrite is using 'addons' instead of 'addon' though which is why it's a 404.  -> oremj

Comment 5

[Will Bamberg [:wbamberg]]

(In reply to Wil Clouser [:clouserw] from comment #4)
> Got it.  The code is there, the rewrite is using 'addons' instead of 'addon'
> though which is why it's a 404.  -> oremj

Do you mean, it's at https://addon.mozilla.org/en-US/developers/docs/sdk/1.2/ ? I get 403 Forbidden for that.

Can you let me know when it's at https://addons.mozilla.org/en-US/developers/docs/sdk/1.2/, and I'll check it looks OK?

Comment 6

[Jeremy Orem [:oremj]]

This is all set up on dev. When should we push to stage/prod?

Comment 7

[Will Bamberg [:wbamberg]]

What's at https://addons-dev.allizom.org/en-US/developers/docs/sdk/1.2/ looks OK, except that none of the styles are there, because it expects to be at https://addon.mozilla.org/en-US/developers/docs/sdk/1.2/. (This is actually kind of crappy, and something I need to fix for the next release, I think.)

What I'd like, would be for you to make it available at https://addon.mozilla.org/en-US/developers/docs/sdk/1.2/ now, then I could check that it's OK. Then tomorrow, at the time we announce SDK 1.2, you could update https://addon.mozilla.org/en-US/developers/docs/sdk/latest/ to point to https://addon.mozilla.org/en-US/developers/docs/sdk/1.2/.

Is that possible?

Comment 8

[Jeremy Orem [:oremj]]

Wil, I think we will have to do a prod push for this. Let me know when you want to do that.

Comment 9

[Wil Clouser [:clouserw]]

Tomorrow I guess.  We have to do one on the builder at 3pm anyway.  Could do this at 2:45?

Comment 10

[Will Bamberg [:wbamberg]]

I'm sorry, that should be:

https://addons.mozilla.org/en-US/developers/docs/sdk/1.2/

Plural addons.

Comment 11

[Jeremy Orem [:oremj]]

Sure, around 245 wfm. Just ping me when you are ready.

Comment 12

[Jeremy Orem [:oremj]]

Will, the docs are on amo now.

Comment 13

[David Mason [:dcm :dmason]]

The docs pushed were the 1.0 docs - not 1.2

Comment 14

[Jeremy Orem [:oremj]]

Should be fixed now.