You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<h2id="help-with-errors">Help with Errors<aclass="headerlink" href="#help-with-errors" title="Anchor link to this Header on this Page">¶</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 <abbrtitle="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 <abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr> username where you see <code>loopdocs-tester</code>:</p>
4074
+
<divclass="admonition important">
4075
+
<pclass="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 <abbrtitle="contains project files and each file's revision history">repository</abbr></li>
4083
+
<li>Delete your <abbrtitle="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
+
<h3id="where-to-get-help-with-browser-build">Where to Get Help with Browser Build<aclass="headerlink" href="#where-to-get-help-with-browser-build" title="Anchor link to this Header on this Page">¶</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>
<li><ahref="https://loop.zulipchat.com/#narrow/channel/148543-Loop/topic/Browser.20Build" target="_blank">Zulipchat: <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>: Build Help</a></li>
4092
+
</ul>
4093
+
<h3id="what-information-is-needed-for-help">What Information is Needed for Help<aclass="headerlink" href="#what-information-is-needed-for-help" title="Anchor link to this Header on this Page">¶</a></h3>
4094
+
<ol>
4095
+
<li>
4096
+
<p>Your <abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr> username (required):</p>
4040
4097
<ul>
4041
-
<li><ahref="https://github.com/loopdocs-tester/LoopWorkspace" target="_blank">https://<abbrtitle="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 <abbrtitle="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 <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr>, replace LoopWorkspace with the app <abbrtitle="contains project files and each file's revision history">repository</abbr> name</li>
<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>
4043
4109
<p>Mentors can go to your public <em><spantranslate="no"><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr><abbrtitle="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>
4044
4110
<ul>
4045
4111
<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
4050
4116
<p>If you've been around the <abbrtitle="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>
4051
4117
<p>All that is needed to assist is your link or as a bare minimum your <em><abbrtitle="an online service for storing repositories, accessible from a browser">GitHub</abbr></em><strong>username</strong>.</p>
4052
4118
</div>
4053
-
<p>But first - try to diagnose it yourself using this page.</p>
4054
4119
<h3id="most-common-mistakes">Most Common Mistakes<aclass="headerlink" href="#most-common-mistakes" title="Anchor link to this Header on this Page">¶</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 <ahref="#help-with-errors">ask for help</a>.</p>
4055
4121
<divclass="admonition warning">
4056
4122
<pclass="admonition-title">Just updated?</p>
4057
4123
<p>If you just updated to version 3.4 from version 3.2.x, you must add a new Identifier.</p>
Copy file name to clipboardExpand all lines: browser/bb-overview/index.html
+12-2Lines changed: 12 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -3704,9 +3704,19 @@ <h2 id="install-on-phone">Install on Phone<a class="headerlink" href="#install-o
3704
3704
<li><ahref="../phone-install/" target="_blank">Install on Phone</a></li>
3705
3705
</ul>
3706
3706
<h2id="what-if-i-get-stuck">What if I get stuck?<aclass="headerlink" href="#what-if-i-get-stuck" title="Anchor link to this Header on this Page">¶</a></h2>
3707
-
<p>Try to:</p>
3707
+
<divclass="admonition important">
3708
+
<pclass="admonition-title">How to Ask for Help</p>
3709
+
<p>First time setup should take several hours, but if you are having trouble:</p>
3708
3710
<ul>
3709
-
<li>Scroll back in the directions and see if you missed a paragraph or step</li>
3711
+
<li><ahref="../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>
3710
3720
<li>Compare your display with the <span>graphics in <em>LoopDocs</em></span><ul>
3711
3721
<li>Is something different or does yours have an error message?</li>
3712
3722
<li>Does the <ahref="../bb-errors/" target="_blank">Error</a> message guide you to the problem and solution?</li>
Copy file name to clipboardExpand all lines: browser/bb-update/index.html
+22-10Lines changed: 22 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -3875,10 +3875,23 @@ <h3 id="how-to-update-or-rebuild">How to Update or Rebuild<a class="headerlink"
3875
3875
<li><ahref="https://www.youtube.com/watch?v=0ipTsiqbbrQ" target="_blank">How to Update and Rebuild <abbrtitle="Do it yourself, a common acronym for the open-source software community (and the maker community)">DIY</abbr><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr> with a Web Browser</a></li>
3876
3876
</ul>
3877
3877
</div>
3878
+
<divclass="admonition important">
3879
+
<pclass="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><ahref="../bb-errors/#help-with-errors" target="_blank">Click here to find help</a>.</li>
3884
+
</ul>
3885
+
</div>
3878
3886
<h2id="accept-agreements">Accept Agreements<aclass="headerlink" href="#accept-agreements" title="Anchor link to this Header on this Page">¶</a></h2>
3879
3887
<blockquote>
3880
3888
<p>This is Step 1 of 6 - it may not always be necessary, but please check every time.</p>
3881
3889
</blockquote>
3890
+
<divclass="admonition warning">
3891
+
<pclass="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>
3882
3895
<p>Sign in to your <ahref="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><abbrtitle="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>
3883
3896
<ul>
3884
3897
<li>For an update, you do not need to modify the <code><abbrtitle="One of 6 Secrets: the issuer ID is associated with your Apple Developer ID and never changes">FASTLANE_ISSUER_ID</abbr></code>, <code><abbrtitle="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><abbrtitle="One of 6 Secrets: Really long key (several lines); it and FASTLANE_KEY_ID are generated together">FASTLANE_KEY</abbr></code></li>
<pclass="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>
3909
3917
<h2id="renew-certificate">Renew <abbrtitle="Apple certificate is used to sign your iOS or Mac apps - tied to but different from your permanent Developer ID">Certificate</abbr><aclass="headerlink" href="#renew-certificate" title="Anchor link to this Header on this Page">¶</a></h2>
3910
3918
<blockquote>
3911
3919
<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
3921
3929
<p>This is only a summary - please follow the detailed steps below carefully.</p>
3922
3930
<ul>
3923
3931
<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>
3925
3936
</li>
3926
3937
<li>
3927
-
<p>The <abbrtitle="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 <abbrtitle="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>
3928
3939
</li>
3929
3940
<li>
3930
3941
<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
3939
3950
<ol>
3940
3951
<li>Use this link to view your <ahref="https://developer.apple.com/account/resources/certificates/list" target="_blank">Apple Developer Certificates</a><ul>
3941
3952
<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>
3944
3955
<li>If your certificate has an expiration date several months in the future - you can wait and renew your certificate later; skip ahead to <ahref="#update-fork">Update <code>Fork</code></a></li>
3945
3956
</ul>
3946
3957
</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>
3948
3959
<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>
<p>Please if you are having trouble - <ahref="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3479
+
</div>
3476
3480
<divclass="admonition tip">
3477
3481
<pclass="admonition-title">Pro Tip: Validate <abbrtitle="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>
3478
3482
<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
3525
3529
</ul>
3526
3530
</li>
3527
3531
</ul>
3532
+
<divclass="admonition important">
3533
+
<pclass="admonition-title">Ask For Help Early</p>
3534
+
<p>Please if you are having trouble - <ahref="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3535
+
</div>
3528
3536
<h2id="next-step">Next Step<aclass="headerlink" href="#next-step" title="Anchor link to this Header on this Page">¶</a></h2>
3529
3537
<p>The next step is to <ahref="../prepare-app/">Prepare the App</a>.</p>
Copy file name to clipboardExpand all lines: browser/intro-summary/index.html
+8-1Lines changed: 8 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3601,7 +3601,14 @@ <h2 id="summary-of-steps">Summary of Steps<a class="headerlink" href="#summary-o
3601
3601
</ul>
3602
3602
</details>
3603
3603
<h2id="tips-and-tricks">Tips and Tricks<aclass="headerlink" href="#tips-and-tricks" title="Anchor link to this Header on this Page">¶</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
+
<divclass="admonition important">
3606
+
<pclass="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><ahref="../bb-errors/#help-with-errors" target="_blank">Click here to find help</a>.</li>
3610
+
</ul>
3611
+
</div>
3605
3612
<h3id="the-short-version">The Short Version<aclass="headerlink" href="#the-short-version" title="Anchor link to this Header on this Page">¶</a></h3>
3606
3613
<p>Complete instructions are found at this link for those comfortable with using <em><abbrtitle="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>
Copy file name to clipboardExpand all lines: browser/prepare-app/index.html
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -3568,6 +3568,11 @@ <h2 id="prepare-the-app">Prepare the App<a class="headerlink" href="#prepare-the
3568
3568
<li><ahref="#configure-identifiers-for-loop" target="_blank">Configure</a> them to associate the correct <abbrtitle="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>
3569
3569
<li><ahref="#create-loop-app-in-app-store-connect" target="_blank">Create</a> the <em><abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr></em> App.</li>
3570
3570
</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
+
<divclass="admonition important">
3573
+
<pclass="admonition-title">Ask For Help Early</p>
3574
+
<p>Please if you are having trouble - <ahref="../bb-errors/#help-with-errors" target="_blank">ask for help early by clicking on this link</a>.</p>
3575
+
</div>
3571
3576
<h2id="configure-identifiers-for-loop">Configure <abbrtitle="names of modules found on your Apple Developer Identifiers page that are required for GitHub build method">Identifiers</abbr> for <abbrtitle="With a capital L, Loop is one of several do-it-yourself artifical pancreas systems">Loop</abbr><aclass="headerlink" href="#configure-identifiers-for-loop" title="Anchor link to this Header on this Page">¶</a></h2>
3572
3577
<detailsclass="tip" open="open">
3573
3578
<summary>Background Information (Click to open/close)</summary>
0 commit comments