1531068 - Some links still refer to readthedocs

Status: RESOLVED FIXED

(Remote Protocol :: Marionette, defect, P1)

Description

[Phil]

User Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36

Steps to reproduce:

Navigate from a browser to

a. https://marionette-client.readthedocs.io/en/master/reference.html

also links are broken in the section called 'Using Marionette' at this link here:

https://firefox-source-docs.mozilla.org/testing/marionette/marionette/Intro.html

explictly these:

Download and setup the Python client for Marionette
Run Tests with Python – How to run tests using the Python client
You might want to experiment with using Marionette interactively at a Python command prompt
Start writing and running tests
Tips on debugging Marionette code
Protocol definition

Actual results:

Documentation and Marionette manual is not available

Expected results:

Reference manual is accessible and readable

Comment 1

[Peter Magyari (Desktop QA)]

Hi,

I can reproduce this issue, those links lead to a page which says "SORRY - This page does not exist yet."
I'm going to add the component in order to involve the development team in reviewing this issue.

Thank you for reporting!

Comment 2

[Andreas Tolfsen ❲:ato❳]

The API documentation was moved to
https://firefox-source-docs.mozilla.org/python/marionette_driver.html,
following the announcement that marionette_driver is being deprecated:
https://lists.mozilla.org/pipermail/tools-marionette/2019-January/000068.html

Comment 3

[Andreas Tolfsen ❲:ato❳]

Actually I will re-use this bug to fix the links in Intro.html.

Comment 4

[Henrik Skupin [:whimboo][⌚️UTC+1]]

As discussed with Andreas on IRC I will fix it.

Comment 5

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Interesting we have two working documentation instances for Marionette:

https://firefox-source-docs.mozilla.org/testing/marionette/marionette/Intro.html
https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html

While the former (and outdated) link contains the wrong URLs, the latter and to-be-used documentation has the fix.

So it looks like that due to some reason formerly generated documentation is not getting removed when moved to a different location.

Andrew, can you please have a look why this happens?

With this bug I will only cover the remaining real instances as listed here:
https://searchfox.org/mozilla-central/search?q=marionette-client&path=

Comment 6

[Henrik Skupin [:whimboo][⌚️UTC+1]]

Attachment: [marionette] Remove remaining links to readthedocs from client documentation

DONTBUILD

Comment 7

[Henrik Skupin [:whimboo][⌚️UTC+1]]

I currently cannot push the changes to inbound because the tree is closed due to infra issues (bug 1532254). I will try later.

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+1]]

(In reply to Henrik Skupin (:whimboo) [⌚️UTC+1] (away 02/28 - 03/03) from comment #5)

Interesting we have two working documentation instances for Marionette:

https://firefox-source-docs.mozilla.org/testing/marionette/marionette/Intro.html
https://firefox-source-docs.mozilla.org/testing/marionette/Intro.html

While the former (and outdated) link contains the wrong URLs, the latter and to-be-used documentation has the fix.

So it looks like that due to some reason formerly generated documentation is not getting removed when moved to a different location.

So this is actually bug 1526796. The Marionette documentation was moved by bug 1523962. As such it is out of scope for this bug.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/559e8b22fdc5
[marionette] Remove remaining links to readthedocs from client documentation. r=me

Comment 10

[Andrei Ciure[:aciure]]

https://hg.mozilla.org/mozilla-central/rev/559e8b22fdc5

Comment 11

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

Created web-platform-tests PR https://github.com/web-platform-tests/wpt/pull/15717 for changes under testing/web-platform/tests

Comment 12

[Web Platform Test Sync Bot (Matrix: #interop:mozilla.org)]

Upstream PR merged