Skip to content

Commit 0ff0085

Browse files
emilyliquingureckis
authored andcommitted
docs: update lab setup
1 parent ade21b7 commit 0ff0085

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

70.5 KB
Loading

docs/labconfig.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,14 @@ organization was `hartleylabnyu`):
144144

145145
![Github overview](/images/labconfig-github-overview.png)
146146

147+
By default, Github will not run Workflows on a forked repository. <SmileText/>
148+
uses Github Workflows to automatically deploy your experiment whenever changes
149+
are pushed to Github (see [deploy](/recruit/deploying) docs for full details).
150+
If you'd like to take advantage of this functionality, you'll need to enable
151+
Workflows on your new template repository. Go to the "Actions" tab for your new
152+
Github repo, and click the button to enable Workflows:
153+
![Enable workflows](/images/labconfig-enable-workflows.png)
154+
147155
Next, you should clone a local copy of this repo to your computer with the link
148156
found under the "Use this template" tab shown below:
149157

@@ -212,7 +220,7 @@ Here is an example of the rules file that works well with Smile experiments (in
212220

213221
## Setup Slack
214222

215-
When you're developing an experiment and push changed to Github, your experiment
223+
When you're developing an experiment and push changes to Github, your experiment
216224
code goes through a pre-processing step, which optimizes the speed at which the
217225
code is delievered to participants. Also, when your code builds successfully it
218226
is deployed to a unique URL (see [deploy](/recruit/deploying) docs for full
@@ -237,7 +245,7 @@ Next select "Webhook" as the type of workflow you are creating.
237245
![Slack config](/images/labconfig-slack2.png)
238246

239247
Click add variables and add the following three variables names to your workflow
240-
(`github_username`, `deployURL`, and `github_hash`):
248+
(`github_username`, `deploy_url`, and `github_hash`):
241249

242250
![Slack config](/images/labconfig-slack3.png)
243251

0 commit comments

Comments
 (0)