Merge pull request #329 from cmacfarl/fix-linkcheck

Fix broken links.
FIRST-Tech-Challenge · Dec 11, 2024 · 4aed6fa · 4aed6fa
2 parents 2d07aa7 + 6807fc7
commit 4aed6fa
Show file tree

Hide file tree

Showing 33 changed files with 75 additions and 162 deletions.
diff --git a/docs/source/apriltag/opmode_test_images/opmode-test-images.rst b/docs/source/apriltag/opmode_test_images/opmode-test-images.rst
@@ -5,7 +5,7 @@ Introduction
 ------------
 
 In the 2023-2024 season, `FIRST Tech Challenge has introduced
-AprilTags <https://ftc-docs.firstinspires.org/apriltag-intro>`__ into
+AprilTags <https://ftc-docs.firstinspires.org/en/latest/apriltag/vision_portal/apriltag_intro/apriltag-intro.html>`__ into
 the season-unique competition. AprilTags were developed by the April
 Robotics Laboratory at the University of Michigan and are a visual
 fiducial tagging system, built on a similar concept as QR codes, useful
@@ -75,7 +75,7 @@ to verify that the page printed properly.
 For more in-depth information about AprilTag detection values, and
 better understanding what they mean, please visit the following website:
 
--  https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 - :download:`Download and print the official PDF <files/FTCAprilTagSDK82SamplesExtended.pdf>`
 
 

diff --git a/docs/source/apriltag/vision_portal/apriltag_advanced_use/apriltag-advanced-use.rst b/docs/source/apriltag/vision_portal/apriltag_advanced_use/apriltag-advanced-use.rst
@@ -89,7 +89,7 @@ follows:
 
 Further discussion is provided here:
 
-- https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 
 Advanced CPU Management
 -----------------------

diff --git a/...iltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration.rst b/...iltag/vision_portal/apriltag_camera_calibration/apriltag-camera-calibration.rst
@@ -46,7 +46,7 @@ previous run’s results.
 Mac OSX users may need special software for Android file transfer.
 
 Next, read and follow the calibration instructions posted at
-`ftc-docs <https://ftc-docs.firstinspires.org/camera-calibration>`__.
+`ftc-docs <https://ftc-docs.firstinspires.org/en/latest/programming_resources/vision/camera_calibration/camera-calibration.html>`__.
 Other calibration programs are widely available online.
 
 Existing Warnings

diff --git a/docs/source/apriltag/vision_portal/apriltag_intro/apriltag-intro.rst b/docs/source/apriltag/vision_portal/apriltag_intro/apriltag-intro.rst
@@ -276,7 +276,7 @@ positive rotation.
 
 Further discussion is provided here:
 
-- https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 
 Note: This article does not discuss the *FIRST* Tech Challenge 
 :ref:`Field Coordinate System <game_specific_resources/field_coordinate_system/field-coordinate-system:scope>`.
@@ -373,7 +373,7 @@ follows:
 
 Again, further discussion is provided here:
 
-- https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 
 Summary
 -------

diff --git a/docs/source/apriltag/vision_portal/apriltag_localization/apriltag-localization.rst b/docs/source/apriltag/vision_portal/apriltag_localization/apriltag-localization.rst
@@ -237,8 +237,8 @@ Reference Frames
 
 In the above example. the yaw angle is given as (approximately) -90 degrees.
 But the camera is facing in the negative X direction, thus has a heading or yaw
-angle of -180 degrees in the official FTC `field coordinate system
-<https://ftc-docs.firstinspires.org/en/latest/game_specific_resources/field_coordinate_system/field-coordinate-system.html>`_
+angle of -180 degrees in the official FTC 
+:ref:`field coordinate system <first field coordinate system>`
 :
 
 .. figure:: images/50-field-axes.png
@@ -250,8 +250,7 @@ angle of -180 degrees in the official FTC `field coordinate system
 
 This sample OpMode uses a reference frame (coordinate system) that may be
 different than what you expect from other FTC navigation applications,
-including `IMU or robot axes
-<https://ftc-docs.firstinspires.org/en/latest/programming_resources/imu/imu.html?highlight=field%20coordinates#axes-definition>`_\
+including :ref:`IMU or robot axes <imu axes def>`
 , odometry device axes, and the FTC field system (shown above).  These
 differences typically result in basic and obvious changes in axis direction,
 axis swapping, and orthogonal angles (90-degree increments).

diff --git a/docs/source/apriltag/vision_portal/apriltag_pose/apriltag-pose.rst b/docs/source/apriltag/vision_portal/apriltag_pose/apriltag-pose.rst
@@ -102,7 +102,7 @@ Sample OpModes:
 
 More discussion of AprilTag pose data is available here:
 
-- https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 
 ====
 

diff --git a/...ce/apriltag/vision_portal/apriltag_reference_frame/apriltag-reference-frame.rst b/...ce/apriltag/vision_portal/apriltag_reference_frame/apriltag-reference-frame.rst
@@ -96,7 +96,7 @@ Related Info
 
 More discussion of the AprilTag reference frame is available here:
 
-- https://ftc-docs.firstinspires.org/apriltag-detection-values
+:ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
 
 This section described the SDK's default AprilTag reference frame.  Teams are
 welcome to make other calculations, such as the pose of the camera (or robot)

diff --git a/docs/source/apriltag/vision_portal/visionportal_webcams/visionportal-webcams.rst b/docs/source/apriltag/vision_portal/visionportal_webcams/visionportal-webcams.rst
@@ -55,7 +55,7 @@ Logitech C310
 
    Logitech C310 Camera
 
-The `Logitech C310 <https://www.logitech.com/en-us/products/webcams/c310-hd-webcam.960-000585.html>`__
+The `Logitech C310 <https://www.logitech.com/en-us/products/webcams/c310-hd-webcam.html>`__
 is available at some online retailers.
 
 **FTC Hot Take:**
@@ -123,7 +123,7 @@ Microsoft LifeCam HD-3000 v1/v2
 
    Microsoft LifeCam HD-3000 v1/v2
 
-The `Microsoft LifeCam HD-3000 <https://www.microsoft.com/en/accessories/products/webcams/lifecam-hd-3000>`__
+The `Microsoft LifeCam HD-3000 <https://www.digitalcameraworld.com/reviews/microsoft-lifecam-hd-3000-review>`__
 is available at some online retailers.
 
 **FTC Hot Take:**
@@ -190,7 +190,7 @@ Arducam Global Shutter 120 FPS
    Arducam GS 120 Camera
 
 The `Arducam Global Shutter 120
-FPS <https://www.arducam.com/product/arducam-120fps-global-shutter-usb-camera-board-1mp-720p-ov9281-uvc-webcam-module-with-low-distortion-m12-lens-without-microphones-for-computer-laptop-android-device-and-raspberry-pi/>`__
+FPS <https://www.arducam.com/product/arducam-100fps-global-shutter-usb-camera-board-1mp-720p-ov9281-uvc-webcam-module-with-low-distortion-m12-lens-without-microphones-for-computer-laptop-android-device-and-raspberry-pi/>`__
 is available at some online retailers, including
 `Amazon <https://www.amazon.com/Arducam-Distortion-Microphones-Computer-Raspberry/dp/B096M5DKY6>`__.
 

diff --git a/docs/source/cad_resources/index.rst b/docs/source/cad_resources/index.rst
@@ -25,7 +25,7 @@ Here are a few tools commonly used by teams:
 Software for Beginners
 
 *  `Autodesk TinkerCAD <https://www.tinkercad.com/>`__ (free) (desktop)
-*  `FreeCAD <https://www.freecadweb.org/>`__ (free) (desktop)
+*  `FreeCAD <https://www.freecad.org/>`__ (free) (desktop)
 
 Software for Intermediate Users
 

diff --git a/docs/source/cad_resources/solidworks/solidworks.rst b/docs/source/cad_resources/solidworks/solidworks.rst
@@ -16,6 +16,6 @@ SOLIDWORKS® Training Videos
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Learning content for both the cloud-based and desktop-based tools is managed
-through the `3DS online learning portal <https://edu.3ds.com/en/learn/eduspace>`__,
+through the `3DS online learning portal <https://eduspace.3ds.com/CompanionManager/public/#/>`__,
 which manages access through your 3DEXPERIENCE ID.
 
diff --git a/docs/source/color_processing/color-locator-explore/color-locator-explore.rst b/docs/source/color_processing/color-locator-explore/color-locator-explore.rst
@@ -38,7 +38,7 @@ pattern.  This includes adding the "Color Blob Locator" Processor to the
 VisionPortal.
 
 The FTC VisionPortal was introduced in 2023. More information is available
-on the `ftc-docs VisionPortal Page <https://ftc-docs.firstinspires.org/apriltag-sdk>`_.
+on the :ref:`ftc-docs VisionPortal Page <apriltag/vision_portal/visionportal_overview/visionportal-overview:visionportal overview>`.
 
 Target Color Range
 ------------------

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -275,6 +275,10 @@
     },
 }
 
+linkcheck_allowed_redirects = {
+    r'https://ftc-docs\.firstinspires\.org/.*': r'https://ftc-docs\.firstinspires\.org/en/latest/.*'
+}
+
 # Firstinspires redirects to login and break our link checker :)
 # ftc-ml.firstinspires.org does a redirect that linkcheck hates.
 # GitHub links with Javascript Anchors cannot be detected by linkcheck
@@ -287,11 +291,16 @@
    r'https://wiki.dfrobot.com/.*#',
    r'https://www.solidworks.com/',
    r'https://sketchup.com/',
+   r'https://eduspace.3ds.com/',
+   r'https://www.dell.com/',
    r'https://april.eecs.umich.edu/',
    r'https://www.autodesk.com/',
    r'https://knowledge.autodesk.com/',
    r'https://www.3dflow.net/',
    r'https://stackoverflow.com',
+   r'http://192.168.43.1',
+   r'http://192.168.49.1',
+   r'https://javadoc.io/doc/org.firstinspires.ftc/',
 ]
 
 latex_documents = [

diff --git a/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst b/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst
@@ -283,8 +283,8 @@ brands are reputable and which ones are not? That's not always an easy thing to
 determine, however brands such as 
 `Anker <https://www.anker.com/collections/power-banks>`__, 
 `Belkin <https://www.belkin.com/products/chargers/portable-chargers-power-banks/>`__,
-`Otterbox <https://www.otterbox.com/en-us/power-packs>`__, and 
-`BioLite <https://www.bioliteenergy.com/collections/usb-battery-banks>`__ 
+`Otterbox <https://www.otterbox.com/en-us/portable-chargers>`__, and 
+`BioLite <https://www.bioliteenergy.com/collections/portable-battery-banks>`__ 
 are among the most-used brands in the world. *FIRST* Tech Challenge recommends
 choosing an internationally reputable brand, even if the brand is more
 expensive than a lesser-known brand, as these batteries will be more apt to

diff --git a/...rce/game_specific_resources/field_coordinate_system/field-coordinate-system.rst b/...rce/game_specific_resources/field_coordinate_system/field-coordinate-system.rst
@@ -1,3 +1,5 @@
+.. _first field coordinate system:
+
 *FIRST* Tech Challenge Field “Coordinate System" Definition
 ===========================================================
 

diff --git a/...rce/game_specific_resources/playing_field_resources/playing_field_resources.rst b/...rce/game_specific_resources/playing_field_resources/playing_field_resources.rst
@@ -15,30 +15,12 @@ in the official field drawings. The base field stays the same for all games but
 Traditional Field Setup Guide
 ------------------------------------
 
-This document can be found here: `Traditional Field Setup Guide <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/field-assembly-and-setup-guide.pdf>`__
+This document can be found here: `Traditional Field Setup Guide <https://ftc-resources.firstinspires.org/file/ftc/game/fieldguide>`__
 
 .. only:: html
 
    .. raw:: html
 
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/field-assembly-and-setup-guide.pdf" width="100%" height="700"></iframe>
-
-|
-
-Remote Field Setup Guide
-------------------------------------
-
-- No Remote Field Setup Guide released yet.
-
-.. comment
-   
-   .. only:: latex
-
-       `Remote Field Setup Guide <https://firstinspiresst01.blob.core.windows.net/first-energize-ftc/remote-field-requirements.pdf>`__
-
-   .. raw:: html
-
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-energize-ftc/remote-field-requirements.pdf" width="100%" height="700"></iframe>
-
-   |
+       <iframe id="iframepdf" src="https://ftc-resources.firstinspires.org/file/ftc/game/fieldguide" width="100%" height="700"></iframe>
 
+|
diff --git a/...uration/configuring/configuring_external_webcam/configuring-external-webcam.rst b/...uration/configuring/configuring_external_webcam/configuring-external-webcam.rst
@@ -24,7 +24,7 @@ with SDK software:
 -  `Logitech C270 HD
    Webcam <https://www.logitech.com/en-us/products/webcams/c270-hd-webcam.960-000694.html>`__
 -  `Logitech C310 HD
-   Webcam <https://www.logitech.com/en-us/products/webcams/c310-hd-webcam.960-000585.html>`__
+   Webcam <https://www.logitech.com/en-us/products/webcams/c310-hd-webcam.html>`__
 -  `Logitech C920 HD
    Webcam <https://www.logitech.com/en-us/products/webcams/c920s-pro-hd-webcam.960-001257.html>`__
 

diff --git a/docs/source/manuals/game_manuals/game_manuals.rst b/docs/source/manuals/game_manuals/game_manuals.rst
@@ -1,61 +1,5 @@
 Game Manuals
 ============
 
-Game Manuals can be found on the `Game and Season Materials page <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__ on the *FIRST* Website. They are presented here for your convenience.
-
-.. only:: html
-
-    .. tip:: To search all four PDFs at once, just perform a search within this webpage for the content you are looking for. Then simply scroll down to each PDF to see which PDFs contained the content you were looking for!
-
-Game Manual Part 1 Traditional Events
--------------------------------------
-
-`Game Manual Part 1 Traditional Events <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-1-traditional.pdf>`__
-
-.. only:: html
-
-   .. raw:: html
-
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-1-traditional.pdf" width="100%" height="700"></iframe>
-
-|
-
-Game Manual Part 2 Traditional Events
--------------------------------------
-
-`Game Manual Part 2 Traditional Events <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-2-traditional.pdf>`__
-
-.. only:: html
-
-   .. raw:: html
-
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-2-traditional.pdf"  width="100%" height="700"></iframe>
-
-|
-
-Game Manual Part 1 Remote Events
---------------------------------
-
-`Game Manual Part 1 Remote Events <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-1-remote.pdf>`__
-
-.. only:: html
-
-   .. raw:: html
-
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-1-remote.pdf"  width="100%" height="700"></iframe>
-
-|
-
-Game Manual Part 2 Remote Events
---------------------------------
-
-`Game Manual Part 2 Remote Events <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-2-remote.pdf>`__
-
-.. only:: html
-
-   .. raw:: html
-
-       <iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/game-manual-part-2-remote.pdf"  width="100%" height="700"></iframe>
-
-|
+Game Manuals can be found on the `Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`__ on the *FIRST* Website. They are presented here for your convenience.
 
diff --git a/...cturing/3d_printing/designing_and_slicing/slicing_settings/slicing_settings.rst b/...cturing/3d_printing/designing_and_slicing/slicing_settings/slicing_settings.rst
@@ -59,7 +59,7 @@ want to avoid support material by designing around it. But if not possible, it's
 control what areas you know need support. This makes cleanup after a print a lot easier. 
 
 If you want more info on supports, check out Prusa's guide `here!
-<https://help.prusa3d.com/en/article/support-material_1698>`_
+<https://help.prusa3d.com/article/support-material_1698>`_
 
 .. image:: images/prusa3dsupports.png
   :align: center

diff --git a/docs/source/persona_pages/mentor_tech/mentor_tech.rst b/docs/source/persona_pages/mentor_tech/mentor_tech.rst
@@ -45,18 +45,6 @@ Just click on the panel for the resource you want to explore!
       :class-header: sd-bg-primary font-weight-bold sd-text-white
       :class-body: sd-text-left
 
-      Programming Resources
-
-      ^^^
-
-      Look for Programming Resources for your team!
-
-   .. grid-item-card::
-      :link: http://firsttechchallenge.blogspot.com/2020/12/tips-for-your-teams-engineering.html
-      :link-type: url
-      :class-header: sd-bg-primary font-weight-bold sd-text-white
-      :class-body: sd-text-left
-
       Technical Writing Resources
 
       ^^^

diff --git a/docs/source/persona_pages/rookie_teams/rookie_teams.rst b/docs/source/persona_pages/rookie_teams/rookie_teams.rst
@@ -65,7 +65,7 @@ resource you want to explore!
 
          .. div:: col-sm pl-1 pr-1
 
-            .. button-link:: https://docs.revrobotics.com/kickoff-concepts/
+            .. button-link:: https://docs.revrobotics.com/ftc-kickoff-concepts/
                :color: black
                :outline:
                :expand:

diff --git a/docs/source/persona_pages/veteran_teams/veteran_teams.rst b/docs/source/persona_pages/veteran_teams/veteran_teams.rst
@@ -65,7 +65,7 @@ resource you want to explore!
                TensorFlow in CENTERSTAGE
 
    .. grid-item-card::
-      :link: https://www.firstinspires.org/resource-library/ftc/team-outreach-and-marketing-resources
+      :link: https://www.firstinspires.org/resource-library/ftc/team-management-resources
       :link-type: url
       :class-header: sd-bg-primary font-weight-bold sd-text-white
       :class-body: sd-text-left body
@@ -76,18 +76,6 @@ resource you want to explore!
 
       Links to marketing, community and industry outreach.
 
-   .. grid-item-card::
-      :link: http://firsttechchallenge.blogspot.com/2020/12/tips-for-your-teams-engineering.html
-      :link-type: url
-      :class-header: sd-bg-primary font-weight-bold sd-text-white
-      :class-body: sd-text-left
-
-      Engineering Notebook
-
-      ^^^
-
-      Examples and criteria for the engineering notebook and portfolio
-
    .. grid-item-card::
       :link: https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/award-descriptions.pdf
       :link-type: url

diff --git a/docs/source/programming_resources/imu/imu.rst b/docs/source/programming_resources/imu/imu.rst
@@ -159,6 +159,8 @@ re-open that OpMode to capture this updated configuration. Blocks are provided
 only for devices in the configuration that’s active*\  **upon opening**\  *an
 OpMode.*
 
+.. _imu axes def:
+
 Axes Definition
 ---------------
 
@@ -193,8 +195,8 @@ pointing along the positive axis, the fingers curl in the direction of
    *Fun fact: the IMU is located approximately under the word “PROUD”, near the
    lower right corner of the Hub.*
 
-This tutorial will **not** discuss the *FIRST* Tech Challenge `Field Coordinate System
-<https://ftc-docs.firstinspires.org/en/latest/game_specific_resources/field_coordinate_system/field-coordinate-system.html>`__.
+This tutorial will **not** discuss the *FIRST* Tech Challenge 
+:ref:`Field Coordinate System <first field coordinate system>`.
 Your OpModes might relate robot orientation to the overall field or `‘global
 coordinates’
 <https://github.com/FIRST-Tech-Challenge/FtcRobotController/wiki/Vuforia-for-Blocks#vuforia-introduction>`__
-Original file line number
+Diff line change
@@ Expand Up / @@ -102,7 +102,7 @@ Sample OpModes: @@
     More discussion of AprilTag pose data is available here:
-    - https://ftc-docs.firstinspires.org/apriltag-detection-values
+    :ref:`Understanding AprilTag Detection Values <apriltag/understanding_apriltag_detection_values/understanding-apriltag-detection-values:understanding apriltag detection values>`
     ====
@@ Expand Down @@