Skip to content

Commit defc819

Browse files
committed
Deploying to gh-pages from @ 296d892 🚀
1 parent 2959ee2 commit defc819

File tree

9 files changed

+127
-19
lines changed

9 files changed

+127
-19
lines changed

browser/bb-errors/index.html

Lines changed: 70 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1098,6 +1098,24 @@
10981098
<nav class="md-nav" aria-label="Help with Errors">
10991099
<ul class="md-nav__list">
11001100

1101+
<li class="md-nav__item">
1102+
<a href="#where-to-get-help-with-browser-build" class="md-nav__link">
1103+
<span class="md-ellipsis">
1104+
Where to Get Help with Browser Build
1105+
</span>
1106+
</a>
1107+
1108+
</li>
1109+
1110+
<li class="md-nav__item">
1111+
<a href="#what-information-is-needed-for-help" class="md-nav__link">
1112+
<span class="md-ellipsis">
1113+
What Information is Needed for Help
1114+
</span>
1115+
</a>
1116+
1117+
</li>
1118+
11011119
<li class="md-nav__item">
11021120
<a href="#most-common-mistakes" class="md-nav__link">
11031121
<span class="md-ellipsis">
@@ -3679,6 +3697,24 @@
36793697
<nav class="md-nav" aria-label="Help with Errors">
36803698
<ul class="md-nav__list">
36813699

3700+
<li class="md-nav__item">
3701+
<a href="#where-to-get-help-with-browser-build" class="md-nav__link">
3702+
<span class="md-ellipsis">
3703+
Where to Get Help with Browser Build
3704+
</span>
3705+
</a>
3706+
3707+
</li>
3708+
3709+
<li class="md-nav__item">
3710+
<a href="#what-information-is-needed-for-help" class="md-nav__link">
3711+
<span class="md-ellipsis">
3712+
What Information is Needed for Help
3713+
</span>
3714+
</a>
3715+
3716+
</li>
3717+
36823718
<li class="md-nav__item">
36833719
<a href="#most-common-mistakes" class="md-nav__link">
36843720
<span class="md-ellipsis">
@@ -4035,11 +4071,41 @@
40354071
<h1>Errors with Browser</h1>
40364072

40374073
<h2 id="help-with-errors">Help with Errors<a class="headerlink" href="#help-with-errors" title="Anchor link to this Header on this Page">&para;</a></h2>
4038-
<p>If you get an error when building with a browser, use this page to figure out what to do.</p>
4039-
<p>If you are still unsuccessful, then post your request for help along with the link to your <abbr title="contains project files and each file's revision history">repository</abbr>. For example - this link is used to test the build instructions and generate figures for LoopDocs. You replace your <abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr> username where you see <code>loopdocs-tester</code>:</p>
4074+
<div class="admonition important">
4075+
<p class="admonition-title">Get Help, Not Frustrated</p>
4076+
<p>For first-time builders, there are a lot of one-time steps that all have to be correct and many screens look similar.</p>
4077+
<p>If you are updating your build or renewing certificates, the process can be confusing and some error messages can be misleading.</p>
4078+
<p>If you are having trouble, don't hesitate to ask for help.</p>
4079+
<p>Please do NOT:</p>
4080+
<ul>
4081+
<li>Spend hours in frustration</li>
4082+
<li>Rename or delete a <abbr title="contains project files and each file's revision history">repository</abbr></li>
4083+
<li>Delete your <abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr> account</li>
4084+
<li>Remove your App from App Store Connect</li>
4085+
</ul>
4086+
</div>
4087+
<h3 id="where-to-get-help-with-browser-build">Where to Get Help with Browser Build<a class="headerlink" href="#where-to-get-help-with-browser-build" title="Anchor link to this Header on this Page">&para;</a></h3>
4088+
<p>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:</p>
4089+
<ul>
4090+
<li><a href="https://www.facebook.com/groups/LOOPandLEARN" target="_blank">LoopandLearn Facebook Group</a></li>
4091+
<li><a href="https://loop.zulipchat.com/#narrow/channel/148543-Loop/topic/Browser.20Build" target="_blank">Zulipchat: <abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>: Build Help</a></li>
4092+
</ul>
4093+
<h3 id="what-information-is-needed-for-help">What Information is Needed for Help<a class="headerlink" href="#what-information-is-needed-for-help" title="Anchor link to this Header on this Page">&para;</a></h3>
4094+
<ol>
4095+
<li>
4096+
<p>Your <abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr> username (required):</p>
40404097
<ul>
4041-
<li><a href="https://github.com/loopdocs-tester/LoopWorkspace" target="_blank">https://<abbr title="an online service for storing repositories, accessible from a browser">github.com</abbr>/loopdocs-tester/LoopWorkspace</a></li>
4098+
<li>You can also provide a link to your <abbr title="contains project files and each file's revision history">repository</abbr> like the example, but substitute your username for <code>USERNAME</code></li>
4099+
<li>If you are building an app other than <abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>, replace LoopWorkspace with the app <abbr title="contains project files and each file's revision history">repository</abbr> name</li>
40424100
</ul>
4101+
<div class="highlight"><pre><span></span><code>https://github.com/USERNAME/LoopWorkspace
4102+
</code></pre></div>
4103+
</li>
4104+
<li>
4105+
<p>A brief summary of the step you are on and what isn't working.</p>
4106+
</li>
4107+
</ol>
4108+
<p>That's all we need to get started.</p>
40434109
<p>Mentors can go to your public&nbsp;<em><span translate="no"><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr> <abbr title="contains project files and each file's revision history">repository</abbr></span></em>, make sure your code is up to date, examine your customizations (if any), then click on the Action tab and view your log files directly.</p>
40444110
<ul>
40454111
<li>Do not copy from the log file and post the words</li>
@@ -4050,8 +4116,8 @@ <h2 id="help-with-errors">Help with Errors<a class="headerlink" href="#help-with
40504116
<p>If you've been around the <abbr title="Do it yourself, a common acronym for the open-source software community (and the maker community)">DIY</abbr> community for a while, you know the mantra about screenshots. Well, when using a browser to build, <strong>screenshots are close to useless</strong>.</p>
40514117
<p>All that is needed to assist is your link or as a bare minimum your <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> <strong>username</strong>.</p>
40524118
</div>
4053-
<p>But first - try to diagnose it yourself using this page.</p>
40544119
<h3 id="most-common-mistakes">Most Common Mistakes<a class="headerlink" href="#most-common-mistakes" title="Anchor link to this Header on this Page">&para;</a></h3>
4120+
<p>If you get an error when building with a browser, you can use this page to figure out what to do - but don't be afraid to <a href="#help-with-errors">ask for help</a>.</p>
40554121
<div class="admonition warning">
40564122
<p class="admonition-title">Just updated?</p>
40574123
<p>If you just updated to version 3.4 from version 3.2.x, you must add a new Identifier.</p>

browser/bb-overview/index.html

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3704,9 +3704,19 @@ <h2 id="install-on-phone">Install on Phone<a class="headerlink" href="#install-o
37043704
<li><a href="../phone-install/" target="_blank">Install on Phone</a></li>
37053705
</ul>
37063706
<h2 id="what-if-i-get-stuck">What if I get stuck?<a class="headerlink" href="#what-if-i-get-stuck" title="Anchor link to this Header on this Page">&para;</a></h2>
3707-
<p>Try to:</p>
3707+
<div class="admonition important">
3708+
<p class="admonition-title">How to Ask for Help</p>
3709+
<p>First time setup should take several hours, but if you are having trouble:</p>
37083710
<ul>
3709-
<li>Scroll back in the directions and see if you missed a paragraph or step</li>
3711+
<li><a href="../bb-errors/#help-with-errors" target="_blank">Click here to find help</a>.</li>
3712+
</ul>
3713+
</div>
3714+
<p>If you want to solve it yourself, try to:</p>
3715+
<ul>
3716+
<li>Scroll back in the directions and see if you missed a paragraph or step<ul>
3717+
<li>Be sure you are copying the exact <strong>names</strong> needed for each step or clicking on the <strong>link</strong> associated with a particular step - many pages look similar</li>
3718+
</ul>
3719+
</li>
37103720
<li>Compare your display with the <span>graphics in <em>LoopDocs</em></span><ul>
37113721
<li>Is something different or does yours have an error message?</li>
37123722
<li>Does the <a href="../bb-errors/" target="_blank">Error</a> message guide you to the problem and solution?</li>

browser/bb-update/index.html

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3875,10 +3875,23 @@ <h3 id="how-to-update-or-rebuild">How to Update or Rebuild<a class="headerlink"
38753875
<li><a href="https://www.youtube.com/watch?v=0ipTsiqbbrQ" target="_blank">How to Update and Rebuild <abbr title="Do it yourself, a common acronym for the open-source software community (and the maker community)">DIY</abbr> <abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> with a Web Browser</a></li>
38763876
</ul>
38773877
</div>
3878+
<div class="admonition important">
3879+
<p class="admonition-title">How to Ask for Help</p>
3880+
<p>Updating with Browser Build should be pretty fast and often automatic. Updating certificates (once a year) can sometimes be tricky.</p>
3881+
<p>If you are having trouble:</p>
3882+
<ul>
3883+
<li><a href="../bb-errors/#help-with-errors" target="_blank">Click here to find help</a>.</li>
3884+
</ul>
3885+
</div>
38783886
<h2 id="accept-agreements">Accept Agreements<a class="headerlink" href="#accept-agreements" title="Anchor link to this Header on this Page">&para;</a></h2>
38793887
<blockquote>
38803888
<p>This is Step 1 of 6 - it may not always be necessary, but please check every time.</p>
38813889
</blockquote>
3890+
<div class="admonition warning">
3891+
<p class="admonition-title">Wait After You Agree</p>
3892+
<p>It typically takes 15 minutes before your updated agreement is available so you can complete your build.</p>
3893+
<p>If your build with browser fails, wait longer. An hour wait was reported by one person.</p>
3894+
</div>
38823895
<p>Sign in to your <a href="https://developer.apple.com/account" target="_blank">Apple Developer account</a>. If there are agreements you have not accepted, you will get errors when you try to Build that indicate your <em>Apple</em> <code><abbr title="a method to securely embed personal information into your fork of LoopWorkspace to enable GitHub to have access required to build Loop">Secrets</abbr></code> are incorrect - that is very unlikely. You may also need to update your credit card information if it has changed, for example, if there is a new expiration date.</p>
38833896
<ul>
38843897
<li>For an update, you do not need to modify the <code><abbr title="One of 6 Secrets: the issuer ID is associated with your Apple Developer ID and never changes">FASTLANE_ISSUER_ID</abbr></code>, <code><abbr title="One of 6 Secrets: Key ID provided when you create an API key in App Store Connect; it is associated with the FASTLANE_KEY">FASTLANE_KEY_ID</abbr></code> or <code><abbr title="One of 6 Secrets: Really long key (several lines); it and FASTLANE_KEY_ID are generated together">FASTLANE_KEY</abbr></code></li>
@@ -3901,11 +3914,6 @@ <h2 id="accept-agreements">Accept Agreements<a class="headerlink" href="#accept-
39013914
</ul>
39023915
</li>
39033916
</ul>
3904-
<div class="admonition warning">
3905-
<p class="admonition-title">Wait After You Agree</p>
3906-
<p>It typically takes 15 minutes before your updated agreement is available so you can complete your build.</p>
3907-
<p>If your build with browser fails, wait longer. An hour wait was reported by one person.</p>
3908-
</div>
39093917
<h2 id="renew-certificate">Renew <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr><a class="headerlink" href="#renew-certificate" title="Anchor link to this Header on this Page">&para;</a></h2>
39103918
<blockquote>
39113919
<p>This is Step 2 of 6 - it is only needed once a year - you should get an email from Apple 30 days before your <code>Distribution Certificate</code> expires. (Don't worry if you did not see the email.)</p>
@@ -3921,10 +3929,13 @@ <h2 id="renew-certificate">Renew <abbr title="Apple certificate is used to sign
39213929
<p>This is only a summary - please follow the detailed steps below carefully.</p>
39223930
<ul>
39233931
<li>
3924-
<p>Delete all your <code>Distribution Certificates</code>. Apple only allows you to have 2 of these. So get rid of the old ones so you will be able to create a new one that will last a full year. (Step 1 below.)</p>
3932+
<p>Delete all your certificates that say the type is <code>Distribution</code>. Apple only allows you to have 2 of these. So get rid of the old ones so you will be able to create a new one that will last a full year. (Step 1 below.)</p>
3933+
</li>
3934+
<li>
3935+
<p>Some people have <code>Distribution Managed</code> types listed. These are cloud-managed. An internet search finds this quote: "My general approach to cloud-managed certificates is to ignore them and let Apple’s infrastructure do its thing."</p>
39253936
</li>
39263937
<li>
3927-
<p>The <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr> in question is embedded in your <code>Match-Secrets repository</code>. In order to proceed, you need to remove the old certificate from <code>Match-Secrets</code>. Later this will be automated and can be done without modifying your <code>Match-Secrets repository</code>, but for now the easiest way to do that is to just delete the <code>certs/distribution</code> folder in your current <code>Match-Secrets repository</code>.</p>
3938+
<p>The <abbr title="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr> in question is embedded in your <code>Match-Secrets repository</code>. In order to proceed, you need to remove the old certificate from <code>Match-Secrets</code>.</p>
39283939
</li>
39293940
<li>
39303941
<p>Finally, for every app that you build with this method, you need to run <code>Create Certificates</code> for that app. (Step 4 below.)</p>
@@ -3939,13 +3950,14 @@ <h3 id="manual-steps-to-renew-your-distribution-certificate">Manual Steps to Ren
39393950
<ol>
39403951
<li>Use this link to view your <a href="https://developer.apple.com/account/resources/certificates/list" target="_blank">Apple Developer Certificates</a><ul>
39413952
<li>If your screen shows no Certificates and you see a message "Getting Started with Certificates", your certificate already expired and was removed by <em>Apple</em>; so skip ahead to Step 2: Navigate to your <code>Match-Secrets</code> Repository</li>
3942-
<li>Carefully examine the <code>Type</code> column - do <strong>not</strong> delete a <code>Development Certificate</code><ul>
3943-
<li>If you do not have any rows that say <code>Distribution Certificate</code>, your certificate already expired and was removed by <em>Apple</em>; so skip ahead to Step 2</li>
3953+
<li>Carefully examine the <code>Type</code> column - do <strong>not</strong> delete a certificate with type of <code>Development</code><ul>
3954+
<li>If you do not have any rows that say the type is <code>Distribution</code>, your certificate already expired and was removed by <em>Apple</em>; so skip ahead to Step 2</li>
39443955
<li>If your certificate has an expiration date several months in the future - you can wait and renew your certificate later; skip ahead to <a href="#update-fork">Update <code>Fork</code></a></li>
39453956
</ul>
39463957
</li>
3947-
<li>Click each row that has a <code>Distribution Certificate</code> and revoke it</li>
3958+
<li>Click each row that has a type of <code>Distribution</code> and revoke it</li>
39483959
<li>You will get an email informing you the certificate was revoked</li>
3960+
<li>You can ignore rows with a type of <code>Distribution Managed</code></li>
39493961
</ul>
39503962
</li>
39513963
<li>

browser/certs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3470,9 +3470,9 @@ <h3 id="success">Success<a class="headerlink" href="#success" title="Anchor link
34703470
<h3 id="failure">Failure<a class="headerlink" href="#failure" title="Anchor link to this Header on this Page">&para;</a></h3>
34713471
<p>If this action fails, head over to the errors page. Review these links, identify and fix your error or ask for help.</p>
34723472
<ul>
3473+
<li><a href="../bb-errors/#help-with-errors" target="_blank">How to Ask for Help</a></li>
34733474
<li><a href="../bb-errors/#most-common-mistakes" target="_blank">Most Common Mistakes</a></li>
34743475
<li><a href="../bb-errors/#action-create-certificates-errors" target="_blank">Create Certificates Errors</a>.</li>
3475-
<li><a href="../bb-errors/#help-with-errors" target="_blank">How to Ask for Help</a></li>
34763476
</ul>
34773477

34783478

browser/identifiers/index.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3473,6 +3473,10 @@ <h2 id="validate-secrets">Validate <code><abbr title="a method to securely embed
34733473
</ul>
34743474
</li>
34753475
</ul>
3476+
<div class="admonition important">
3477+
<p class="admonition-title">Ask For Help Early</p>
3478+
<p>Please if you are having trouble - <a href="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3479+
</div>
34763480
<div class="admonition tip">
34773481
<p class="admonition-title">Pro Tip: Validate <abbr title="a method to securely embed personal information into your fork of LoopWorkspace to enable GitHub to have access required to build Loop">Secrets</abbr></p>
34783482
<p>The Action <code>Validate Secrets</code> is run every time you do any other action. Technically, you never have to run the action by itself - you could start with <code>Add Identifiers</code>.</p>
@@ -3525,6 +3529,10 @@ <h2 id="add-identifiers"><code>Add <abbr title="names of modules found on your A
35253529
</ul>
35263530
</li>
35273531
</ul>
3532+
<div class="admonition important">
3533+
<p class="admonition-title">Ask For Help Early</p>
3534+
<p>Please if you are having trouble - <a href="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3535+
</div>
35283536
<h2 id="next-step">Next Step<a class="headerlink" href="#next-step" title="Anchor link to this Header on this Page">&para;</a></h2>
35293537
<p>The next step is to <a href="../prepare-app/">Prepare the App</a>.</p>
35303538

browser/intro-summary/index.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3601,7 +3601,14 @@ <h2 id="summary-of-steps">Summary of Steps<a class="headerlink" href="#summary-o
36013601
</ul>
36023602
</details>
36033603
<h2 id="tips-and-tricks">Tips and Tricks<a class="headerlink" href="#tips-and-tricks" title="Anchor link to this Header on this Page">&para;</a></h2>
3604-
<p>The steps to configure for building with a browser requires a lot of focused attention. Take it in steps and take breaks as needed. Some people prefer a video. Some people prefer more detailed steps on a webpage and others only high-level steps. </p>
3604+
<p>The steps to configure for building with a browser require a lot of focused attention. Take it in steps and take breaks as needed. Some people prefer a video. Some people prefer more detailed steps on a webpage and others only high-level steps.</p>
3605+
<div class="admonition important">
3606+
<p class="admonition-title">How to Ask for Help</p>
3607+
<p>First time setup should take several hours, but if you are having trouble don't get frustrated:</p>
3608+
<ul>
3609+
<li><a href="../bb-errors/#help-with-errors" target="_blank">Click here to find help</a>.</li>
3610+
</ul>
3611+
</div>
36053612
<h3 id="the-short-version">The Short Version<a class="headerlink" href="#the-short-version" title="Anchor link to this Header on this Page">&para;</a></h3>
36063613
<p>Complete instructions are found at this link for those comfortable with using <em><abbr title="an online service for storing repositories, accessible from a browser">GitHub</abbr></em> and navigating the <em>Apple Developer</em> and <em>Apple App Connect</em> pages.</p>
36073614
<ul>

browser/prepare-app/index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3568,6 +3568,11 @@ <h2 id="prepare-the-app">Prepare the App<a class="headerlink" href="#prepare-the
35683568
<li><a href="#configure-identifiers-for-loop" target="_blank">Configure</a> them to associate the correct <abbr title="a unique identifier that Apple users for a given app, yours has your TEAMID embedded in it, group.com.TEAMID.loopkit.LoopGroup">App Group</abbr> with specific identifiers </li>
35693569
<li><a href="#create-loop-app-in-app-store-connect" target="_blank">Create</a> the <em><abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> App.</li>
35703570
</ol>
3571+
<p>Some people get confused on this page. Many of the links look similar but are actually different pages at <em>Apple</em>.</p>
3572+
<div class="admonition important">
3573+
<p class="admonition-title">Ask For Help Early</p>
3574+
<p>Please if you are having trouble - <a href="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3575+
</div>
35713576
<h2 id="configure-identifiers-for-loop">Configure <abbr title="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> for <abbr title="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr><a class="headerlink" href="#configure-identifiers-for-loop" title="Anchor link to this Header on this Page">&para;</a></h2>
35723577
<details class="tip" open="open">
35733578
<summary>Background Information (Click to open/close)</summary>

0 commit comments

Comments
 (0)