Closed Bug 1436346 Opened 3 years ago Closed 2 years ago

Broken link to README from firefox-source-docs.mozilla.org

Categories

(Testing :: geckodriver, defect)

Version 3
defect
Not set
normal

Tracking

(firefox60 fixed)

RESOLVED FIXED
mozilla60
Tracking Status
firefox60 --- fixed

People

(Reporter: davehunt, Assigned: raphael, Mentored)

Details

Attachments

(1 file)

The documentation at https://firefox-source-docs.mozilla.org/testing/geckodriver/geckodriver/TraceLogs.html links to the README as a relative URL, which causes the invalid URL of https://firefox-source-docs.mozilla.org/testing/geckodriver/README.md to be opened, resulting in a 404 not found.
We could link to the canonical source at https://hg.mozilla.org/mozilla-central/file/tip/testing/geckodriver/README.md, but this does not render the Markdown. Alternatively, we could link to the source on GitHub at https://github.com/mozilla/geckodriver/blob/master/README.md, but this appears to be out of sync with m-c.

Other options would be to pull in the contents of the README when we build the documentation and link to that, or to move the documentation from the README, and to link from the README to our canonical docs.
Henrik: Do you have a preference?
Flags: needinfo?(hskupin)
Status: NEW → ASSIGNED
Andreas did most of the documentation work. Lets see what he thinks about it. For myself it would be fine to link to the Github version.
Flags: needinfo?(hskupin) → needinfo?(ato)
Well spotted!  I think we should link to
https://searchfox.org/mozilla-central/source/testing/geckodriver/README.md.
Flags: needinfo?(ato)
Comment on attachment 8949056 [details]
Bug 1436346 - Fix broken link to geckodriver README in TraceLogs docs;

https://reviewboard.mozilla.org/r/218458/#review224534
Attachment #8949056 - Flags: review?(ato) → review+
Pushed by atolfsen@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/afdc0474181d
Fix broken link to geckodriver README in TraceLogs docs; r=ato
Comment on attachment 8949056 [details]
Bug 1436346 - Fix broken link to geckodriver README in TraceLogs docs;

https://reviewboard.mozilla.org/r/218458/#review224534

Thank you :ato!
https://hg.mozilla.org/mozilla-central/rev/afdc0474181d
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla60
You need to log in before you can comment on or make changes to this bug.