Bug 1753426 - [devtools] Fix documentation links in the source code r=jdescottes

Differential Revision: https://phabricator.services.mozilla.com/D137748
This commit is contained in:
Jan Odvarko
2022-02-07 13:08:10 +00:00
parent 5b0918d622
commit a95aa58205
27 changed files with 63 additions and 75 deletions

View File

@@ -13,7 +13,7 @@ The tests that use a real device are located in `devtools/client/aboutdebugging/
3. Enable USB debugging on your Firefox
4. Connect to your PC via USB
You can refer to https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_over_USB
You can refer to https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connecting-to-a-remote-device
### PC side
Setup the real device information to evaluate the validity in tests.

View File

@@ -25,9 +25,9 @@ const {
} = require("devtools/client/shared/remote-debugging/version-checker");
const TROUBLESHOOTING_URL =
"https://developer.mozilla.org/docs/Tools/about:debugging#Troubleshooting";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/";
const FENNEC_TROUBLESHOOTING_URL =
"https://developer.mozilla.org/docs/Tools/about:debugging#Connection_to_Firefox_for_Android_68";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connection-to-firefox-for-android-68";
const Types = require("devtools/client/aboutdebugging/src/types/index");

View File

@@ -21,7 +21,7 @@ const {
MESSAGE_LEVEL,
} = require("devtools/client/aboutdebugging/src/constants");
const DOC_URL =
"https://developer.mozilla.org/docs/Tools/about:debugging#Service_workers_not_compatible";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#service-workers-not-compatible";
class ServiceWorkersWarning extends PureComponent {
render() {

View File

@@ -53,9 +53,9 @@ const GLOBE_ICON_SRC =
"chrome://devtools/skin/images/aboutdebugging-globe-icon.svg";
const TROUBLESHOOT_USB_URL =
"https://developer.mozilla.org/docs/Tools/Remote_Debugging/Debugging_over_USB";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connecting-to-a-remote-device";
const TROUBLESHOOT_NETWORK_URL =
"https://developer.mozilla.org/docs/Tools/Remote_Debugging/Debugging_over_a_network";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connecting-over-the-network";
class ConnectPage extends PureComponent {
static get propTypes() {

View File

@@ -158,7 +158,7 @@ class Sidebar extends PureComponent {
renderFooter() {
const HELP_ICON_SRC = "chrome://global/skin/icons/help.svg";
const SUPPORT_URL =
"https://developer.mozilla.org/docs/Tools/about:debugging";
"https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/";
return dom.footer(
{

View File

@@ -57,10 +57,7 @@ class AccessibilityPrefs extends Component {
}
onLearnMoreClick() {
openDocLink(
A11Y_LEARN_MORE_LINK +
"?utm_source=devtools&utm_medium=a11y-panel-toolbar"
);
openDocLink(A11Y_LEARN_MORE_LINK);
}
render() {

View File

@@ -37,9 +37,7 @@ function Description() {
div(
{ role: "presentation", tabIndex: "-1" },
LearnMoreLink({
href:
A11Y_LEARN_MORE_LINK +
"?utm_source=devtools&utm_medium=a11y-panel-description",
href: A11Y_LEARN_MORE_LINK,
learnMoreStringKey: "accessibility.learnMore",
l10n: L10N,
messageStringKey: "accessibility.description.general.p1",

View File

@@ -118,12 +118,12 @@ exports.A11Y_SERVICE_DURATION =
// URL constants
exports.A11Y_LEARN_MORE_LINK =
"https://developer.mozilla.org/docs/Tools/Accessibility_inspector";
"https://firefox-source-docs.mozilla.org/devtools-user/accessibility_inspector/";
exports.A11Y_CONTRAST_LEARN_MORE_LINK =
"https://developer.mozilla.org/docs/Web/Accessibility/Understanding_WCAG/Perceivable/" +
"Color_contrast?utm_source=devtools&utm_medium=a11y-panel-checks-color-contrast";
exports.A11Y_SIMULATION_DOCUMENTATION_LINK =
"https://developer.mozilla.org/docs/Tools/Accessibility_inspector/Simulation";
"https://firefox-source-docs.mozilla.org/devtools-user/accessibility_inspector/simulation/";
const A11Y_TEXT_LABEL_LINK_BASE =
"https://developer.mozilla.org/docs/Web/Accessibility/Understanding_WCAG/Text_labels_and_names" +

View File

@@ -62,7 +62,7 @@ function debugBtn(onClick, type, className, tooltip) {
}
const mdnLink =
"https://developer.mozilla.org/docs/Tools/Debugger/Using_the_Debugger_map_scopes_feature?utm_source=devtools&utm_medium=debugger-map-scopes";
"https://firefox-source-docs.mozilla.org/devtools-user/debugger/using_the_debugger_map_scopes_feature/";
class SecondaryPanes extends Component {
constructor(props) {

View File

@@ -77,7 +77,7 @@ about-debugging-sidebar-runtime-item-name-no-device =
.title = { $displayName }
# Text to show in the footer of the sidebar that links to a help page
# (currently: https://developer.mozilla.org/docs/Tools/about:debugging)
# (currently: https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/)
about-debugging-sidebar-support = Debugging Support
# Text to show as the ALT attribute of a help icon that accompanies the help about
@@ -138,7 +138,7 @@ about-debugging-setup-usb-step-enable-debug-firefox2 = Enable USB Debugging in F
about-debugging-setup-usb-step-plug-device = Connect the Android device to your computer.
# Text shown in the USB section of the setup page with a link to troubleshoot connection errors.
# The link goes to https://developer.mozilla.org/docs/Tools/Remote_Debugging/Debugging_over_USB
# The link goes to https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connecting-to-a-remote-device
about-debugging-setup-usb-troubleshoot = Problems connecting to the USB device? <a>Troubleshoot</a>
# Network section of the Setup page
@@ -146,7 +146,7 @@ about-debugging-setup-network =
.title = Network Location
# Text shown in the Network section of the setup page with a link to troubleshoot connection errors.
# The link goes to https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_over_a_network
# The link goes to https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#connecting-over-the-network
about-debugging-setup-network-troubleshoot = Problems connecting via network location? <a>Troubleshoot</a>
# Text of a button displayed after the network locations "Host" input.
@@ -206,12 +206,12 @@ about-debugging-runtime-processes =
about-debugging-runtime-profile-button2 = Profile performance
# This string is displayed in the runtime page if the current configuration of the
# target runtime is incompatible with service workers. "Learn more" points to MDN.
# https://developer.mozilla.org/en-US/docs/Tools/about%3Adebugging#Service_workers_not_compatible
# target runtime is incompatible with service workers. "Learn more" points to:
# https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/index.html#service-workers-not-compatible
about-debugging-runtime-service-workers-not-compatible = Your browser configuration is not compatible with Service Workers. <a>Learn more</a>
# This string is displayed in the runtime page if the remote browser version is too old.
# "Troubleshooting" link points to https://developer.mozilla.org/docs/Tools/about:debugging#Troubleshooting
# "Troubleshooting" link points to https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/
# { $runtimeVersion } is the version of the remote browser (for instance "67.0a1")
# { $minVersion } is the minimum version that is compatible with the current Firefox instance (same format)
about-debugging-browser-version-too-old = The connected browser has an old version ({ $runtimeVersion }). The minimum supported version is ({ $minVersion }). This is an unsupported setup and may cause DevTools to fail. Please update the connected browser. <a>Troubleshooting</a>
@@ -221,7 +221,7 @@ about-debugging-browser-version-too-old = The connected browser has an old versi
about-debugging-browser-version-too-old-fennec = This version of Firefox cannot debug Firefox for Android (68). We recommend installing Firefox for Android Nightly on your phone for testing. <a>More details</a>
# This string is displayed in the runtime page if the remote browser version is too recent.
# "Troubleshooting" link points to https://developer.mozilla.org/docs/Tools/about:debugging#Troubleshooting
# "Troubleshooting" link points to https://firefox-source-docs.mozilla.org/devtools-user/about_colon_debugging/
# { $runtimeID } is the build ID of the remote browser (for instance "20181231", format is yyyyMMdd)
# { $localID } is the build ID of the current Firefox instance (same format)
# { $runtimeVersion } is the version of the remote browser (for instance "67.0a1")

View File

@@ -8,25 +8,25 @@
storage-table-empty-text = No data present for selected host
# Hint shown when the cookies storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/Cookies
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/cookies/
storage-table-type-cookies-hint = View and edit cookies by selecting a host. <a data-l10n-name="learn-more-link">Learn more</a>
# Hint shown when the local storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/Local_Storage_Session_Storage
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/local_storage_session_storage/
storage-table-type-localstorage-hint = View and edit the local storage by selecting a host. <a data-l10n-name="learn-more-link">Learn more</a>
# Hint shown when the session storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/Local_Storage_Session_Storage
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/local_storage_session_storage/
storage-table-type-sessionstorage-hint = View and edit the session storage by selecting a host. <a data-l10n-name="learn-more-link">Learn more</a>
# Hint shown when the IndexedDB storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/IndexedDB
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/indexeddb/
storage-table-type-indexeddb-hint = View and delete IndexedDB entries by selecting a database. <a data-l10n-name="learn-more-link">Learn more</a>
# Hint shown when the cache storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/Cache_Storage
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/cache_storage/
storage-table-type-cache-hint = View and delete the cache storage entries by selecting a storage. <a data-l10n-name="learn-more-link">Learn more</a>
# Hint shown when the extension storage type is selected. Clicking the link will open
# https://developer.mozilla.org/docs/Tools/Storage_Inspector/Extension_Storage
# https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/extension_storage/
storage-table-type-extensionstorage-hint = View and edit the extension storage by selecting a host. <a data-l10n-name="learn-more-link">Learn more</a>

View File

@@ -1,6 +1,6 @@
# Network Monitor
The Network Monitor (netmonitor) shows you all the network requests Firefox makes (for example, when a page is loaded or when an XMLHttpRequest is performed) , how long each request takes, and details of each request. You can edit the method, query, header and resend the request as well. Read [MDN](https://developer.mozilla.org/en-US/docs/Tools/Network_Monitor) to learn all the features and how to use the tool.
The Network Monitor (netmonitor) shows you all the network requests Firefox makes (for example, when a page is loaded or when an XMLHttpRequest is performed) , how long each request takes, and details of each request. You can edit the method, query, header and resend the request as well. Read [more](https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/) to learn all the features and how to use the tool.
### UI

View File

@@ -110,7 +110,7 @@ const HEADERS_ETP = L10N.getStr(
* Lists basic information about the request
*
* In http/2 all response headers are in small case.
* See: https://developer.mozilla.org/en-US/docs/Tools/Network_Monitor/request_details#Headers
* See: https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/request_details/index.html#response-headers
* RFC: https://tools.ietf.org/html/rfc7540#section-8.1.2
*/
class HeadersPanel extends Component {

View File

@@ -146,7 +146,7 @@ const EVENTS = {
const TEST_EVENTS = {
// When a network or timeline event is received.
// See https://developer.mozilla.org/docs/Tools/Web_Console/remoting for
// See https://firefox-source-docs.mozilla.org/devtools-user/web_console/remoting/ for
// more information about what each packet is supposed to deliver.
NETWORK_EVENT: "NetMonitor:NetworkEvent",
NETWORK_EVENT_UPDATED: "NetMonitor:NetworkEventUpdated",

View File

@@ -102,7 +102,7 @@ Emitted after a full GC cycle has completed (which is after any number of
incremental slices).
* DOMString causeName - The reason for a GC event to occur. A full list of
GC reasons can be found [on MDN](https://developer.mozilla.org/en-US/docs/Tools/Debugger-API/Debugger.Memory#Debugger.Memory_Handler_Functions).
GC reasons can be found in [docs](https://firefox-source-docs.mozilla.org/devtools-user/debugger-api/debugger.memory/).
* DOMString nonincremenetalReason - If the GC could not do an incremental
GC (smaller, quick GC events), and we have to walk the entire heap and
GC everything marked, then the reason listed here is why.

View File

@@ -62,9 +62,7 @@ const testDescriptions = async function() {
// Check learn more link
const learnMoreLink = doc.querySelector(".table-widget-empty-text > a");
ok(learnMoreLink, "There is a [Learn more] link");
const expectedURL =
getStorageTypeURL(type) +
"?utm_source=devtools&utm_medium=storage-inspector";
const expectedURL = getStorageTypeURL(type);
is(
learnMoreLink.href,
expectedURL,

View File

@@ -1150,8 +1150,7 @@ class StorageUI {
}
this.table.setPlaceholder(
storageTypeHintL10nId,
getStorageTypeURL(this.table.datatype) +
"?utm_source=devtools&utm_medium=storage-inspector"
getStorageTypeURL(this.table.datatype)
);
// If selected item has no host then reset table headers

View File

@@ -5,7 +5,7 @@
"use strict";
const MDN_BASE_URL =
"https://developer.mozilla.org/docs/Tools/Storage_Inspector/";
"https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/";
/**
* Get the MDN URL for the specified storage type.
@@ -17,16 +17,16 @@ const MDN_BASE_URL =
function getStorageTypeURL(type) {
switch (type) {
case "cookies":
return `${MDN_BASE_URL}Cookies`;
return `${MDN_BASE_URL}cookies`;
case "localStorage":
case "sessionStorage":
return `${MDN_BASE_URL}Local_storage_Session_storage`;
return `${MDN_BASE_URL}local_storage_session_storage`;
case "indexedDB":
return `${MDN_BASE_URL}IndexedDB`;
return `${MDN_BASE_URL}indexeddb`;
case "Cache":
return `${MDN_BASE_URL}Cache_Storage`;
return `${MDN_BASE_URL}cache_storage`;
case "extensionStorage":
return `${MDN_BASE_URL}Extension_storage`;
return `${MDN_BASE_URL}extension_storage`;
default:
return null;
}

View File

@@ -3,7 +3,7 @@
The WebConsole (webconsole) shows you all the console API calls made by scripts and alerts
you when javascript errors are thrown by a script.
It can also display network logs, and you can evaluate expressions using the console
input, a.k.a. JsTerm. You can read more about it on [MDN](https://developer.mozilla.org/en-US/docs/Tools/Web_Console)
input, a.k.a. JsTerm. You can read [more](https://firefox-source-docs.mozilla.org/devtools-user/web_console/) about it
to learn all the features and how to use the tool.
## Run WebConsole

View File

@@ -56,7 +56,8 @@ loader.lazyRequireGetter(
true
);
const HELP_URL = "https://developer.mozilla.org/docs/Tools/Web_Console/Helpers";
const HELP_URL =
"https://firefox-source-docs.mozilla.org/devtools-user/web_console/helpers/";
async function getMappedExpression(hud, expression) {
let mapResult;

View File

@@ -33,12 +33,7 @@ const {
const autocompleteActions = require("devtools/client/webconsole/actions/autocomplete");
const { l10n } = require("devtools/client/webconsole/utils/messages");
const utmParams = new URLSearchParams({
utm_source: "mozilla",
utm_medium: "devtools-webconsole",
utm_campaign: "default",
});
const LEARN_MORE_URL = `https://developer.mozilla.org/docs/Tools/Web_Console/Invoke_getters_from_autocomplete?${utmParams}`;
const LEARN_MORE_URL = `https://firefox-source-docs.mozilla.org/devtools-user/web_console/invoke_getters_from_autocomplete/`;
class ConfirmDialog extends Component {
static get propTypes() {

View File

@@ -23,8 +23,8 @@ const TEST_URI = `data:text/html;charset=utf-8,<!DOCTYPE html>
</head>
<body>Autocomplete popup - invoke getter usage test</body>`;
const MDN_URL =
"https://developer.mozilla.org/docs/Tools/Web_Console/Invoke_getters_from_autocomplete";
const DOC_URL =
"https://firefox-source-docs.mozilla.org/devtools-user/web_console/invoke_getters_from_autocomplete/";
add_task(async function() {
const hud = await openNewTabAndConsole(TEST_URI);
@@ -47,13 +47,8 @@ add_task(async function() {
info(
`Check that clicking on the "Learn more" link navigates to the expected page`
);
const expectedUri = MDN_URL + GA_PARAMS;
const { link } = await simulateLinkClick(learnMoreEl);
is(
link,
expectedUri,
`Click on "Learn More" link navigates user to ${expectedUri}`
);
is(link, DOC_URL, `Click on "Learn More" link navigates user to ${DOC_URL}`);
info("Close the popup");
EventUtils.synthesizeKey("KEY_Escape");

View File

@@ -5,7 +5,8 @@
const TEST_URI =
"data:text/html,<!DOCTYPE html>Test <code>help()</code> jsterm helper";
const HELP_URL = "https://developer.mozilla.org/docs/Tools/Web_Console/Helpers";
const HELP_URL =
"https://firefox-source-docs.mozilla.org/devtools-user/web_console/helpers/";
add_task(async function() {
const hud = await openNewTabAndConsole(TEST_URI);

View File

@@ -115,7 +115,7 @@ const STRICT_TRANSPORT_SECURITY_LEARN_MORE =
const MIME_TYPE_MISMATCH_LEARN_MORE =
"https://developer.mozilla.org/docs/Web/HTTP/Headers/X-Content-Type-Options";
const SOURCE_MAP_LEARN_MORE =
"https://developer.mozilla.org/en-US/docs/Tools/Debugger/Source_map_errors";
"https://firefox-source-docs.mozilla.org/devtools-user/debugger/source_map_errors/";
const TLS_LEARN_MORE =
"https://blog.mozilla.org/security/2018/10/15/removing-old-versions-of-tls/";
const X_FRAME_OPTIONS_LEARN_MORE =

View File

@@ -660,10 +660,10 @@ const proto = {
},
/**
* Converts a Debugger API completion value record into an eqivalent
* Converts a Debugger API completion value record into an equivalent
* object grip for use by the API.
*
* See https://developer.mozilla.org/en-US/docs/Tools/Debugger-API/Conventions#completion-values
* See https://firefox-source-docs.mozilla.org/devtools-user/debugger-api/
* for more specifics on the expected behavior.
*/
_buildCompletion(value) {

View File

@@ -67,63 +67,67 @@ const features = [
"chrome://devtools-startup/content/aboutdevtools/images/feature-inspector.svg",
title: "features-inspector-title",
desc: "features-inspector-desc",
link: "https://developer.mozilla.org/docs/Tools/Page_Inspector",
link:
"https://firefox-source-docs.mozilla.org/devtools-user/page_inspector/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-console.svg",
title: "features-console-title",
desc: "features-console-desc",
link: "https://developer.mozilla.org/docs/Tools/Web_Console",
link: "https://firefox-source-docs.mozilla.org/devtools-user/web_console/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-debugger.svg",
title: "features-debugger-title",
desc: "features-debugger-desc",
link: "https://developer.mozilla.org/docs/Tools/Debugger",
link: "https://firefox-source-docs.mozilla.org/devtools-user/debugger/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-network.svg",
title: "features-network-title",
desc: "features-network-desc",
link: "https://developer.mozilla.org/docs/Tools/Network_Monitor",
link:
"https://firefox-source-docs.mozilla.org/devtools-user/network_monitor/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-storage.svg",
title: "features-storage-title",
desc: "features-storage-desc",
link: "https://developer.mozilla.org/docs/Tools/Storage_Inspector",
link:
"https://firefox-source-docs.mozilla.org/devtools-user/storage_inspector/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-responsive.svg",
title: "features-responsive-title",
desc: "features-responsive-desc",
link: "https://developer.mozilla.org/docs/Tools/Responsive_Design_Mode",
link:
"https://firefox-source-docs.mozilla.org/devtools-user/responsive_design_mode/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-visualediting.svg",
title: "features-visual-editing-title",
desc: "features-visual-editing-desc",
link: "https://developer.mozilla.org/docs/Tools/Style_Editor",
link: "https://firefox-source-docs.mozilla.org/devtools-user/style_editor/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-performance.svg",
title: "features-performance-title",
desc: "features-performance-desc",
link: "https://developer.mozilla.org/docs/Tools/Performance",
link: "https://firefox-source-docs.mozilla.org/devtools-user/performance/",
},
{
icon:
"chrome://devtools-startup/content/aboutdevtools/images/feature-memory.svg",
title: "features-memory-title",
desc: "features-memory-desc",
link: "https://developer.mozilla.org/docs/Tools/Memory",
link: "https://firefox-source-docs.mozilla.org/devtools-user/memory/",
},
];

View File

@@ -36,7 +36,7 @@
<p id="inspect-element-message" hidden="" data-l10n-id="enable-inspect-element-message"></p>
<p data-l10n-id="enable-common-message"></p>
<a class="external installpage-link" href="https://developer.mozilla.org/docs/Tools" target="_blank" data-l10n-id="enable-learn-more-link"></a>
<a class="external installpage-link" href="https://firefox-source-docs.mozilla.org/devtools-user/" target="_blank" data-l10n-id="enable-learn-more-link"></a>
<div class="buttons-container">
<button class="primary" id="install" data-l10n-id="enable-enable-button"></button>
<button id="close" data-l10n-id="enable-close-button"></button>