From 917e2932e0b630f0817a0df6d9f6a48ed095aa96 Mon Sep 17 00:00:00 2001
From: Rachael Shaw <r@rachael.wtf>
Date: Wed, 3 Jan 2024 22:58:11 -0600
Subject: [PATCH] Update comment about how we use redirects & add reminder in
 user story template (#15520)

Per discussion with @noahtalerman and @marko-lisica today: we're going
to aim to always add redirects in `/website/config/routes.js` for any
docs/external pages we link to in the Fleet UI & CLI, to reduce surface
areas of PRs when doc headings change or things are moved around...

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
---
 .github/ISSUE_TEMPLATE/story.md | 2 +-
 website/config/routes.js        | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md
index 3a12549cd3..c595c238fa 100644
--- a/.github/ISSUE_TEMPLATE/story.md
+++ b/.github/ISSUE_TEMPLATE/story.md
@@ -26,7 +26,7 @@ It is [planned and ready](https://fleetdm.com/handbook/company/development-group
 - [ ] CLI usage changes: TODO <!-- Specify what changes to the CLI usage are required. Remove this checkbox if there are no changes to the CLI. -->
 - [ ] REST API changes: TODO <!-- Specify what changes to the API are required.  Remove this checkbox if there are no changes necessary. The product manager may move this item to the engineering list below if they decide that engineering will design the API changes. -->
 - [ ] Permissions changes: TODO <!-- Specify what changes to the permissions are required.  Remove this checkbox if there are no changes necessary. -->
-- [ ] Outdated documentation changes: TODO <!-- Specify required documentation changes. If none, state why. -->
+- [ ] Outdated documentation changes: TODO <!-- Specify required documentation changes & redirects to add to /website/config/routes.js. -->
 - [ ] Changes to paid features or tiers: TODO  <!-- Specify "Fleet Free" or "Fleet Premium".  If only certain parts of the user story involve paid features, specify which parts.  Implementation of paid features should live in the `ee/` directory. -->
 - [ ] Scalability testing: TODO  <!-- List any required scalability testing to be conducted.  Remove this checkbox if there is no scalability testing required. -->
 
diff --git a/website/config/routes.js b/website/config/routes.js
index 8e31807329..e9b52a17ea 100644
--- a/website/config/routes.js
+++ b/website/config/routes.js
@@ -501,8 +501,8 @@ module.exports.routes = {
 
   // Fleet UI
   // =============================================================================================================
-  // These are external links not maintained by Fleet. We can point the Fleet UI to redirects here instead of the
-  // original sources to help avoid broken links.
+  // Redirects for external links from the Fleet UI & CLI, including to fleetdm.com and to external websites not
+  // maintained by Fleet. These help avoid broken links by reducing surface area of links to maintain in the UI.
   'GET /learn-more-about/chromeos-updates': 'https://support.google.com/chrome/a/answer/6220366',
   'GET /learn-more-about/just-in-time-provisioning': 'https://fleetdm.com/docs/deploy/single-sign-on-sso#just-in-time-jit-user-provisioning',
   'GET /sign-in-to/microsoft-automatic-enrollment-tool': 'https://portal.azure.com',