Merge pull request #899 from marionbarker/working-docs

Recommend GitHub Org method, add certificate Variable, update APNS, update dev status

Author: marionbarker

docs/browser/automatic.md

@@ -81,7 +81,7 @@ This is an optional step. If you are happy with the automatic sync and update, y
 ??? tip "Instructions to Modify the Automatic Actions (Click to Open/Close)"
     You can modify the automation by creating and using some variables.
 
-    To configure the automated build more granularly involves creating up to two environment variables: `SCHEDULED_BUILD` and/or `SCHEDULED_SYNC`. See [How to configure a variable](#how-to-configure-a-variable).
+    To configure the automated build more granularly involves creating up to two variables: `SCHEDULED_BUILD` and/or `SCHEDULED_SYNC`. See [How to configure a variable](#how-to-configure-a-variable).
 
     Note that the weekly and monthly `Build Loop` actions will continue, but the actions are modified if one or more of these variables is set to false. **A successful Action Log will still appear, even if no automatic activity happens**.
 

docs/browser/bb-errors.md

@@ -44,6 +44,8 @@ The steps on these pages must be completed (in order) for you to build an app us
 
 1. [Introduction and Summary](intro-summary.md){: target="_blank" }
 1. [Collect Secrets](secrets.md){: target="_blank" }
+    * Some from *Apple*
+    * Some from *GitHub*
 1. [Prepare Fork](prepare-fork.md){: target="_blank" }
 1. [Identifiers](identifiers.md){: target="_blank" }
 1. [Prepare App](prepare-app.md){: target="_blank" }
@@ -95,10 +97,14 @@ Instructions to make updates are found at:
 
 * [Update with Browser](bb-update.md){: target="_blank" }
 
-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:
+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" }
 
+After 3.6.0 is released, certificates will be automatically renewed. In the meantime, they must be renewed manually using these instructions:
+
+* [Renew Certificates](bb-update.md#renew-certificate){: target="_blank" }
+
 ## Other Topics
 
 ### Building the Development Version of the App
@@ -117,13 +123,13 @@ These considerations were prepared when most people were using a Mac computer to
 * 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)
 * Automatic Updates are loaded into *TestFlight*
-    * With version 3.4, builds are automatically prepared at least once a month
+    * 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
 * Manual Updates are easy
     * Starting an update takes a few minutes of your time; it can be done from your phone; the rest is automatic and is done in about an hour
 * After the *GitHub* Build starts, your app is ready to install on your *iPhone* in about an hour
 * The app is delivered to your phone via *TestFlight*
     * The app is considered "Beta" by  *Apple* and expires after 90 days
-    * <span translate="no">Loop 3.4</span>&nbsp; and later versions provide automatic build as the default
+    * <span translate="no">Loop 3.4</span>&nbsp; and newer versions provide automatic build as the default
 * Customization methods are documented at [Customize with Browser](custom-browser.md){: target="_blank" }
 

docs/browser/bb-overview.md

@@ -93,7 +93,7 @@ If you have one branch as default, for example `main`, and choose to build a dif
 
 The [Automatic Update & Build](automatic.md){: target="_blank" } features are applied to the default branch of your repository. Normally this is the `main` branch. If you are a developer or tester who wants the `dev` branch to be built automatically, you must configure it as your default branch. Be aware that for this situation, you will not get automatic updates of released code.
 
-Most people should keep `main` as default and make a considered decision when to launch a manual build of the `dev` branch. At that time, it will automatically update to the latest `dev` commit unless you have modified your environment settings: [Modify Automatic Building](automatic.md#modify-automatic-building){: target="_blank" }.
+Most people should keep `main` as default and make a considered decision when to launch a manual build of the `dev` branch. At that time, it will automatically update to the latest `dev` commit unless you have modified your settings with special `Variables`: [Modify Automatic Building](automatic.md#modify-automatic-building){: target="_blank" }.
 
 ## Change Default `Branch`
 

docs/browser/build-dev-browser.md

@@ -10,7 +10,9 @@
 !!! warning "Modules vs Submodule"
     This page has instructions to set up your own <code>fork</code> for the Modules, otherwise known as submodules, associated with&nbsp;<span translate="no">LoopWorkspace</span>&nbsp;that are needed for a selected customization.
 
-    Each Module has its own *GitHub* <code>repository</code>;and you will be working with your <code>fork</code> of that Module at https://github.com/username/Module, where username is your username.
+    Each Module has its own *GitHub* <code>repository</code>; and you will be working with your <code>fork</code> of that Module at https://github.com/my-name-org/Module, where you use your own organization (recommended) or personal account.
+
+    If you are an experienced builder who set the Submodule changes up in your personal *GitHub* account, you can leave those forks where they are, i.e., https://github.com/my-name/Module. You do not build from Submodules, so no `Secrets` are required.
 
 !!! question "What is a SHA-1?"
     SHA-1 means Secure Hash Algorithm 1; which is used to generate an alphanumeric code.
@@ -185,7 +187,7 @@ When you&nbsp;"<span translate="no">fork a repository"</span>, the default&nbsp;
     * Otherwise, when you a preparing a customization where the file changed sufficiently between `main` and `dev` and you want to build the `main` branch, you need to create a branch for this Module that is consistent with the version you wish to customize.
 
     ??? abstract "Use only if directed (Click to Open/Close)"
-        Open your browser to your https://github.com/username/Module URL. If you already created the `branch` you need, you do not need to create a new one.
+        Open your browser to your https://github.com/my-name-org/Module URL. If you already created the `branch` you need, you do not need to create a new one.
 
         If you are customizing a released version, use the [Table of SHA-1](#table-of-sha-1) under your version number below. Copy the SHA-1 for your Module so you can paste it into the URL in Step 2 below. The suggested branch name is `v-#.#.#` where #.#.# corresponds to the version number for `main`. You will use this in Step 3.3 below.
 
@@ -367,7 +369,7 @@ Save the customization lines in your text file for later use in the build_loop.y
 
 ```  { .sh .copy title="Customization Template:" }
 # Module: File: code customization description
-curl https://github.com/username/Module/commit/SHA-1.patch | git apply -v --directory=Module
+curl https://github.com/my-name-org/Module/commit/SHA-1.patch | git apply -v --directory=Module
 ```
 
 where:
@@ -379,7 +381,7 @@ where:
 * adding&nbsp;`.patch`&nbsp;after the SHA-1 informs *GitHub* to format that code change so it can be applied to your <code>fork</code>
 * the final&nbsp;<code> --directory=Module</code>&nbsp;is critical to apply the customization to the correct Module
 
-To view the exact code change associated with that patch, open a browser at the URL of&nbsp;`https://github.com/username/Module/commit/SHA-1`.
+To view the exact code change associated with that patch, open a browser at the URL of&nbsp;`https://github.com/my-name-org/Module/commit/SHA-1`.
 
 ## Update&nbsp;<span translate="no">LoopWorkspace</span>
 
@@ -412,11 +414,11 @@ Return to your&nbsp;<span translate="no">GitHub fork for LoopWorkspace</span>&nb
 
             # Submodule Loop patches:
             # Loop: Filename: customization details
-            #curl https://github.com/username/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
+            #curl https://github.com/my-name-org/Loop/commit/SHA-1.patch | git apply -v --directory=Loop
             
             # Submodule LoopKit patches:
             # LoopKit: Filename: customization details
-            #curl https://github.com/username/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
+            #curl https://github.com/my-name-org/LoopKit/commit/SHA-1.patch | git apply -v --directory=LoopKit
             
             # Submodule xxxxx patches: Follow prototype above
 

docs/browser/edit-browser.md

@@ -26,13 +26,16 @@
         * [Collect the four *Apple* <code>Secrets</code>](secrets.md#collect-the-four-apple-secrets){: target="_blank" }
     * *GitHub*:
         * [Collect the <code>GH_PAT</code> Secret](secrets.md#collect-the-gh_pat-secret){: target="_blank" }
+        * (Optional) [Create a Free *GitHub* Organization](secrets.md#create-a-free-github-organization){: target="_blank" } (strongly recommended)
     * [Make up a Password](secrets.md#make-up-a-password){: target="_blank" } and save it as your sixth `Secret`
 
     Now it's time to use those <code>Secrets</code> to build the Loop app
 
     * *GitHub*:
         * [`Fork` the repository (make your copy of <code>LoopWorkspace</code>)](prepare-fork.md#fork-loopworkspace){: target="_blank" }
-        * [Add <code>Secrets</code> to your `fork`](prepare-fork.md#configure-secrets){: target="_blank" }
+            * Using an organization? Add `Secrets` and `Variables` to your Organization and all your apps can use them
+            * Not using an organization? You have to add `Secrets` and `Variables` to each repository individually
+        * [Add <code>Secrets</code> to your `organization` or a single `fork`](prepare-fork.md#configure-secrets){: target="_blank" }
         * [`Action: 1. Validate Secrets`](identifiers.md#validate-secrets){: target="_blank" }
         * [`Action: 2. Add Identifiers`](identifiers.md#add-identifiers){: target="_blank" }
     * _<span translate="no">Apple</span>_:
@@ -61,6 +64,18 @@ The steps to configure for building with a browser require a lot of focused atte
 
     * [Click here to find help](bb-errors.md#help-with-errors){: target="_blank" }.
 
+???+ tips "Who should use a free GitHub Organization option (click to close/open)"
+    There are several places where you see a recommendation to use a free GitHub Organization instead of building directly from your personal free GitHub account.
+
+    When you use an organization, you don't have to add 6 Secrets to each repository for every app you build. It can save a lot of time in the long run.
+
+    * Even if you just build Loop and nothing else, using an organization is pretty easy and your build works just the same as using only a personal account
+    * Who should definitely build with an organization:
+        * Anyone who is a caregiver will want LoopCaregiver or LoopFollow or both
+        * Anyone who wants to use LoopFollow for the amazing alarm capabilties
+        * Anyone who might want to try a customized version of Loop
+        * Anyone who might want to try a different app such as xDrip4iOS or Trio
+
 ### The Short Version
 
 Complete instructions are found at this link for those comfortable with using *GitHub* and navigating the *Apple Developer* and *Apple App Connect* pages.
@@ -103,7 +118,7 @@ You need to keep a digital copy of your 6 <code>Secrets</code>.
 !!! important "Use a Text-Only Editor"
     **Be sure to use a Text-Only editor like NotePad (PC) or TextEdit (Mac) to archive your information.**
 
-    If you use a "smart" editor, it may change lower-case letters to upper-case letters at the beginning of a line when you paste items into your archive file.
+    If you use a "smart" editor, it may change small letters to capital letters at the beginning of a line when you paste items into your archive file.
 
     If even one character is capitalized when it should not be, you will get errors.
 
@@ -123,6 +138,7 @@ You don't need to know anything about the <code>Secrets</code> to do this. Come
     * There is a reference pattern for each SECRET: replace that with your SECRET or you can add your secret below the pattern to give yourself confidence you got the correct item
 4. In addition to the <code>Secrets</code>, this template has places for other pieces of information you may find handy to save in the same file
 5. At the very beginning is a place to indicate the last day you updated the file
+6. If you use Nightscout, you may also want the [Nightscout template](../nightscout/remote-config.md#save-your-important-nightscout-information){: target="_blank" }
 
 ``` { .bash .copy title="Template to use for Secrets" }
 MySecretsReferenceFile.txt
@@ -142,15 +158,17 @@ suggest you use your desired password tool to save the password for this account
 <your information here>
 suggest you use your desired password tool to save the password for this account
 
-These are the Six Secrets in alphabetical order - each one shows the expected format.
-Delete each prototype as you gather your own secrets.
-The letter A indicates an alphanumeric character.
-Some may be lower case, some upper case and some numerals.
+There are Six Secrets and One Variable:
+ - the list below shows the expected format of each.
+You can replace each prototype with your secret as you gather them,
+ - or put your secret below a prototype.
+The letter A indicates an alphanumeric character;
+ - some may be small letter, some capital letters and some numerals.
 The FASTLANE_KEY may have additional characters included.
-For that one copy the entire key
-including -----BEGIN PRIVATE KEY-----
-through
------END PRIVATE KEY-----
+  Be sure to copy the entire key including
+  -----BEGIN PRIVATE KEY-----
+  through
+  -----END PRIVATE KEY-----
 
 ## SECRETS BELOW:
 
@@ -166,7 +184,6 @@ FASTLANE_KEY_ID
 <looks like this>
 AAAAAAAAAA
 
-
 FASTLANE_KEY
 <looks like this>
 -----BEGIN PRIVATE KEY-----
@@ -184,9 +201,21 @@ MATCH_PASSWORD
 <looks like this>
 AnyThingYouWant-sameForEveryRepository
 
+New addition, this Variable:
+
+ENABLE_NUKE_CERTS = true
+
+With release of Loop 3.6.0:
+  this variable is needed to automatically renew your certificates when they expire.
+
 ## Repository Names for my Fork:
 
-https://github.com/my-github-username/LoopWorkspace
+If you use an organization (recommended)
+https://github.com/my-name-org/LoopWorkspace
+
+or (if you don't use an organzation): 
+https://github.com/my-name/LoopWorkspace
+
 
 Add additional apps here if you decide to build any
 ```

docs/browser/img/fork-org.gif

@@ -408,12 +408,11 @@ The [Install on Phone](phone-install.md) walks you through the steps to install
 This section is optional. It is provided to assist:
 
 * Users who are using *GitHub* for other reasons and want to segregate their DIY app building from their existing accounts
-* Mentors who want to do a lot of testing of many DIY apps to support people and get tired of entering the 6 <code>Secrets</code> repeatedly
-* Users who are comfortable with the *GitHub* web interface who want the convenience of entering the 6 <code>Secrets</code> just one time instead of entering them for each <code>repository</code> individually
+* Users who want the convenience of entering the 6 <code>Secrets</code> just one time instead of entering them for each <code>repository</code> individually
 
 ### Set up a Free *GitHub* Organization
 
-Prerequisite: You need a personal *GitHub* account.
+Prerequisite: You need a personal *GitHub* account. If you do not already have a personal *GitHub* account, click on [New *GitHub* Account](secrets.md#new-github-account){: target="_blank" }.
 
 In the instructions below, use your *GitHub* username instead of `my-name`.
 

docs/browser/img/gh-fork-loopworkspace.svg docs/browser/img/gh-fork-loopworkspace-top.svg

@@ -270,6 +270,8 @@ If you have previously used some kind of remote build, like `diawi` or `TestFlig
 
 ### Remove Apple Vision Pro
 
+> This might not be displayed anymore. Leaving it here in case you see this.
+
 It is now time to edit the availability of your app on Apple Vision Pro. If you skip this step, you will get an annoying email telling you Apple Vision Pro is not supported by your app.
 
 * First click to return to the main [App Store Connect](https://appstoreconnect.apple.com/apps){: target="_blank" }. In the message section labeled **iOS Apps on Apple Vision Pro**, click on "Edit Availability", highlighted by the red rectangle in the graphic below.