820897 - Pre-1.12 "latest" links to 404 moved modules

Status: VERIFIED FIXED

(Cloud Services :: Operations: Marketplace, task, P1)

Description

[Ed Lee :Mardak]

For example, somehow people are trying to load links to the following which worked for 1.11

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/packages/addon-kit/self.html

But the new link for that page with 1.12 is

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/self.html


I'm not sure if people are clicking old search links or have them bookmarked. I happened to run into it because I had the page open and refreshed and hit 404.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: list of redirects

What I'd like to do to fix this is to redirect pages like:

    sdk/latest/packages/addon-kit/clipboard.html

to:

    sdk/1.12/modules/sdk/clipboard.html

I've attached a file containing a redirect like this for every file that moved between SDK 1.11 and SDK 1.12, in the format <old_location> <new_location>. Is it possible to update addons.mozilla.org to implement these redirects?

Comment 2

[Ed Lee :Mardak]

Any particular reason to redirect to sdk/1.12/packages/... instead of sdk/latest/modules/... ?

Comment 3

[Ed Lee :Mardak]

Grr no conflict warning.

Comment 4

[Will Bamberg [:wbamberg]]

You mean sdk/1.12/modules/... ? Yeah, maybe that's a better idea.

Comment 5

[Will Bamberg [:wbamberg]]

Attachment: list of redirects-2

Updated to make the redirects point to sdk/latest/blah instead of sdk/1.12/blah

Comment 6

[Will Bamberg [:wbamberg]]

Attachment: a patch

Since it seems that redirects are not a viable solution to this, here's a patch that adds a new file, "404.html", under sdk/1.12/dev-guide, that tries to point people in useful directions.

We'll give people sdk/latest/dev-guide/404.html when we get a 404.

Once we agree on this plan and wording, I'll add the .md file to the SDK docs, and in future releases the HTML version will just get generated along with all the other docs.

But as a one-off, I'll add the HTML version individually to this repo under 1.12, so we can fix things for 1.12.

Comment 7

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

Comment on attachment 693746 [details] [diff] [review]
a patch

Works for me.

Comment 8

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

I've forked the repo and created a pull request with the patch included:

https://github.com/mozilla/addon-sdk-sdocs/pull/1

Comment 9

[Will Bamberg [:wbamberg]]

OK, I've merged that pull request. Can we update the server to serve that page when we can't find what we're asked for?

Comment 10

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

Sure, I'll get :oremj to push this tomorrow.

Comment 11

[Will Bamberg [:wbamberg]]

Did this ever get done? I'm still seeing plain 404 pages at https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.

Comment 12

[Eddy Bruel [:ejpbruel]]

(In reply to Will Bamberg [:wbamberg] from comment #11)
> Did this ever get done? I'm still seeing plain 404 pages at
> https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.

I believe I filed a pull request that should have fixed these issues. Did I do it wrong?
https://github.com/mozilla/FlightDeck/pull/178

Comment 13

[Eddy Bruel [:ejpbruel]]

(In reply to Will Bamberg [:wbamberg] from comment #11)
> Did this ever get done? I'm still seeing plain 404 pages at
> https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.

Oh I suddenly recalled that this patch alone was not enough to fix the problem because flightdeck did some kind of redirect it shouldn't do. I believe Wes can tell you more.

Comment 14

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

(In reply to Eddy Bruel [:ejpbruel] from comment #13)
> (In reply to Will Bamberg [:wbamberg] from comment #11)
> > Did this ever get done? I'm still seeing plain 404 pages at
> > https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.
> 
> Oh I suddenly recalled that this patch alone was not enough to fix the
> problem because flightdeck did some kind of redirect it shouldn't do. I
> believe Wes can tell you more.

That's an issue on Builder's end, this bug was for the SDK's hosted documentation.

Comment 15

[Will Bamberg [:wbamberg]]

(In reply to Eddy Bruel [:ejpbruel] from comment #12)
> (In reply to Will Bamberg [:wbamberg] from comment #11)
> > Did this ever get done? I'm still seeing plain 404 pages at
> > https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.
> 
> I believe I filed a pull request that should have fixed these issues. Did I
> do it wrong?
> https://github.com/mozilla/FlightDeck/pull/178

I think your pull request is intended to fix a different set of links, specifically the links in https://builder.addons.mozilla.org/tutorial/.

Actually, your PR should probably be extended to fix some other links in Builder, such as the three under "Learn" at https://builder.addons.mozilla.org/.

But the fixes in the PR don't seem to work, because it looks like the Builder does some rebasing of the links you give it, so "/docs/sdk/latest/modules/widget.html" becomes "https://addons.mozilla.org/en-US/developers/docs/sdk/latest/packages/addon-kit/sdk/latest/modules/widget.html". (Also, the path from "sdk" is actually "latest/modules/sdk/module-name.html", note the second "sdk" to mirror the module tree in the SDK itself.)

Maybe it would work if you gave it a full URL, like "https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/widget.html"?

Anyway, this bug is about the sad fact that SDK documentation links like "https://addons.mozilla.org/en-US/developers/docs/sdk/latest/packages/addon-kit/widget.html" result in 404s - that is, when you use URLs that reflect the old SDK structure, *and* the "latest" redirect, then you get a 404.

Comment 16

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

(In reply to Will Bamberg [:wbamberg] from comment #11)
> Did this ever get done? I'm still seeing plain 404 pages at
> https://addons.mozilla.org/en-US/developers/docs/sdk/latest/modules/sdk/blah.

It didn't. Let's investigate tomorrow, it will likely involve nudging it to deploy the docs repo and redirecting to the new error page.

Comment 17

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

Looks like :oremj can do this during today's AMO push.

Comment 18

[Jeremy Orem [:oremj]]

I'm now redirecting to the 404 page as we discussed in #flightdeck this morning.