Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 1444c4d

Browse files
committed
Several clarifications to the docs:
(1) let the unitiated know that they need to clone the git repository before any other steps. (For example, requirements.txt is needed, but is unavailable until after the clone; (2) give a heads up that the Add Events process described in Section 3 may not work until after Events are enabled in Section 5; (3) typo in Section 5. I left the reference to the "interwebs" as it made me smile, but it may confuse those who are unfamiliar with Mr. Bush.
1 parent 75f481d commit 1444c4d

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ PythOnBoarding Bot is designed to greet new users on your team and introduce the
88
99
Let's go write some code. You got this! :sparkles:
1010

11+
The first thing you'll need to do is make a local copy of this git repository. If you are familiar with `git` you can use:
12+
13+
`git clone https://github.com/slackapi/Slack-Python-Onboarding-Tutorial.git`
14+
15+
Otherwise you can [download](https://github.com/slackapi/Slack-Python-Onboarding-Tutorial/archive/master.zip) and `unzip` the project.
16+
1117
#### Technical Requirements
1218

1319
This example uses [Python](https://www.python.org/downloads/), specifically version 2.7 so you'll need to make sure you are using the correct version of Python. We'll also use a number of python packages you can install through [pip.](https://pip.pypa.io/en/stable/installing/)

docs/Section-3.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ This project uses the following events:
1818

1919
After you've subscribed to all the events your app will need, make sure to **Save Changes**.
2020

21+
*Note*: If the **Save Changes** button is not enabled, you may have to return to this step after you **Enable Events** as described in [Section 5: Make it Go](./../docs/Section-5.md).
22+
2123
![save_changes](https://cloud.githubusercontent.com/assets/4828352/20575405/fca754dc-b16d-11e6-880d-5eb8dd5d5196.png)
2224

2325
---

docs/Section-5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ python app.py
1010

1111
![start_appy](https://cloud.githubusercontent.com/assets/4828352/20549064/cad48f8c-b0dd-11e6-8a85-25bff2815d2e.png)
1212

13-
Since Slack will need to talk to your app through teh interwebs, let's expose our app to the world wide web through an [Ngrok](https://ngrok.com/) tunnel. In a terminal window, open up an ngrok tunnel for the port your Flask app will be served on locally. (The default port for Flask is 5000)
13+
Since Slack will need to talk to your app through the interwebs, let's expose our app to the world wide web through an [Ngrok](https://ngrok.com/) tunnel. In a terminal window, open up an ngrok tunnel for the port your Flask app will be served on locally. (The default port for Flask is 5000)
1414

1515
```bash
1616
ngrok http 5000

0 commit comments

Comments
 (0)