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
This PR addresses issue #27 with the following improvements to the
README.md:
1. Added clarification that Bedrock Claude Sonnet 3.7 model needs to be
enabled in both us-east-1 and us-west-2 regions
2. Added 'proceed to next step' instructions at the end of each numbered
step to improve user flow
3. Added guidance on when to use Personal Access Token vs GitHub App for
GitHub integration
4. Enhanced overall readability with clearer instructions throughout the
setup process
Fixes#27
Co-authored-by: remote-swe-app[bot] <123456+remote-swe-app[bot]@users.noreply.github.com>
Copy file name to clipboardExpand all lines: README.md
+19-3
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Please carefully follow all the steps below. If you encounter any issues, we're
25
25
- npm (version 9 or higher)
26
26
- AWS CLI
27
27
- AWS IAM profile with appropriate permissions
28
-
- Bedrock Claude Sonnet 3.7 model is [enabled on](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html#getting-started-model-access)US region
28
+
- Bedrock Claude Sonnet 3.7 model is [enabled on](https://docs.aws.amazon.com/bedrock/latest/userguide/getting-started.html#getting-started-model-access)both us-east-1 and us-west-2 regions
After completing this step, proceed to Step 2 to set up the required parameters and deploy the CDK stack.
40
+
39
41
### 2. Run CDK Deploy
40
42
41
43
Before running cdk deploy, you need to create placeholder SSM parameters that will later be populated with actual values:
@@ -65,7 +67,9 @@ npx cdk bootstrap
65
67
npx cdk deploy
66
68
```
67
69
68
-
Deployment usually takes about 5 minutes. After the deployment, you should see the endpoint of your Slack Bolt app. Please continue to the next step.
70
+
Deployment usually takes about 5 minutes. After the deployment, you should see the endpoint of your Slack Bolt app. Make note of the `SlackBoltEndpointUrl` from the CDK output as you'll need it in the next step.
71
+
72
+
After completing this step, proceed to Step 3 to set up your Slack application.
69
73
70
74
### 3. Slack App Setup
71
75
@@ -109,11 +113,17 @@ aws ssm put-parameter \
109
113
110
114
Replace `your-slack-bot-token` and `your-slack-signing-secret` with the actual values you obtained in the previous step. The parameters will be referenced from CDK.
111
115
116
+
After completing this step, proceed to Step 4 to set up GitHub integration. You will need to choose between using a Personal Access Token (PAT) or GitHub App for authentication.
117
+
112
118
113
119
### 4. GitHub Integration
114
120
115
121
To interact with GitHub, you need to setup GitHub integration. You have two options for GitHub integration:
116
122
123
+
**Which option should you choose?**
124
+
-**Personal Access Token (Option 1)**: Choose this for personal use or quick setup. It's simpler but tied to a single user account.
125
+
-**GitHub App (Option 2)**: Recommended for team environments or organizational use. Provides more granular permissions and isn't tied to a personal account.
126
+
117
127
#### Option 1: Personal Access Token (PAT)
118
128
119
129
1. Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens)
@@ -150,6 +160,8 @@ To interact with GitHub, you need to setup GitHub integration. You have two opti
150
160
> [!NOTE]
151
161
> Currently when using with GitHub App, you can only use repositories under a single organization (i.e. app installation).
152
162
163
+
After completing this step, proceed to Step 5 to set up environment variables based on your chosen GitHub integration method.
164
+
153
165
### 5. Environment Variables Setup
154
166
155
167
The following environment variables are required for deployment:
@@ -181,6 +193,8 @@ All users except those with specified user IDs will receive an Unauthorized erro
181
193
> [!NOTE]
182
194
> To grant a user access to the app, mention the app with an `approve_user` message followed by mentions of the users, e.g., `@remote-swe approve_user @Alice @Bob @Carol`
183
195
196
+
After completing this step, proceed to Step 6 to finalize the deployment with your configuration.
197
+
184
198
### 6. Deploy CDK again with configuration variables
185
199
186
200
After the above setup is complete, run `cdk deploy` again.
@@ -190,7 +204,9 @@ cd cdk
190
204
npx cdk deploy
191
205
```
192
206
193
-
You can now access all features from Slack. Simply mention the Slack app and start assigning tasks to the agents!
207
+
Congratulations! Setup is now complete. You can now access all features from Slack. Simply mention the Slack app and start assigning tasks to the agents!
208
+
209
+
For tips on how to effectively use the agents, refer to the "Useful Tips" section below.
0 commit comments