1727389 - Broken Links in DevTools documentation

Status: NEW

(DevTools :: General, task, P2)

Description

[Stefan Zabka (:vringar)]

This is a list in the format document,URL where the URL used to point to an MDN article.

devtools/client/shared/components/NotificationBox.js,https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/notificationbox
devtools/docs/tests/debugging-intermittents.md,https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Using_the_VM
devtools/docs/contributing/code-reviews-checklist.md,https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_content_best_practices
devtools/docs/tests/README.md,https://developer.mozilla.org/en-US/docs/Mozilla/QA/Automated_testing
devtools/docs/preferences.md,https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIPrefBranch
devtools/docs/preferences.md,https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIPrefService
devtools/client/webconsole/test/README.md,https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Mochitest
devtools/client/aboutdebugging/documentation/TESTS.md,https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Mochitest
devtools/client/aboutdebugging/documentation/TESTS.md,https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-based_unit_tests
devtools/docs/files/adding-files.md,https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/Using
devtools/docs/files/adding-files.md,https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_content_best_practices
devtools/client/aboutdebugging/documentation/GECKOVIEW_EXAMPLE_BUILD.md,https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_for_Android_build.
devtools/client/aboutdebugging/documentation/GECKOVIEW_REFERENCE_BROWSER_BUILD.md,https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_for_Android_build.
devtools/client/aboutdebugging/documentation/ANDROID_BUILD.md,https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_for_Android_build.
devtools/docs/tools/memory-panel.md,https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Running_Automated_JavaScript_Tests
devtools/docs/frontend/svgs.md,https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/SVG_Guidelines

I hope this is the right component for these files. I just trusted searchfox.
If you'd prefer a different format for this report please let me know. I'm happy to generate it in any way that makes it useful to you.

Comment 1

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Thank you for the report!

Firefox DevTools source code documentation has been moved to: https://firefox-source-docs.mozilla.org/devtools

This should happen for all the *.md files, for example:
devtools/docs/tests/debugging-intermittents.md -> https://firefox-source-docs.mozilla.org/devtools/tests/debugging-intermittents.html
devtools/docs/frontend/svgs.md -> https://firefox-source-docs.mozilla.org/devtools/frontend/svgs.html
etc.

Except of the first entry in your list:

devtools/client/shared/components/NotificationBox.js,https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/notificationbox

This isn't an MD file and also the XUL/notificaitonbox was about different XUL (not React) component.

Where do you see those links?
What are the places we should fix?

Honza

Comment 2

[Stefan Zabka (:vringar)]

Sorry for the imprecise wording.

The file devtools/docs/frontend/svgs.md contains a broken link.

This results in the first link on this page to go nowhere, which can be frustrating when trying to read up on topics.

I don't have a clear plan for fixing this.
The options I see are:

1. Link to the archived file - This is bad imo because it's super hard to read when not being rendered
2. Migrate the archived file into the FF source docs, however

Comment 3

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Perfect, thank you for the update!

The goal of this bug should be searching and fixing existing https://developer.mozilla.org* links in all *.md files wihthin the /DevTools directory. They should point to proper pages on firefox-source-docs.mozilla.org/devtools/

DevTools dir:
https://searchfox.org/mozilla-central/source/devtools

This looks like a good first bug

Honza

Comment 4

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Turned out that some of the MDN pages are not available anywere so, it isn't going to be an easy fix. Removing the good first bug keyword.