952713 - Make redirects from the old SDK docs

Status: RESOLVED FIXED

(Cloud Services :: Operations: Marketplace, task)

Description

[Will Bamberg [:wbamberg]]

Now that the SDK docs are at: https://developer.mozilla.org/en-US/Add-ons/SDK, we need to set up redirects from https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/index.html.

Comment 1

[Will Bamberg [:wbamberg]]

Is it possible to have redirects on a per-page basis? For example, could we make

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/index.html redirect to https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials, and https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/indexed-db.html redirect to https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/indexed-db, and so on?

It would be great if we could do this. If we can, I can create a list of all the mappings that are needed.

Comment 2

[Jason Thomas [:jason]]

We should be able to create redirects on a per-page basis. Please provide us the list of mappings and we will add it to the nginx configuration.

Comment 3

[Will Bamberg [:wbamberg]]

Attachment: mappings

Comment 4

[Will Bamberg [:wbamberg]]

Sorry, please disregard that attachment!

Comment 5

[Will Bamberg [:wbamberg]]

Attachment: mappings23

Comment 6

[Will Bamberg [:wbamberg]]

Attachment: mappings24

Comment 7

[Will Bamberg [:wbamberg]]

Attachment: mappings25

Comment 8

[Will Bamberg [:wbamberg]]

Attachment: mappings26

Comment 9

[Will Bamberg [:wbamberg]]

I've added four attachments, one for each of the four versions of the SDK docs that are currently on AMO:

mappings23 -> https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-23/
mappings24 -> https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-24/
mappings25 -> https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-25/
mappings26 -> https://addons.mozilla.org/en-US/developers/docs/sdk/Firefox-26/

They're slightly different because of new docs being added and existing ones being (re)moved.

Each file lists mappings, one per line, in the format:

[old path],[new URL]

[old path] is given relative to the root for that docs install.

There are a few cases where the target no longer exists: in those cases I just redirected to the root of the SDK docs on MDN. Probably the only one of these that anyone might care about is the old "Credits" page, which will exist somewhere else, but doesn't yet.

Please let me know if anything looks wildly wrong about any of this, or if you would like this info in a different format.

I'm needinfoing Jeff just in case he wants a chance to complain about any of this before it happens.

Comment 11

[Jeff Griffiths (:canuckistani) (:⚡︎)]

No interest in complaining over here - looks great!

Comment 12

[Jeff Griffiths (:canuckistani) (:⚡︎)]

clearing the needinfo

Comment 13

[Jeremy Orem [:oremj]]

I see mappings for 23-26, do we also need a separate mapping for "latest"?

Comment 14

[Will Bamberg [:wbamberg]]

"latest" is just a symlink for "Firefox-24", so I don't know if you need separate mappings for it, but if you do, the mappings for Firefox 24 should be fine.

Comment 15

[Jeremy Orem [:oremj]]

Redirects are in place on addons-dev.allizom.org, e.g., https://addons-dev.allizom.org/en-US/developers/docs/sdk/latest/modules/sdk/indexed-db.html redirects properly.

Does everything look okay? When would you like me to push the changes to production?

Comment 16

[Will Bamberg [:wbamberg]]

Yes, it looks great. You can push the changes to production as soon as it's convenient for you.

Comment 17

[Jeremy Orem [:oremj]]

Pushed to production.

Comment 18

[Will Bamberg [:wbamberg]]

That's great! I think after a respectful period (3 months?) we should be able to remove the docs from addons.mozilla.org.

Comment 19

[Jeremy Orem [:oremj]]

To implement the redirects the docs have already been removed. Do you need me to put them back?

Comment 20

[Ben McCann]

Right now if I google for add on sdk then the first result is a 404:
https://addons.mozilla.org/en-US/developers/docs/sdk/latest

It'd be cool it that redirected to the new docs

Comment 21

[Will Bamberg [:wbamberg]]

Jeremy: no, I don't need them put back. Sorry for my misunderstanding.

Ben: yes, it totally should, thanks for catching that. Jeremy, is that a redirect you can add? 

https://addons.mozilla.org/en-US/developers/docs/sdk/latest -> https://developer.mozilla.org/en-US/Add-ons/SDK

Comment 22

[Jeremy Orem [:oremj]]

Added. Redirects are listed @ https://github.com/mozilla-services/svcops-puppet/blob/master/modules/marketplace/templates/nginx/addons/sdk_redirects.conf btw.

Comment 23

[Ben McCann]

cool. must not have taken effect yet though. i guess it takes a little while?

Comment 24

[Jeremy Orem [:oremj]]

It appears to be working now.

Comment 25

[Ben McCann]

Weird. I just tried from multiple computers and am still getting 404 for https://addons.mozilla.org/en-US/developers/docs/sdk/latest/

Comment 26

[Will Bamberg [:wbamberg]]

It looks like the trailing slash matters: https://addons.mozilla.org/en-US/developers/docs/sdk/latest redirects, but https://addons.mozilla.org/en-US/developers/docs/sdk/latest/ does not.

So I guess that mapping needs to be added as well. In fact, for every mapping I had that maps from "[path]/index.html" I guess we need 2 additional mappings, one from "[path]/" and one from "[path]". That would be:

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest],https://developer.mozilla.org/en-US/Add-ons/SDK/
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/,https://developer.mozilla.org/en-US/Add-ons/SDK/

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/,https://developer.mozilla.org/en-US/Add-ons/SDK/
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide,https://developer.mozilla.org/en-US/Add-ons/SDK/

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/guides/,https://developer.mozilla.org/en-US/Add-ons/SDK/Guides
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/guides,https://developer.mozilla.org/en-US/Add-ons/SDK/Guides

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/guides/content-scripts/,https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/guides/content-scripts,https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/tutorials/,https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/tutorials,https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials

https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/tutorials/annotator/,https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator
https://addons.mozilla.org/en-US/developers/docs/sdk/[Firefox-23|Firefox-24|Firefox-25|Firefox-26|latest]/dev-guide/tutorials/annotator,https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Annotator

Comment 27

[Jeremy Orem [:oremj]]

https://github.com/mozilla-services/svcops-puppet/commit/ac80beae42fd7ec183ae6420158bbcfa41ee4f45