Skip to content

Commit 4c00909

Browse files
migrate custom steps tutorials
1 parent 4d6e3f7 commit 4c00909

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+934
-21
lines changed

docs/content/tutorial/ai-chatbot.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,19 +100,19 @@ Navigate to the Bolty **App Home** and select a provider from the drop-down menu
100100

101101
If you don't see Bolty listed under **Apps** in your workspace right away, never fear! You can mention **@Bolty** in a public channel to add the app, then navigate to your **App Home**.
102102

103-
![Choose your AI provider](/img/ai-chatbot/6.png)
103+
![Choose your AI provider](/img/tutorials/ai-chatbot/6.png)
104104

105105
## Setting up your workflow {#workflow}
106106

107107
Within your development workspace, open Workflow Builder by clicking on your workspace name and then **Tools > Workflow Builder**. Select **New Workflow** > **Build Workflow**.
108108

109109
Click **Untitled Workflow** at the top to rename your workflow. For this tutorial, we'll call the workflow **Welcome to the channel**. Enter a description, such as _Summarizes channels for new members_, and click **Save**.
110110

111-
![Setting up a new workflow](/img/ai-chatbot/1.png)
111+
![Setting up a new workflow](/img/tutorials/ai-chatbot/1.png)
112112

113113
Select **Choose an event** under **Start the workflow...**, and then choose **When a person joins a channel**. Select the channel name from the drop-down menu and click **Save**.
114114

115-
![Start the workflow](/img/ai-chatbot/2.png)
115+
![Start the workflow](/img/tutorials/ai-chatbot/2.png)
116116

117117
Under **Then, do these things**, click **Add steps** and complete the following:
118118

@@ -121,20 +121,20 @@ Under **Then, do these things**, click **Add steps** and complete the following:
121121
3. Under **Add a message**, enter a short message, such as _Hi! Welcome to `{}The channel that the user joined`. Would you like a summary of the recent conversation?_ Note that the _`{}The channel that the user joined`_ is a variable; you can insert it by selecting **{}Insert a variable** at the bottom of the message text box.
122122
4. Select the **Add Button** button, and name the button _Yes, give me a summary_. Click **Done**.
123123

124-
![Send a message](/img/ai-chatbot/3.png)
124+
![Send a message](/img/tutorials/ai-chatbot/3.png)
125125

126126
We'll add two more steps under the **Then, do these things** section.
127127

128128
First, scroll to the bottom of the list of steps and choose **Custom**, then choose **Bolty** and **Bolty Custom Function**. In the **Channel** drop-down menu, select **Channel that the user joined**. Click **Save**.
129129

130-
![Bolty custom function](/img/ai-chatbot/4.png)
130+
![Bolty custom function](/img/tutorials/ai-chatbot/4.png)
131131

132132
For the final step, complete the following:
133133

134134
1. Choose **Messages** and then **Send a message to a person**. Under **Select a member**, choose **Person who clicked the button** from the drop-down menu.
135135
2. Under **Add a message**, click **Insert a variable** and choose **`{}Summary`** under the **Bolty Custom Function** section in the list that appears. Click **Save**.
136136

137-
![Summary](/img/ai-chatbot/5.png)
137+
![Summary](/img/tutorials/ai-chatbot/5.png)
138138

139139
When finished, click **Finish Up**, then click **Publish** to make the workflow available in your workspace.
140140

@@ -149,7 +149,7 @@ In order for Bolty to provide summaries of recent conversation in a channel, Bol
149149

150150
To test this, leave the channel you just invited Bolty to and rejoin it. This will kick off your workflow and you'll receive a direct message from **Welcome to the channel**. Click the **Yes, give me a summary** button, and Bolty will summarize the recent conversations in the channel you joined.
151151

152-
![Channel summary](/img/ai-chatbot/7.png)
152+
![Channel summary](/img/tutorials/ai-chatbot/7.png)
153153

154154
The central part of this functionality is shown in the following code snippet. Note the use of the [`user_context`](https://api.slack.com/automation/types#usercontext) object, a Slack type that represents the user who is interacting with our workflow, as well as the `history` of the channel that will be summarized, which includes the ten most recent messages.
155155

@@ -191,7 +191,7 @@ To ask Bolty a question, you can chat with Bolty in any channel the app is in. U
191191

192192
You can also navigate to **Bolty** in your **Apps** list and select the **Messages** tab to chat with Bolty directly.
193193

194-
![Ask Bolty](/img/ai-chatbot/8.png)
194+
![Ask Bolty](/img/tutorials/ai-chatbot/8.png)
195195

196196
## Next steps {#next-steps}
197197

docs/content/tutorial/custom-steps-for-jira.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -127,21 +127,21 @@ If your app is up and running, you'll see a message noting that the app is start
127127
2. Select **New Workflow** > **Build Workflow**.
128128
3. Click **Untitled Workflow** at the top of the pane to rename your workflow. We'll call it **Create Issue**. For the description, enter _Creates a new issue_, then click **Save**.
129129

130-
![Workflow details](/img/custom-steps-jira/1.png)
130+
![Workflow details](/img/tutorials/custom-steps-jira/1.png)
131131

132132
4. Select **Choose an event** under **Start the workflow...**, and then select **From a link in Slack**. Click **Continue**.
133133

134-
![Start the workflow](/img/custom-steps-jira/2.png)
134+
![Start the workflow](/img/tutorials/custom-steps-jira/2.png)
135135

136136
5. Under **Then, do these things** click **Add steps** to add the custom step. Your custom step will be the function defined in the [`create_issue.py`](https://github.com/slack-samples/bolt-python-jira-functions/blob/main/listeners/functions/create_issue.py) file.
137137

138138
Scroll down to the bottom of the list on the right-hand pane and select **Custom**, then **BoltPy Jira Functions** > **Create an issue**. Enter the project details, issue type (optional), summary (optional), and description (optional). Click **Save**.
139139

140-
![Custom function](/img/custom-steps-jira/3.png)
140+
![Custom function](/img/tutorials/custom-steps-jira/3.png)
141141

142142
6. Add another step and select **Messages** > **Send a message to a channel**. Select **Channel where the workflow was used** from the drop-down list and then select **Insert a variable** and **Issue url**. Click **Save**.
143143

144-
![Insert variable for issue URL](/img/custom-steps-jira/4.png)
144+
![Insert variable for issue URL](/img/tutorials/custom-steps-jira/4.png)
145145

146146
7. Click **Publish** to make the workflow available to your workspace.
147147

@@ -150,16 +150,16 @@ If your app is up and running, you'll see a message noting that the app is start
150150
1. Copy your workflow link.
151151
2. Navigate to your app's home tab and click **Connect an Account** to connect your JIRA account to the app.
152152

153-
![Connect account](/img/custom-steps-jira/5.png)
153+
![Connect account](/img/tutorials/custom-steps-jira/5.png)
154154

155155
3. Click **Allow** on the screen that appears.
156156

157-
![Allow connection](/img/custom-steps-jira/6.png)
157+
![Allow connection](/img/tutorials/custom-steps-jira/6.png)
158158

159159
4. In any channel, post the workflow link you copied.
160160
5. Click **Start Workflow** and observe as the link to a new JIRA ticket is posted in the channel. Click the link to be directed to the newly-created issue within your JIRA project.
161161

162-
![JIRA issue](/img/custom-steps-jira/7.png)
162+
![JIRA issue](/img/tutorials/custom-steps-jira/7.png)
163163

164164
When finished, you can click the **Disconnect Account** button in the home tab to disconnect your app from your JIRA account.
165165

0 commit comments

Comments
 (0)