Skip to content

Commit b468127

Browse files
authored
Merge pull request #901 from marionbarker/working-docs
Update directions and graphics
2 parents a2bde4c + 709dfb2 commit b468127

27 files changed

+4787
-11947
lines changed

docs/browser/bb-errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ Once you have created an app in the *App Store* that is not based on your `TEAMI
492492
* Tap on `Remove App`
493493
* New dialog window appears, select `Remove`
494494
495-
At this point, get your correct `TEAMID`, fix your Secrets file to have the correct `TEAMID` and then return to [First-Time: Configure Secrets](prepare-fork.md#configure-secrets). This time you will be updating `TEAMID` in the repository secret list.
495+
At this point, get your correct `TEAMID`, fix your Secrets file to have the correct `TEAMID` and then return to [First-Time: Configure Secrets](prepare-fork.md#configure-secrets). This time you will be updating `TEAMID` in the secret list.
496496
497497
## Repeat `Build Loop` Errors
498498

docs/browser/bb-overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ In addition to the pages linked below in [Configure to use Browser](#configure-t
4040

4141
### Configure to use Browser
4242

43-
The steps on these pages must be completed (in order) for you to build an app using a browser:
43+
The steps on these pages must be completed for you to build an app using a browser:
4444

4545
1. [Introduction and Summary](intro-summary.md){: target="_blank" }
4646
1. [Collect Secrets](secrets.md){: target="_blank" }
4747
* Some from *Apple*
4848
* Some from *GitHub*
4949
1. [Prepare Fork](prepare-fork.md){: target="_blank" }
50-
1. [Identifiers](identifiers.md){: target="_blank" }
50+
1. [Prepare Identifiers](identifiers.md){: target="_blank" }
5151
1. [Prepare App](prepare-app.md){: target="_blank" }
52+
1. [Prepare *TestFlight* Group](tf-users.md){: target="_blank" }
5253
1. [Create Certificates](certs.md){: target="_blank" }
5354
1. [Build the *Loop* App](build-yml.md){: target="_blank" }
54-
1. [*TestFlight* Users](tf-users.md){: target="_blank" }
5555

5656
The pages of instructions listed above give detailed steps on how to build the *Loop* app. If you are building a different app, you can follow the detailed instructions but will need to know the Fork, App Name, Identifiers and in some cases App Group for the App you intend to build. Once you build one app, subsequent apps are much easier to build.
5757

docs/browser/bb-update.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ If your `Personal Access Token` has expired or has an expiration date, you can r
443443
!!! tip "Update new GH_PAT to <code>Secrets</code>"
444444
After you get your new token, immediately add it to your <code>Secrets</code> for any app you build with this method. You don't have to rebuild the app, but it's a good idea to at least run `Action 1. Validate Secrets` for each repository to make sure you did not make a mistake.
445445

446+
This might be a good time to [Switch to a GitHub Organization](prepare-fork.md#switch-to-a-github-organization){: target="_blank" }.
447+
446448
You can regenerate your *GitHub* `Personal Access Token` at any time by clicking on the link below. (it will open in a new browser tab.)
447449

448450
* [Link to access your *GitHub* Personal Access Token](https://github.com/settings/tokens){: target="_blank" }
@@ -478,17 +480,17 @@ The next step is to update GH_PAT in your <code>Secrets</code>. (If you build ot
478480

479481
### Update <code>Secrets</code>
480482

481-
This example is for updating GH_PAT in the <code>Secrets</code> for your `repository`, but the same method can be applied when changing any of the <code>Secrets</code>.
483+
This example is for updating GH_PAT in the <code>Secrets</code> for your `repository`, but the same method can be applied when changing any of the <code>Secrets</code>. It uses a personal account, instead of an organization. So it shows changing the `Secret` for a specific repository and would need to be repeated for every repository you use. This might be a good time to [Switch to a GitHub Organization](prepare-fork.md#switch-to-a-github-organization){: target="_blank" }.
482484

483485
Open the `repository` for which you will update <code>Secrets</code>. On the far right is a Settings selection. If you don't see Settings (if last item on row is Insights), then you are **not** on your `fork` or you need to sign in to your *GitHub* account. You should see `username/LoopWorkspace` with `forked` from `LoopKit/LoopWorkspace` underneath.
484486

485487
Refer to the GIF for help. There are 3 frames.
486488

487-
![screen showing repository secrets list](img/update-secret-gh-pat.gif){width="500"}
489+
![screen showing secrets list](img/update-secret-gh-pat.gif){width="500"}
488490
{align="center"}
489491

490492
1. Tap on Settings, then scroll down until you see `Secrets and variables` on the left side and click on the drop down indicator to display `Actions`.
491-
1. Keep scrolling on the same screen, past the `Action secrets / New repository secret` row, until you see the list of your current <code>Secrets</code>.
493+
1. Keep scrolling on the same screen, past the `Action secrets / New secret` row, until you see the list of your current <code>Secrets</code>.
492494
1. Click on the GH_PAT, tap on the pencil and enter the new token in the form. Click on Update Secret to complete the action.
493495

494496
Scroll all the way to the top of the screen and tap on your LoopWorkspace link. Then follow the [How to Update or Rebuild](#how-to-update-or-rebuild) instructions to start a new build.

docs/browser/build-yml.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@
1010
* one says *TestFlight* is ready (typically half-hour after the build succeeds)
1111
* Ignore the one that says you need to fix "issues" in your app. You are not selling the app in the app store; so no action is required. The app you built is for personal use for you or a family member.
1212
1. Your app should eventually appear on [App Store Connect](https://appstoreconnect.apple.com/apps){: target="_blank" }.
13-
1. For each phone/person you would like to support:
14-
* Add them in [Users and Access](https://appstoreconnect.apple.com/access/users){: target="_blank" } on App Store Connect.
15-
* Add them to your *TestFlight* Internal Testing group.
16-
17-
[<span class="loop-bigger">:material-skip-forward:</span>](tf-users.md#testflight-users-overview) To skip the detailed instructions, click on [*TestFlight* Users Overview](tf-users.md#testflight-users-overview).
1813

1914
Refer to the graphic below for the first four steps:
2015

@@ -63,14 +58,16 @@ Did you get a red X? Head over to the [Errors with Browser](bb-errors.md){: targ
6358

6459
## Next Steps
6560

66-
If this is your first build, you need to configure your TestFlight Users
67-
68-
* [TestFlight Users](tf-users.md)
61+
It may take up to an hour for your new build to appear in TestFlight.
6962

70-
If this is a repeat build, wait up to an hour for your new build to appear in TestFlight. Then from the phone where you want to install the *Loop* app, use TestFlight on that phone to install the app.
63+
From the phone where you want to install the *Loop* app, use TestFlight on that phone to install the app.
7164

7265
* [Install on Phone](phone-install.md)
7366

67+
If is you skipped the step about creating a *TestFlight* Group or want to add another person to your group:
68+
69+
* [TestFlight Group](tf-users.md)
70+
7471
## Caregivers
7572

7673
If you are a Caregiver who helps manage a loved-ones diabetes, you may use other open-source apps that can be built the same way:
-114 KB
Binary file not shown.
Binary file not shown.

docs/browser/img/add-secrets-org.png

-125 KB
Binary file not shown.

0 commit comments

Comments
 (0)