Merge pull request #915 from marionbarker/add_include_and_external_site_features

Automate handling of external links

Author: marionbarker

README.md

@@ -14,7 +14,7 @@ This repository contains the source files for [Loop's](https://github.com/LoopKi
 - [**Requirements**](https://loopkit.github.io/loopdocs/intro/requirements/)
 - [Build Loop](https://loopkit.github.io/loopdocs/intro/requirements/#two-loop-build-methods)
 - [Configuration](https://loopkit.github.io/loopdocs/loop-3/loop-3-overview/)
-- [Usage](https://loopkit.github.io/loopdocs/operation/loop/open-loop/)
+- [Usage](https://loopkit.github.io/loopdocs/operation/loop/close-loop/)
 - [Troubleshooting](https://loopkit.github.io/loopdocs/troubleshooting/overview/)
 - Remote monitoring and commands with [*Nightscout*](https://loopkit.github.io/loopdocs/nightscout/overview/)
 - [FAQs](https://loopkit.github.io/loopdocs/faqs/overview-faqs/)
@@ -52,7 +52,8 @@ If it is a more substantive change and you want to [install LoopDocs locally](#i
   ```shell
   cd loopdocs # Make sure you are in the folder where you cloned this repository
 
-  python -m pip install -r requirements.txt  
+  python -m pip install -r dev-requirements.txt
+  python -m pip install -r requirements.txt
   ```
 
 ## Run

dev-requirements.in

@@ -0,0 +1 @@
+pip-tools

dev-requirements.txt

@@ -0,0 +1,24 @@
+#
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
+#
+#    pip-compile --output-file=dev-requirements.txt dev-requirements.in
+#
+build==1.2.2.post1
+    # via pip-tools
+click==8.1.7
+    # via pip-tools
+packaging==24.1
+    # via build
+pip-tools==7.4.1
+    # via -r dev-requirements.in
+pyproject-hooks==1.2.0
+    # via
+    #   build
+    #   pip-tools
+wheel==0.44.0
+    # via pip-tools
+
+# The following packages are considered to be unsafe in a requirements file:
+# pip
+# setuptools

docs/browser/automatic.md

@@ -97,7 +97,7 @@ The `alive` branch you need is created automatically when you run the `Build Loo
 !!! warning "I got an error regarding a branch with `alive` in the name"
     * Sometimes you get an error about an `alive` branch
     * If you do get an error, simply delete the branch and run the `Build Loop` action again
-        * Use this [GitHub link](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch){: target="_blank" } or ask for help when deleting a branch
+        * Use this [GitHub link](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#deleting-a-branch) or ask for help when deleting a branch
     * You can delete every branch that starts with the name `alive`
     * Leave the other branches alone unless a mentor directs you to take action
 
@@ -217,7 +217,7 @@ Your build will run on the following conditions:
 
 To enable the scheduled build and sync, the `GH_PAT` must hold the `workflow` permission scopes. This permission serves as the enabler for automatic and scheduled builds with browser build. To disable this, follow these steps:
 
-1. Go to your [FastLane Access Token](https://github.com/settings/tokens){: target="_blank" }
+1. Go to your [FastLane Access Token](https://github.com/settings/tokens)
 1. If it says `repo`, `workflow` next to the `FastLane Access Token` link, then automatic building is enabled
 1. To disable automatic update and build, click on the link to open the token detail view
     * Click to uncheck the `workflow` box
@@ -236,7 +236,7 @@ What if I decide I don't want the automatic building feature?
     * Otherwise, you may see the dreaded "Loop Beta has expired" message, have a Loop that won't open and not have a version ready to go in TestFlight that you can install within a few seconds
 
 * If you are taking a break from Loop and want to stop monthly Build emails, consider disabling actions for the `Build Loop` action for your app.
-    * [GitHub Directions to Disable and Enable a Workflow](https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow#disabling-a-workflow){: target="_blank" }
+    * [GitHub Directions to Disable and Enable a Workflow](https://docs.github.com/en/actions/using-workflows/disabling-and-enabling-a-workflow#disabling-a-workflow)
     * It is the Build action that kicks off the update and build steps, so simply disabling the one action is sufficient
 
 * If you are done with Loop, you can delete the whole repository; but you should be sure about this because you'll need to start over with [Configure to use Browser](bb-overview.md#configure-to-use-browser) to restore ability to build Loop with GitHub.

docs/browser/bb-errors.md

@@ -28,8 +28,8 @@ If you are having trouble:
 
 These are two places to ask for help, but please choose only one. You may get a faster response from Facebook, but there are mentors on both sites:
 
-* [LoopandLearn Facebook Group](https://www.facebook.com/groups/LOOPandLEARN){: target="_blank" }
-* [Zulipchat: Loop: Build Help]( https://loop.zulipchat.com/#narrow/channel/148543-Loop/topic/Browser.20Build){: target="_blank" }
+* [LoopandLearn Facebook Group](https://www.facebook.com/groups/LOOPandLEARN)
+* [Zulipchat: Loop: Build Help]( https://loop.zulipchat.com/#narrow/channel/148543-Loop/topic/Browser.20Build)
 
 ### What Information is Needed for Help
 
@@ -298,7 +298,7 @@ If there are *Apple* Developer agreements you have not accepted, you may get err
 * If you previously built successfully - it is almost certainly the agreement
 * It can take 15 minutes to an hour after the agreement is signed before it can be used
 
-If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement){: target="_blank" }.
+If you need detailed instructions, click on this [<code>Apple Program License Agreement</code> Help Page](https://support.pushpay.com/s/article/Accepting-the-Apple-Program-License-Agreement).
 
 You can also get this message if the credit card used to purchase the Developer account is not current, e.g., no longer valid or credit card expiration date, as entered at *Apple*, has passed.
 
@@ -428,7 +428,7 @@ Click on this link to [Delete Identifiers](#delete-identifiers).
 #### Rerun Steps with correct TEAMID
 
 1. Enter your `TEAMID` correctly in the repository `Secrets`
-    - Make sure you use copy and paste from your [Apple Developer Membership](https://developer.apple.com/account/#!/membership){: target="_blank" } page for that `TEAMID`.
+    - Make sure you use copy and paste from your [Apple Developer Membership](https://developer.apple.com/account/#!/membership) page for that `TEAMID`.
     - Follow the update instructions here (this example is for `GH_PAT`, you'll do the same but for `TEAMID`) [Update Secrets](bb-update.md#update-secrets)
 
 1. Run Action: [Configure to Use Browser: `Add Identifiers`](identifiers.md#add-identifiers) again
@@ -441,7 +441,7 @@ You will remove that app and create a new one.
 
 #### Remove App with Incorrect `TEAMID`
 
-Go to [`App Store Connect / Apps`](https://appstoreconnect.apple.com/apps){: target="_blank" } and follow the numbered steps in the graphic below.
+Go to [`App Store Connect / Apps`](https://appstoreconnect.apple.com/apps) and follow the numbered steps in the graphic below.
 
 1. Find the *Loop* app you created earlier and click on it
 2. On the left side, under `General`, click on `App Information`
@@ -493,7 +493,7 @@ If you see this phrase, the `fastlane` package that is utilized during the `3. C
 
 To fix this error:
 
-- Open this link: [https://github.com/settings/tokens/](https://github.com/settings/tokens/){: target="_blank" }
+- Open this link: [https://github.com/settings/tokens/](https://github.com/settings/tokens/)
   - Here you will see your personal access token (`Fastlane Access Token`) that was created during [Configure to Use Browser: Setup *GitHub*: Create `GitHub Personal Access Token`](../browser/secrets.md#create-github-personal-access-token)
   - Note that `Tokens (classic)` is highlighted in the menu on the left
   - Click on the token name (should be bold, blue **`Fastlane Access Token`** ) to open its detail page
@@ -545,7 +545,7 @@ These steps are only needed to make room for a `Certificate` when running versio
 
 1. Delete an old `Distribution Certificate`
     * *Apple* limits you to two `Distribution Certificates`
-    * Use this link to view your [Apple Developer Certificates](https://developer.apple.com/account/resources/certificates/list){: target="_blank" }
+    * Use this link to view your [Apple Developer Certificates](https://developer.apple.com/account/resources/certificates/list)
         * Carefully examine the `Type` column - do **not** delete a `Development` `Certificate`
         * If you accidentally delete a `Development` `Type` certificate associated with an Xcode build for your Loop app - it will stop working and you will be very sad
     * Click on the oldest `Distribution` `Certificate` and revoke it
@@ -598,7 +598,7 @@ If that phrase is found, then:
 
 
 * This can also be caused if you correctly created the *Loop* App but entered an incorrect value for the `TEAMID`.
-    * If you have the incorrect `TEAMID`, check this link: [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } for entries with the incorrect `TEAMID` embedded
+    * If you have the incorrect `TEAMID`, check this link: [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list) for entries with the incorrect `TEAMID` embedded
     * For example, if your `TEAMID` is `0123456789`, but you entered `000123`, you may see both of these in your identifiers list
         * `com.0123456789.loopkit.Loop`
         * `com.000123.loopkit.Loop`
@@ -655,7 +655,7 @@ This tells you, the `Bundle ID` you selected in [First-Time: Create Loop App in
 
 Once you have created an app in the *App Store* that is not based on your `TEAMID`, you cannot delete it, but you can Remove it (i.e. hide it so that it is no longer visible on this page and you don't accidentally click on it).
 
-1. Open this link: [App Store Connect / Apps](https://appstoreconnect.apple.com/apps){: target="_blank" } to view your apps; log in if needed.
+1. Open this link: [App Store Connect / Apps](https://appstoreconnect.apple.com/apps) to view your apps; log in if needed.
 1. Find the App with the wrong `Bundle ID` and click on it
 1. On the left-hand side, click on `App Information` (under `General`)
     * Confirm the `Bundle ID` listed does not include your `TEAMID`
@@ -787,7 +787,7 @@ Once you get a successful build, you return to using your normal `branch` for fu
 
 Assuming you have successfully built using the Browser-Build / *GitHub* method before:
 
-* If the details show this message, `Could not install WWDR certificate`, make sure your [*Apple developer* account](https://developer.apple.com){: target="_blank" } is in good standing and that there are no agreements that need to be accepted and that your `Distribution Certificates` did not expire
+* If the details show this message, `Could not install WWDR certificate`, make sure your [*Apple developer* account](https://developer.apple.com) is in good standing and that there are no agreements that need to be accepted and that your `Distribution Certificates` did not expire
 * Sometimes this is a sign that *Apple* did not respond to a request, this failure happens in the first few minutes
     * Repeat the build and it should be fine the next time
 
@@ -811,7 +811,7 @@ There might be several reasons to do this:
 These steps are needed to reset your `Match-Secrets`:
 
 1. Delete your `Match-Secrets` `Repository`
-    * Instructions to delete a repository are found at [*GitHub* Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/deleting-a-repository){: target="_blank" }
+    * Instructions to delete a repository are found at [*GitHub* Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/deleting-a-repository)
 1. In your fork of LoopWorkspace:
     * This will automatically create a new `Match-Secrets` `Repository` for you
     * Run the `Action`: `Create Certificates`
@@ -835,7 +835,7 @@ These instructions are useful if:
 
 The `Identifier` that is associated with the `Loop` identifier cannot be deleted if it is already in the *App Store* but all others can. If you attempt to delete the `XC` *Loop* identifier, you may be told it cannot be deleted because it is in use in the app store. That's OK. If a `Bundle ID` has ever been associated with an app in the *App Store*, you cannot delete the `Identifier`.
 
-* Open this link: [Certificates, Identifiers & Profiles: Identifiers List](https://developer.apple.com/account/resources/identifiers/list){: target="_blank" } on the *Apple Developer* site.
+* Open this link: [Certificates, Identifiers & Profiles: Identifiers List](https://developer.apple.com/account/resources/identifiers/list) on the *Apple Developer* site.
 * Use the graphic below as a guide to removing identifiers
 * Keep repeating the steps until you've removed all the identifiers you can (or want to) delete
 * It is OK to delete an identifier even if it does have your correct `TEAMID`

docs/browser/bb-overview.md

@@ -30,13 +30,13 @@ To build the&nbsp;_<span translate="no">Loop</span>_&nbsp;app using a browser, y
 
 Complete instructions are found at this link for those comfortable with using *GitHub* and navigating the *Apple Developer* and *Apple App Connect* pages.
 
-* [Using GitHub Actions + FastLane to deploy to TestFlight](https://github.com/LoopKit/LoopWorkspace/blob/main/fastlane/testflight.md){: target="_blank" }
+* [Using GitHub Actions + FastLane to deploy to TestFlight](https://github.com/LoopKit/LoopWorkspace/blob/main/fastlane/testflight.md)
 
 ### How-to Video to Build with a Browser
 
 In addition to the pages linked below in [Configure to use Browser](#configure-to-use-browser), there is a narrated video of each step needed to build using a browser. (This video shows build steps for version 3.2.3 or older. Some items are simplified for version 3.4.1 and newer.)
 
-* [How to Build the *Loop* App With a Web Browser](https://www.youtube.com/watch?v=kiu5ho0MTW8){: target="_blank" }
+* [How to Build the *Loop* App With a Web Browser](https://www.youtube.com/watch?v=kiu5ho0MTW8)
 
 ### Configure to use Browser
 
@@ -98,7 +98,7 @@ Instructions to make updates are found at:
 
 There is also a helpful video for this process. Once again, this was prepared for an earlier version 3.2.3 or older. With version 3.4.1 and newer, the update and build is automatic if your *Apple* Developer account is active, agreements are signed and certificates are valid:
 
-* [How to Update and Rebuild DIY Loop with a Web Browser](https://www.youtube.com/watch?v=0ipTsiqbbrQ){: target="_blank" }
+* [How to Update and Rebuild DIY Loop with a Web Browser](https://www.youtube.com/watch?v=0ipTsiqbbrQ)
 
 > With `Loop 3.6.0`, certificates are automatically created and renewed. You no longer need to renew certificates as a separate step.
 
@@ -118,7 +118,7 @@ These considerations were prepared when most people were using a Mac computer to
     * Anything with a browser works to build the *Loop* app: PC, Tablet, Mac or iPad
     * The *TestFlight* app is used to install the *Loop* app on your iPhone
 * Compatible version of *Xcode* is provided by *GitHub*
-    * The time required for the initial setup to build with a browser may take less time than one *macOS* and *Xcode* version update for those using [Build with *Mac*](../build/overview.md)
+    * The time required for the initial setup to build with a browser may take less time than one *macOS* and *Xcode* version update for those using [Build with *Mac*](../build/overview.md){: target="_blank" }
 * Automatic Updates are loaded into *TestFlight*
     * With version 3.4 and newer, builds are automatically prepared at least once a month
     * You choose when to install the new app from TestFlight onto your phone