Bug 1750190 - [devtools] Fix MDN links in DevTools user docs r=jdesco…

…ttes Differential Revision: https://phabricator.services.mozilla.com/D135992
dothq · Jan 18, 2022 · 21b3090 · 21b3090
1 parent 13ed0e2
commit 21b3090
Show file tree

Hide file tree

Showing 14 changed files with 19 additions and 14 deletions.
diff --git a/devtools/docs/contributor/index.rst b/devtools/docs/contributor/index.rst
@@ -5,7 +5,7 @@
 Firefox DevTools Contributor Docs
 =================================
 
-This is a guide to working on the code for Firefox Developer Tools. If you're looking for help with using the tools, see the `user docs <https://developer.mozilla.org/en-US/docs/Tools>`__. For other ways to get involved, check out our `community site <https://firefox-dev.tools/>`__.
+This is a guide to working on the code for Firefox Developer Tools. If you're looking for help with using the tools, see the :doc:`user docs </devtools-user/index>`. For other ways to get involved, check out our `community site <https://firefox-dev.tools/>`__.
 
 
 Getting Started

diff --git a/devtools/docs/user/dom_property_viewer/index.rst b/devtools/docs/user/dom_property_viewer/index.rst
@@ -6,7 +6,7 @@ DOM Property Viewer
 
   The DOM Property Viewer is new in Firefox 48. It is disabled by default. Enable it in the :ref:`Developer Tools Settings <tool-toolbox-settings>`
 
-The DOM Property Viewer lets you inspect the properties of the `DOM <https://developer.mozilla.org/en-US/docs/Glossary/DOM>`_ as an expandable tree structure, starting from the `window <https://developer.mozilla.org/en-US/docs/Web/API/Window>`_ object of the current page or the `selected iframe <https://developer.mozilla.org/en-US/docs/Tools/Working_with_iframes>`_.
+The DOM Property Viewer lets you inspect the properties of the `DOM <https://developer.mozilla.org/en-US/docs/Glossary/DOM>`_ as an expandable tree structure, starting from the `window <https://developer.mozilla.org/en-US/docs/Web/API/Window>`_ object of the current page or the :doc:`selected iframe <../working_with_iframes/index>`.
 
 .. image:: dom_inspector.png
   :class: center

diff --git a/devtools/docs/user/index.rst b/devtools/docs/user/index.rst
@@ -244,7 +244,7 @@ For information on extending the Firefox DevTools, see `Extending the developer
 Migrating from Firebug
 **********************
 
-Firebug has come to the end of its lifespan (see `Firebug lives on in Firefox DevTools <Attach the Developer Tools to the browser itself.>`_ for details of why), and we appreciate that some people will find migrating to another less familiar set of DevTools to be challenging. To ease a transition from Firebug to the Firefox developer tools, we have written a handy guide — `Migrating from Firebug <https://developer.mozilla.org/en-US/docs/Tools/Migrating_from_Firebug>`_
+Firebug has come to the end of its lifespan (see `Firebug lives on in Firefox DevTools <https://hacks.mozilla.org/2016/12/firebug-lives-on-in-firefox-devtools/>`_ for details of why), and we appreciate that some people will find migrating to another less familiar set of DevTools to be challenging. To ease a transition from Firebug to the Firefox developer tools, we have written a handy guide — :doc:`Migrating from Firebug <./migrating_from_firebug/index>`
 
 
 Contribute

diff --git a/devtools/docs/user/keyboard_shortcuts/index.rst b/devtools/docs/user/keyboard_shortcuts/index.rst
@@ -137,7 +137,7 @@ These shortcuts work whenever the toolbox is open, no matter which tool is activ
     - :kbd:`F1`
     - :kbd:`F1`
 
-  * - Toggle toolbox between the last 2 `docking modes <https://developer.mozilla.org/en-US/docs/Tools/Tools_Toolbox#docking_mode>`_
+  * - Toggle toolbox between the last 2 :ref:`docking modes <tools-toolbox-docking-mode>`
     - :kbd:`Ctrl` + :kbd:`Shift` + :kbd:`D`
     - :kbd:`Cmd` + :kbd:`Shift` + :kbd:`D`
     - :kbd:`Ctrl` + :kbd:`Shift` + :kbd:`D`

diff --git a/devtools/docs/user/memory/aggregate_view/index.rst b/devtools/docs/user/memory/aggregate_view/index.rst
@@ -53,7 +53,7 @@ Each type gets a row in the table, and rows are ordered by the amount of memory
 - The "Total Bytes" column shows you the number of bytes occupied by objects in each category, and that number as a percentage of the whole heap size for that tab.
 
 
-The screenshots in this section are taken from a snapshot of the `monster example page <https://developer.mozilla.org/en-US/docs/Tools/Memory/Monster_example>`_.
+The screenshots in this section are taken from a snapshot of the :doc:`monster example page <../monster_example/index>`.
 
 
 For example, in the screenshot above, you can see that:
@@ -74,9 +74,9 @@ Click this to see every instance of that type. For example, the entry for ``Arra
   :class: center
 
 
-For each instance, you can see the `retained size and shallow size <https://developer.mozilla.org/en-US/docs/Tools/Memory/Dominators#shallow_and_retained_size>`_ of that instance. In this case, you can see that the first three arrays have a fairly large shallow size (5% of the total heap usage) and a much larger retained size (26% of the total).
+For each instance, you can see the :ref:`retained size and shallow size <shallow-and-retained-size>` of that instance. In this case, you can see that the first three arrays have a fairly large shallow size (5% of the total heap usage) and a much larger retained size (26% of the total).
 
-On the right-hand side is a pane that just says "Select an item to view its retaining paths". If you select an item, you'll see the `Retaining paths panel <https://developer.mozilla.org/en-US/docs/Tools/Memory/Dominators_view#retaining_paths_panel>`_ for that item:
+On the right-hand side is a pane that just says "Select an item to view its retaining paths". If you select an item, you'll see the :ref:`Retaining paths panel <memory-dominators-view-retaining-paths-panel>` for that item:
 
 .. image:: memory-tool-in-group-retaining-paths.png
   :class: center

diff --git a/devtools/docs/user/memory/dominators/index.rst b/devtools/docs/user/memory/dominators/index.rst
@@ -34,6 +34,8 @@ So when an object becomes unreachable (for example, because it is only reference
 Conversely, this means that objects are kept alive as long as some other reachable object is holding a reference to them.
 
 
+.. _shallow-and-retained-size:
+
 Shallow and retained size
 *************************
 

diff --git a/...r/how_to/work_with_animations/animation_inspector_(firefox_41_and_42)/index.rst b/...r/how_to/work_with_animations/animation_inspector_(firefox_41_and_42)/index.rst
@@ -3,7 +3,7 @@ Animation inspector (Firefox 41 and 42)
 =======================================
 
 .. note::
-  Note that the Animation inspector's UI was revamped in Firefox 43. To see what the Animation inspector looks like in Firefox 43 and subsequent releases, see `the main "Work with animations" page <https://developer.mozilla.org/en-US/docs/Tools/Page_Inspector/How_to/Work_with_animations#animation_inspector>`_.
+  Note that the Animation inspector's UI was revamped in Firefox 43. To see what the Animation inspector looks like in Firefox 43 and subsequent releases, see :ref:`the main "Work with animations" page <page-inspector-how-to-work-with-animations-animation-inspector>`.
 
 
 The Animation inspector enables you to:

diff --git a/devtools/docs/user/performance/call_tree/index.rst b/devtools/docs/user/performance/call_tree/index.rst
@@ -13,7 +13,7 @@ The Call Tree is a sampling profiler. It periodically samples the state of the J
 .. note::
     In this article, we'll use the output of a simple program as an example. If you want to get the program to experiment with your profile, you can find it `here <https://github.com/mdn/performance-scenarios/blob/gh-pages/js-call-tree-1/>`__. You can find the specific profile we discuss `here <https://github.com/mdn/performance-scenarios/blob/gh-pages/js-call-tree-1/profile/call-tree.json>`__ - just import it to the performance tool to follow along.
 
-    There's a short page describing the structure of this program `here <https://developer.mozilla.org/en-US/docs/Tools/Performance/Examples/Sorting_algorithms_comparison>`__.
+    There's a short page describing the structure of this program :doc:`here <../examples/sorting_algorithms_comparison/index>`.
 
     Note that we use the same program - the same profile, in fact - in the documentation page for the :doc:`Flame Chart <../flame_chart/index>`.
 

diff --git a/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst b/devtools/docs/user/remote_debugging/debugging_firefox_desktop/index.rst
@@ -11,7 +11,7 @@ This guide explains how you can use the Firefox Developer Tools to debug a diffe
 Enable remote debugging
 ***********************
 
-First, you'll need to ensure that both debugger and debuggee have the "Enable browser chrome and add-on debugging toolboxes" and "Enable remote debugging" settings checked in the :ref:`Developer Tools Settings <tool-toolbox-settings>`. If you're using `Firefox Developer Edition <https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Developer_Edition>`_, they are checked by default.
+First, you'll need to ensure that both debugger and debuggee have the "Enable browser chrome and add-on debugging toolboxes" and "Enable remote debugging" settings checked in the :ref:`Developer Tools Settings <tool-toolbox-settings>`. If you're using `Firefox Developer Edition <https://www.mozilla.org/firefox/developer/>`_, they are checked by default.
 
 .. image:: remote_debug_settings.png
   :class: border

diff --git a/devtools/docs/user/remote_debugging/firefox_for_android/index.rst b/devtools/docs/user/remote_debugging/firefox_for_android/index.rst
@@ -3,7 +3,7 @@ Remotely debugging Firefox <36 for Android
 ==========================================
 
 .. note::
-  This guide is for Firefox version 36 and earlier. To debug in Firefox 68 and later, follow the instructions on `about:debugging <https://developer.mozilla.org/en-US/docs/Tools/about:debugging>`_.
+  This guide is for Firefox version 36 and earlier. To debug in Firefox 68 and later, follow the instructions on :doc:`about:debugging <../../about_colon_debugging/index>`.
 
   For Firefox between 37 and 67, please use the :doc:`WebIDE <../debugging_firefox_for_android_with_webide/index>` guide.
 

diff --git a/devtools/docs/user/settings/index.rst b/devtools/docs/user/settings/index.rst
@@ -2,6 +2,8 @@
 Settings
 ========
 
+.. _tool-toolbox-settings:
+
 Opening Settings
 ****************
 

diff --git a/devtools/docs/user/tools_toolbox/index.rst b/devtools/docs/user/tools_toolbox/index.rst
@@ -31,6 +31,8 @@ The window itself is split into two parts: a toolbar along the top, and a main p
   Since Firefox 62, you can drag and drop tabs in the main toolbar of the toolbox to reorder your tools as you wish (`Bug 1226272 <https://bugzilla.mozilla.org/show_bug.cgi?id=1226272>`_)
 
 
+.. _tools-toolbox-docking-mode:
+
 Docking mode
 ************
 
@@ -116,7 +118,6 @@ There's also a meatball menu button that consists of following options:
 - two buttons leading to documentation and community
 
 
-.. _tool-toolbox-settings:
 
 Settings
 ********

diff --git a/devtools/docs/user/web_console/console_messages/index.rst b/devtools/docs/user/web_console/console_messages/index.rst
@@ -302,7 +302,7 @@ To find a suitable library for your server code, see the `Chrome Logger document
 Interpreter input/output
 ------------------------
 
-Commands sent to the browser using the `Web Console's JavaScript interpreter <https://developer.mozilla.org/en-US/docs/Tools/Web_Console/The_command_line_interpreter>`_, and the corresponding responses, are logged in the console messages.
+Commands sent to the browser using the :doc:`Web Console's JavaScript interpreter <../the_command_line_interpreter/index>`, and the corresponding responses, are logged in the console messages.
 
 For responses that contain objects or variables, the following context menu options are available:
 

diff --git a/devtools/docs/user/web_console/helpers/index.rst b/devtools/docs/user/web_console/helpers/index.rst
@@ -34,7 +34,7 @@ clear()
   Clears the console output area.
 
 clearHistory()
-  Just like a normal command line, the console command line `remembers the commands you've typed <https://developer.mozilla.org/en-US/docs/Tools/Web_Console#command_history>`_. Use this function to clear the console's command history.
+  Just like a normal command line, the console command line :ref:`remembers the commands you've typed <command_line_interpreter_execution_history>`. Use this function to clear the console's command history.
 
 .. _web_console_helpers_copy: