1524434 - Update all document links to point readthedocs.io

Status: NEW

(bugzilla.mozilla.org :: General, task)

Description

[Emma Humphries ☕️🎸🧞‍♀️✨ (she/they) [:emceeaich] (Pacific Time) use needinfo]

Steps to Reproduce

• Visit the URL of a bug which is restricted to a group as a non-logged in user.
• Click on link to https://bmo.readthedocs.io/en/latest/myaccount.html

Expected Behavior

• Instructions on how to create an account

Actual Behavior

• 404 page

Update the URL to https://wiki.mozilla.org/BMO/How_to_Use_Bugzilla#Creating_a_Bugzilla_Account

Comment 1

[Emma Humphries ☕️🎸🧞‍♀️✨ (she/they) [:emceeaich] (Pacific Time) use needinfo]

This is not trivial because https://github.com/mozilla-bteam/bmo/master/template/en/default/global/user-error.html.tmpl constructs the URL.

  [% ELSIF error == "bug_access_query" %]
    [% title = "Access Denied" %]
    [% docslinks = {'myaccount.html' => 'Creating an account'} %]
    You are not authorized to access [% terms.bug %] [%= bug_id FILTER html %].
    To see this [% terms.bug %], you must
    first <a href="[% basepath FILTER none %]show_bug.cgi?id=
                   [% bug_id FILTER uri %]&amp;GoAheadAndLogIn=1">log
in to an account</a> with the appropriate permissions.

Comment 2

[Kohei Yoshino [:kohei]]

Yeah, looks like some links still assume docs are located at https://www.bugzilla.org/docs/4.4/en/html/

Have to find the corresponding pages at https://bmo.readthedocs.io/en/latest/ (or https://bugzilla.readthedocs.io/en/latest/) and replace them all.

Comment 3

[MarjaE]

Is this just developer documentation, or does this also affect user documentation?

Because the sheer between scrolling and non-scrolling elements can trigger my migraines, I doubt I'm the only one, and readthedocs.io doesn't keep the sheer out of the way.

Comment 4

[Kohei Yoshino [:kohei]]

Both user and developer docs. IMHO, I don’t think hosting docs on readthedocs is the best option. As noted in the Bugzilla 7 Roadmap, I’m thinking about:

• Organize scattered documents/help on Wiki (BMO & upstream), Read the Docs (BMO & upstream), in-product pages

But it won’t happen soon, and the current broken links have to be fixed anyway.

Comment 5

[Emma Humphries ☕️🎸🧞‍♀️✨ (she/they) [:emceeaich] (Pacific Time) use needinfo]

(In reply to MarjaE from comment #3)

Because the sheer between scrolling and non-scrolling elements can trigger my migraines, I doubt I'm the only one, and readthedocs.io doesn't keep the sheer out of the way.

I've opened https://github.com/rtfd/readthedocs.org/issues/5330 for that.