Skip to content

Commit e3a32ac

Browse files
committed
minor clean-up
1 parent df98def commit e3a32ac

File tree

4 files changed

+14
-17
lines changed

4 files changed

+14
-17
lines changed

docs/browser/prepare-fork.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,7 @@ Once all six <code>Secrets</code> have been added to your <code>LoopWorkspace</c
190190

191191
### Add Variable
192192

193-
This is a new step. It is already included in the `dev` branch and will be included in the `main` branch when `Loop 3.6.0` is released.
194-
195-
It is optional but strongly recommended.
193+
This is a new step. It will be used when `Loop 3.6.0` is released. This enables automatic generation and renewal of the certificates needed to build your app.
196194

197195
1. While in the same screen where you enter the `Secrets`, click on the `Variables` tab to the right of the `Secrets` tab:
198196
1. Select new variable and give it the name the `ENABLE_NUKE_CERTS` and enter `true` as the value
@@ -220,7 +218,7 @@ If you are someone who already has a lot of forks in your personal account and w
220218

221219
1. Follow the steps to create your organization
222220
* [Create a Free *GitHub* Organization](secrets.md#create-a-free-github-organization){: target="_blank" }
223-
1. Add the `Secrets` and the new `Enviornment` variable as explained in [Prepare to Enter `Secrets`](#prepare-to-enter-secrets)
221+
1. Add the `Secrets` and the `Variable` as explained in [Prepare to Enter `Secrets`](#prepare-to-enter-secrets)
224222
1. Fork all the repos you normally use, but this time, set your organization as the owner
225223
1. For each repository in your organization:
226224
* Tap on the Actions tab
@@ -237,7 +235,7 @@ If you are someone who already has a lot of forks in your personal account and w
237235

238236
**Important**
239237

240-
> Your personal *GitHub* account is still needed. The free organization points to your private account as a member. Please do not try to delete your personal *GitHub* account.
238+
> Your personal *GitHub* account is still needed. The free organization points to your private account as a member. If you delete your personal *GitHub* account, you lose access to your organization account too.
241239
242240
## Already Have&nbsp;<span translate="no">LoopWorkspace</span>?
243241

docs/browser/secrets.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
You need to save your information digitally, so you can copy and paste. The information is created in one place and used in another. Refer to [Configure <code>Secrets</code>](prepare-fork.md#configure-secrets){: target="_blank" } for how the <code>Secrets</code> are used. In addition to the 6 <code>Secrets</code>, other important information to keep handy (like usernames and passwords) is listed below. Be sure to keep this file secure.
1818

19-
**Created at developer.apple.com**
19+
**Created / used at developer.apple.com**
2020

2121
* Email address (this is your username)
2222
* password
@@ -26,14 +26,15 @@ You need to save your information digitally, so you can copy and paste. The info
2626
* <code>FASTLANE_KEY_ID</code>
2727
* <code>FASTLANE_KEY</code>
2828

29-
**Created at github.com**
29+
**Created / used at github.com**
3030

3131
* Email address
3232
* password
3333
* username
34-
* Your *GitHub* address will be: `https://github.com/my-name`
35-
* Your (optional but recommended) *GitHub* organization address will be : `https://github.com/my-name-org`
36-
* Your LoopWorkspace repository address will be: `https://github.com/my-name-org/LoopWorkspace`
34+
* If your username is `my-name` then:
35+
* Your *GitHub* address (URL) will be: `https://github.com/my-name`
36+
* Your (optional but recommended) *GitHub* organization address will be : `https://github.com/my-name-org`
37+
* Your LoopWorkspace repository address will be: `https://github.com/my-name-org/LoopWorkspace`
3738
* One item used as a Secret
3839
* *GitHub* Personal Access Token (<code>GH_PAT</code>)
3940

docs/nightscout/remote-config.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ API_SECRET
3636

3737
choose-something-hard-to-guess
3838

39-
* must contain at least 12 characters
40-
* hint: don’t make it too long and do not put special characters in it (better stick to letters and numbers)
41-
* It is case-sensitive
39+
* must contain at least 12 characters and is case-sensitive
40+
* hint: don’t make it too long, best to use letters and numbers,
41+
best to avoid special characters
4242

4343
If you also use Browser Build method, you need to be careful not to mix
4444
up your keys.

docs/version/development.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,14 @@ Please read this entire page before using any version of *Loop* other than the r
1212

1313
## Updates in `dev`
1414

15-
This section is an early look at major features added to dev since Loop 3.4 was released.
15+
This section is provides an overview of changes to dev compared to `Loop 3.4.4`.
1616

1717
### Add Automatic Certificate Generation and Renewal
1818

19-
These changes in the build process only work when `dev` is your default branch.
19+
These changes in the build process only work when `dev` is your default branch. Once `Loop 3.6.0` is released, these changes will work with the `main` branch.
2020

2121
Automatic certificate generation and renewal requires a `Variable` be added to your organization or your repository. Please see these instructions: [Add Variable](prepare-fork.md#add-variable){: target="_blank" }
2222

23-
Note - there is no harm adding the variable even before the code is updated to use it.
24-
2523
### Loop Updates
2624

2725
Updates made to Loop or LoopKit submodules affect the operation of Loop.

0 commit comments

Comments
 (0)