1275578 - [api] link on main docs page for master branch redirects to readthedocs.io rather than showing API docs

Status: RESOLVED FIXED

(Bugzilla :: bugzilla.org, defect)

Description

[Gervase Markham [:gerv]]

* Visit https://www.bugzilla.org/docs/
* Click [api] next to "Current development version (master)"

Expect: something like
https://www.bugzilla.org/docs/5.0/en/html/integrating/api/

Actual: redirect to
https://bugzilla.readthedocs.io/en/latest/
which does not have the same information.

Gerv

Comment 1

[Gervase Markham [:gerv]]

justdave: at the last Bugzilla meeting you were getting API docs working again. Can you look at this?

Gerv

Comment 2

[Gervase Markham [:gerv]]

This is still broken after 2 months... :-(

Gerv

Comment 3

[Gervase Markham [:gerv]]

I hope this fixes it - some .htaccess rules seemed bogus.

To [e-mail]:bugzilla/bugzilla.org.git
   0d90a49..41e552e  master -> master

Gerv

Comment 4

[Dave Miller [:justdave]]

The old URLs now get 404s.  Those rewrites need to come back.  The problem is they didn't get duplicated for the 5.0 branch when we branched.

Comment 5

[Dave Miller [:justdave]]

er, I guess 5.0 wouldn't need them, because the 5.0 docs never existed before we moved there, only tip did.

Comment 6

[Dave Miller [:justdave]]

Actually, this is two different problems.

a) the api location changed, so the rewrite rule needed fixing accordingly (to add the /intergration/ to it)
b) the api doc build is broken on the production web server because the version of Perl on the webserver is too old.  Thus the docs truly are 404 (and not just broken rewrites) because they are not there.

Comment 7

[Dave Miller [:justdave]]

Restored the RewriteRules with an additional one to rewrite /api/ to /integration/api/ (since the point is making old links still work).

To [e-mail]:bugzilla/bugzilla.org.git
   41e552e..f8820bc  master -> master

Note this does not resolve the bug because we still haven't gotten it building somewhere we can link to.

If we have a publicly-hosted copy of this anywhere I can make the redirect point there instead of at the empty location where they're supposed to be and can't be built...

Comment 8

[Gervase Markham [:gerv]]

justdave: the second of your three rules won't trigger because you've misspelt "integration". Does that mean this fix isn't working, or does it mean your second rule is actually unnecessary?

As for building the tip, I thought Dylan had a plan to fix that by removing the "use 5.14" from a few files?

Gerv

Comment 9

[Dylan Hardison [:dylan] (he/him)]

I think it was just one file. 

"use 5.14" does two things for us:

1) it ensures that people use bugzilla with a new enough perl (however, the Makefile.PL also does this, because that's just another dependency)
2) it turns on some features. (Amusingly, "use 5.14" implies "use strict")

Comment 10

[Gervase Markham [:gerv]]

(In reply to Dylan William Hardison [:dylan] from comment #9)
> I think it was just one file. 

So which file do we need to remove it from? Bugzilla/Constants.pm? Something else? Either a patch, or an explanation of your plan in a comment, would be most welcome :-)

Gerv

Comment 11

[Dylan Hardison [:dylan] (he/him)]

I was only offering my memory. Maybe if I get ssh access to the machine I'll fix it some evening. It definitely requires a patch, and it would be a pretty quick r+

Comment 13

[Gervase Markham [:gerv]]

wicked/justdave: who can get dylan ssh access to the machine running bugzilla.org?

Gerv

Comment 14

[Dave Miller [:justdave]]

(In reply to Gervase Markham [:gerv] from comment #13)
> wicked/justdave: who can get dylan ssh access to the machine running bugzilla.org?

It's the admin box for the generic web cluster, he probably won't get access to it.

There's a staging copy of the site on landfill in /var/www/html/bugzilla.org/dest/ that answers to http://www-stage.bugzilla.org/ 
though I'm not sure where the build root is for it. From file ownership it looks like dkl was the last one to touch it, so he might know.  You could use that and force it to use an old perl to test it.

Comment 15

[David Lawrence [:dkl]]

(In reply to Dave Miller [:justdave] ([e-mail]) from comment #14)
> (In reply to Gervase Markham [:gerv] from comment #13)
> > wicked/justdave: who can get dylan ssh access to the machine running bugzilla.org?
> 
> It's the admin box for the generic web cluster, he probably won't get access
> to it.
> 
> There's a staging copy of the site on landfill in
> /var/www/html/bugzilla.org/dest/ that answers to
> http://www-stage.bugzilla.org/ 
> though I'm not sure where the build root is for it. From file ownership it
> looks like dkl was the last one to touch it, so he might know.  You could
> use that and force it to use an old perl to test it.

I build it locally using a checkout of github.com/bugzilla/bugzilla.org which builds it it to dest/.
I then use rsync over ssh to push the html files up to landfill. They are built on landfill. My local
dev environment is perl 5.16.3.

dkl

Comment 16

[Gervase Markham [:gerv]]

Dylan: do you have all you need now to take a crack at this?

Gerv

Comment 17

[Dylan Hardison [:dylan] (he/him)]

Yes, I should be able to get to this.

Comment 18

[Gervase Markham [:gerv]]

Does bug 1314854 actually fix this?

Gerv

Comment 19

[Gervase Markham [:gerv]]

This is resolved on the new Github Pages site.

Gerv