Skip to content

Commit dcb1201

Browse files
lukegalbraithrusselllukegalbraithrussell
committed
addings tools path
1 parent c1d7998 commit dcb1201

31 files changed

+172
-172
lines changed

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
Within the SDK, there are two different modules:
88

9-
* [**Bolt for Java**](/java-slack-sdk/guides/getting-started-with-bolt), which is a framework with a simple API that makes it easy to write modern Slack apps in Java.
10-
* [**Slack API Client**](/java-slack-sdk/guides/web-api-basics), for when you need a more customized approach to building a Slack app in Java.
9+
* [**Bolt for Java**](https://docs.slack.dev/tools/java-slack-sdk/guides/getting-started-with-bolt), which is a framework with a simple API that makes it easy to write modern Slack apps in Java.
10+
* [**Slack API Client**](https://docs.slack.dev/tools/java-slack-sdk/guides/web-api-basics), for when you need a more customized approach to building a Slack app in Java.
1111

1212
If what you want to do is call Slack APIs in your existing services, we recommend using only the **Slack API Client**. If instead, you’re developing a new modern and interactive Slack app, we recommend **Bolt** for it. The framework enables developers to focus on the essential parts of their apps without being bothered by trifles.
1313

1414
## Bolt for Java
1515

16-
**Bolt for Java** is a framework on the JVM that offers an abstraction layer to build Slack apps quickly using modern platform features. Refer to [Getting Started with Bolt](/java-slack-sdk/guides/getting-started-with-bolt) for detailed instructions.
16+
**Bolt for Java** is a framework on the JVM that offers an abstraction layer to build Slack apps quickly using modern platform features. Refer to [Getting Started with Bolt](https://docs.slack.dev/tools/java-slack-sdk/guides/getting-started-with-bolt) for detailed instructions.
1717

1818
```java
1919
package hello;
@@ -36,7 +36,7 @@ public class MyApp {
3636
}
3737
```
3838

39-
For Socket Mode enabled apps, [Getting Started with Bolt (Socket Mode)](/java-slack-sdk/guides/getting-started-with-bolt-socket-mode) is available.
39+
For Socket Mode enabled apps, [Getting Started with Bolt (Socket Mode)](https://docs.slack.dev/tools/java-slack-sdk/guides/getting-started-with-bolt-socket-mode) is available.
4040

4141
```java
4242
package hello;
@@ -61,7 +61,7 @@ public class MyApp {
6161

6262
## Slack API Client
6363

64-
**slack-api-client** contains simple, easy-to-use, and flexibly configurable HTTP clients for making requests to Slack APIs. Refer to [API Client Basics](/java-slack-sdk/guides/web-api-basics) for details.
64+
**slack-api-client** contains simple, easy-to-use, and flexibly configurable HTTP clients for making requests to Slack APIs. Refer to [API Client Basics](https://docs.slack.dev/tools/java-slack-sdk/guides/web-api-basics) for details.
6565

6666
```java
6767
import com.slack.api.Slack;

‎docs/english/_sidebar.json‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
{
33
"type": "doc",
4-
"id": "java-slack-sdk/index",
4+
"id": "tools/java-slack-sdk/index",
55
"label": "Java Slack SDK",
66
"className": "sidebar-title"
77
},
@@ -11,46 +11,46 @@
1111
"label": "Bolt for Java Guides",
1212
"collapsed": false,
1313
"items": [
14-
"java-slack-sdk/guides/getting-started-with-bolt",
15-
"java-slack-sdk/guides/bolt-basics",
16-
"java-slack-sdk/guides/supported-web-frameworks",
17-
"java-slack-sdk/guides/socket-mode",
18-
"java-slack-sdk/guides/events-api",
14+
"tools/java-slack-sdk/guides/getting-started-with-bolt",
15+
"tools/java-slack-sdk/guides/bolt-basics",
16+
"tools/java-slack-sdk/guides/supported-web-frameworks",
17+
"tools/java-slack-sdk/guides/socket-mode",
18+
"tools/java-slack-sdk/guides/events-api",
1919
{
2020
"type": "category",
2121
"label": "App UI & Interactivity",
2222
"items": [
23-
"java-slack-sdk/guides/interactive-components",
24-
"java-slack-sdk/guides/modals",
25-
"java-slack-sdk/guides/app-home"
23+
"tools/java-slack-sdk/guides/interactive-components",
24+
"tools/java-slack-sdk/guides/modals",
25+
"tools/java-slack-sdk/guides/app-home"
2626
]
2727
},
28-
"java-slack-sdk/guides/ai-apps",
29-
"java-slack-sdk/guides/custom-steps",
30-
"java-slack-sdk/guides/shortcuts",
31-
"java-slack-sdk/guides/slash-commands",
28+
"tools/java-slack-sdk/guides/ai-apps",
29+
"tools/java-slack-sdk/guides/custom-steps",
30+
"tools/java-slack-sdk/guides/shortcuts",
31+
"tools/java-slack-sdk/guides/slash-commands",
3232
{
3333
"type": "category",
3434
"label": "Authorization & Security",
3535
"items": [
36-
"java-slack-sdk/guides/app-distribution",
37-
"java-slack-sdk/guides/sign-in-with-slack"
36+
"tools/java-slack-sdk/guides/app-distribution",
37+
"tools/java-slack-sdk/guides/sign-in-with-slack"
3838
]
3939
},
4040
{
4141
"type": "category",
4242
"label": "Admin Tools",
4343
"items": [
44-
"java-slack-sdk/guides/web-api-for-admins",
45-
"java-slack-sdk/guides/scim-api",
46-
"java-slack-sdk/guides/audit-logs-api",
47-
"java-slack-sdk/guides/status-api"
44+
"tools/java-slack-sdk/guides/web-api-for-admins",
45+
"tools/java-slack-sdk/guides/scim-api",
46+
"tools/java-slack-sdk/guides/audit-logs-api",
47+
"tools/java-slack-sdk/guides/status-api"
4848
]
4949
},
5050
{
5151
"type": "category",
5252
"label": "Legacy",
53-
"items": ["java-slack-sdk/guides/steps-from-apps"]
53+
"items": ["tools/java-slack-sdk/guides/steps-from-apps"]
5454
}
5555
]
5656
},
@@ -60,98 +60,98 @@
6060
"label": "Java Slack SDK Guides",
6161
"collapsed": false,
6262
"items": [
63-
"java-slack-sdk/guides/web-api-client-setup",
64-
"java-slack-sdk/guides/web-api-basics",
65-
"java-slack-sdk/guides/composing-messages",
66-
"java-slack-sdk/guides/incoming-webhooks",
67-
"java-slack-sdk/guides/rtm"
63+
"tools/java-slack-sdk/guides/web-api-client-setup",
64+
"tools/java-slack-sdk/guides/web-api-basics",
65+
"tools/java-slack-sdk/guides/composing-messages",
66+
"tools/java-slack-sdk/guides/incoming-webhooks",
67+
"tools/java-slack-sdk/guides/rtm"
6868
]
6969
},
7070
{ "type": "html", "value": "<hr>" },
71-
"java-slack-sdk/reference",
71+
"tools/java-slack-sdk/reference",
7272
{ "type": "html", "value": "<hr>" },
7373
{
7474
"type": "category",
7575
"label": "日本語 (日本)",
7676
"link": {
7777
"type": "doc",
78-
"id": "java-slack-sdk/ja-jp/index"
78+
"id": "tools/java-slack-sdk/ja-jp/index"
7979
},
8080
"items": [
81-
"java-slack-sdk/ja-jp/index",
81+
"tools/java-slack-sdk/ja-jp/index",
8282
{
8383
"type": "category",
8484
"label": "Bolt for Java",
8585
"items": [
86-
"java-slack-sdk/ja-jp/guides/getting-started-with-bolt",
87-
"java-slack-sdk/ja-jp/guides/bolt-basics",
88-
"java-slack-sdk/ja-jp/guides/supported-web-frameworks",
89-
"java-slack-sdk/ja-jp/guides/socket-mode",
90-
"java-slack-sdk/ja-jp/guides/events-api",
86+
"tools/java-slack-sdk/ja-jp/guides/getting-started-with-bolt",
87+
"tools/java-slack-sdk/ja-jp/guides/bolt-basics",
88+
"tools/java-slack-sdk/ja-jp/guides/supported-web-frameworks",
89+
"tools/java-slack-sdk/ja-jp/guides/socket-mode",
90+
"tools/java-slack-sdk/ja-jp/guides/events-api",
9191
{
9292
"type": "category",
9393
"label": "インタラクティビティ & ショートカット",
9494
"items": [
95-
"java-slack-sdk/ja-jp/guides/interactive-components",
96-
"java-slack-sdk/ja-jp/guides/modals",
97-
"java-slack-sdk/ja-jp/guides/app-home"
95+
"tools/java-slack-sdk/ja-jp/guides/interactive-components",
96+
"tools/java-slack-sdk/ja-jp/guides/modals",
97+
"tools/java-slack-sdk/ja-jp/guides/app-home"
9898
]
9999
},
100-
"java-slack-sdk/ja-jp/guides/shortcuts",
101-
"java-slack-sdk/ja-jp/guides/slash-commands",
100+
"tools/java-slack-sdk/ja-jp/guides/shortcuts",
101+
"tools/java-slack-sdk/ja-jp/guides/slash-commands",
102102
{
103103
"type": "category",
104104
"label": "認可 & セキュリティ",
105105
"items": [
106-
"java-slack-sdk/ja-jp/guides/app-distribution",
107-
"java-slack-sdk/ja-jp/guides/sign-in-with-slack"
106+
"tools/java-slack-sdk/ja-jp/guides/app-distribution",
107+
"tools/java-slack-sdk/ja-jp/guides/sign-in-with-slack"
108108
]
109109
},
110110
{
111111
"type": "category",
112112
"label": "Admin Tools",
113113
"items": [
114-
"java-slack-sdk/ja-jp/guides/web-api-for-admins",
115-
"java-slack-sdk/ja-jp/guides/scim-api",
116-
"java-slack-sdk/ja-jp/guides/audit-logs-api",
117-
"java-slack-sdk/ja-jp/guides/status-api"
114+
"tools/java-slack-sdk/ja-jp/guides/web-api-for-admins",
115+
"tools/java-slack-sdk/ja-jp/guides/scim-api",
116+
"tools/java-slack-sdk/ja-jp/guides/audit-logs-api",
117+
"tools/java-slack-sdk/ja-jp/guides/status-api"
118118
]
119119
},
120120
{
121121
"type": "category",
122122
"label": "レガシー（非推奨）",
123-
"items": ["java-slack-sdk/ja-jp/guides/steps-from-apps"]
123+
"items": ["tools/java-slack-sdk/ja-jp/guides/steps-from-apps"]
124124
}
125125
]
126126
},
127127
{
128128
"type": "category",
129129
"label": "Slack API クライアント",
130130
"items": [
131-
"java-slack-sdk/ja-jp/guides/web-api-client-setup",
132-
"java-slack-sdk/ja-jp/guides/web-api-basics",
133-
"java-slack-sdk/ja-jp/guides/composing-messages",
134-
"java-slack-sdk/ja-jp/guides/incoming-webhooks",
135-
"java-slack-sdk/ja-jp/guides/rtm"
131+
"tools/java-slack-sdk/ja-jp/guides/web-api-client-setup",
132+
"tools/java-slack-sdk/ja-jp/guides/web-api-basics",
133+
"tools/java-slack-sdk/ja-jp/guides/composing-messages",
134+
"tools/java-slack-sdk/ja-jp/guides/incoming-webhooks",
135+
"tools/java-slack-sdk/ja-jp/guides/rtm"
136136
]
137137
},
138-
"java-slack-sdk/ja-jp/reference"
138+
"tools/java-slack-sdk/ja-jp/reference"
139139
]
140140
},
141141
{ "type": "html", "value": "<hr>" },
142142
{
143143
"type": "link",
144144
"label": "Release notes",
145-
"href": "https://github.com/SlackAPI/java-slack-sdk/releases"
145+
"href": "https://github.com/SlackAPI/tools/java-slack-sdk/releases"
146146
},
147147
{
148148
"type": "link",
149149
"label": "Code on GitHub",
150-
"href": "https://github.com/SlackAPI/java-slack-sdk"
150+
"href": "https://github.com/SlackAPI/tools/java-slack-sdk"
151151
},
152152
{
153153
"type": "link",
154154
"label": "Contributors Guide",
155-
"href": "https://github.com/slackapi/java-slack-sdk/blob/main/.github/contributing.md"
155+
"href": "https://github.com/slackapi/tools/java-slack-sdk/blob/main/.github/contributing.md"
156156
}
157157
]

‎docs/english/guides/ai-apps.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The Agents & AI Apps feature comprises a unique messaging experience for Slack.
2727

2828
## The `Assistant` class instance {#assistant-class}
2929

30-
The [`Assistant`](/java-slack-sdk/reference#the-assistantconfig-configuration-object) class can be used to handle the incoming events expected from a user interacting with an app in Slack that has the Agents & AI Apps feature enabled. A typical flow would look like:
30+
The [`Assistant`](/tools/java-slack-sdk/reference#the-assistantconfig-configuration-object) class can be used to handle the incoming events expected from a user interacting with an app in Slack that has the Agents & AI Apps feature enabled. A typical flow would look like:
3131

3232
1. [The user starts a thread](#handling-a-new-thread). The `Assistant` class handles the incoming [`assistant_thread_started`](/reference/events/assistant_thread_started) event.
3333
2. [The thread context may change at any point](#handling-thread-context-changes). The `Assistant` class can handle any incoming [`assistant_thread_context_changed`](/reference/events/assistant_thread_context_changed) events. The class also provides a default `context` store to keep track of thread context changes as the user moves through Slack.
@@ -76,7 +76,7 @@ While the `assistant_thread_started` and `assistant_thread_context_changed` even
7676
If you do provide your own `threadContextService` property, it must feature `get` and `save` methods.
7777

7878
:::tip[Tip]
79-
Be sure to give the [reference docs](/java-slack-sdk/reference#agents--assistants) a look!
79+
Be sure to give the [reference docs](/tools/java-slack-sdk/reference#agents--assistants) a look!
8080
:::
8181

8282
## Handling a new thread {#handling-a-new-thread}

‎docs/english/guides/app-home.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Most commonly, [`app_home_opened`](/reference/events/app_home_opened) events wou
3434

3535
:::tip[Tip]
3636

37-
If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt](/java-slack-sdk/guides/getting-started-with-bolt), first.
37+
If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt](/tools/java-slack-sdk/guides/getting-started-with-bolt), first.
3838

3939
:::
4040

@@ -78,7 +78,7 @@ app.event(AppHomeOpenedEvent.class, (payload, ctx) -> {
7878
});
7979
```
8080

81-
It looks like this in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/java-slack-sdk/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful.)
81+
It looks like this in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/tools/java-slack-sdk/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful.)
8282

8383
```kotlin
8484
// static imports
@@ -110,7 +110,7 @@ app.event(AppHomeOpenedEvent::class.java) { event, ctx ->
110110
}
111111
```
112112

113-
You can also build the view in the above example with the [Block Kit Kotlin DSL](/java-slack-sdk/guides/composing-messages#block-kit-kotlin-dsl) like so:
113+
You can also build the view in the above example with the [Block Kit Kotlin DSL](/tools/java-slack-sdk/guides/composing-messages#block-kit-kotlin-dsl) like so:
114114

115115
```kotlin
116116
// These imports are necessary for this code
@@ -132,4 +132,4 @@ val appHomeView = view { it
132132

133133
## Under the hood
134134

135-
Refer to [the Events API guide](/java-slack-sdk/guides/events-api).
135+
Refer to [the Events API guide](/tools/java-slack-sdk/guides/events-api).

‎docs/english/guides/bolt-basics.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,32 +32,32 @@ Here is the list of the available methods to dispatch events.
3232
|Method|Constraints (value: type)|Description|
3333
|-|-|-|
3434
|`app.attachmentAction`|callback_id: `String` \| `Pattern`|Legacy Messaging: Responds to user actions in attachments. These events can be triggered in only messages.|
35-
|`app.blockAction`|action_id: `String` \| `Pattern`|[Interactive Components](/java-slack-sdk/guides/interactive-components): Responds to user actions (e.g., click a button, choose an item from select menus, radio buttons, etc.) in `blocks`. These events can be triggered in all the surfaces (messages, modals, and Home tabs).|
36-
|`app.blockSuggestion`|action_id: `String` \| `Pattern`|[Interactive Components](/java-slack-sdk/guides/interactive-components): Responds to user actions to input a keyword (the length needs to be the `min_query_length` or longer) in select menus (external data source).|
37-
|`app.command`|command name: `String` \| `Pattern`|[Slash Commands](/java-slack-sdk/guides/slash-commands): Responds to slash command invocations in the workspace.|
35+
|`app.blockAction`|action_id: `String` \| `Pattern`|[Interactive Components](/tools/java-slack-sdk/guides/interactive-components): Responds to user actions (e.g., click a button, choose an item from select menus, radio buttons, etc.) in `blocks`. These events can be triggered in all the surfaces (messages, modals, and Home tabs).|
36+
|`app.blockSuggestion`|action_id: `String` \| `Pattern`|[Interactive Components](/tools/java-slack-sdk/guides/interactive-components): Responds to user actions to input a keyword (the length needs to be the `min_query_length` or longer) in select menus (external data source).|
37+
|`app.command`|command name: `String` \| `Pattern`|[Slash Commands](/tools/java-slack-sdk/guides/slash-commands): Responds to slash command invocations in the workspace.|
3838
|`app.dialogCancellation`|callback_id `String` \| `Pattern`|Dialogs: Responds to the events where users close dialogs by clicking Cancel buttons.|
3939
|`app.dialogSubmission`|callback_id: `String` \| `Pattern`|Dialogs: Responds to data submissions in dialogs.|
4040
|`app.dialogSuggestion`|callback_id: `String` \| `Pattern`|Dialogs: Responds to requests to load options for `"external"` typed select menus in dialogs.|
41-
|`app.event`|event type: `Class\<Event\>`|[Events API](/java-slack-sdk/guides/events-api): Responds to any of bot/user events you subscribe to.|
42-
| `app.function` | callback_id: `String` \| `Pattern` | [Custom steps](/java-slack-sdk/guides/custom-steps): Defines a function that can be used as a custom step in [Workflow Builder](https://slack.com/help/articles/360035692513-Guide-to-Slack-Workflow-Builder).
43-
|`app.globalShortcut`|callback_id: `String` \| `Pattern`|[Shortcuts](/java-slack-sdk/guides/shortcuts): Responds to global shortcut invocations.|
44-
|`app.message`|keyword: `String` \| `Pattern`|[Events API](/java-slack-sdk/guides/events-api): Responds to messages posted by a user only when the text in messages matches the given keyword or regular expressions.|
45-
|`app.messageShortcut`|callback_id: `String` \| `Pattern`|[Shortcuts](/java-slack-sdk/guides/shortcuts): Responds to shortcut invocations in message menus.|
46-
|`app.viewClosed`|callback_id: `String` \| `Pattern`|[Modals](/java-slack-sdk/guides/modals): Responds to the events where users close modals by clicking Cancel buttons. The `notify_on_close` has to be `true` when opening/pushing the modal.|
47-
|`app.viewSubmission`|callback_id: `String` \| `Pattern`|[Modals](/java-slack-sdk/guides/modals): Responds to data submissions in modals.|
41+
|`app.event`|event type: `Class\<Event\>`|[Events API](/tools/java-slack-sdk/guides/events-api): Responds to any of bot/user events you subscribe to.|
42+
| `app.function` | callback_id: `String` \| `Pattern` | [Custom steps](/tools/java-slack-sdk/guides/custom-steps): Defines a function that can be used as a custom step in [Workflow Builder](https://slack.com/help/articles/360035692513-Guide-to-Slack-Workflow-Builder).
43+
|`app.globalShortcut`|callback_id: `String` \| `Pattern`|[Shortcuts](/tools/java-slack-sdk/guides/shortcuts): Responds to global shortcut invocations.|
44+
|`app.message`|keyword: `String` \| `Pattern`|[Events API](/tools/java-slack-sdk/guides/events-api): Responds to messages posted by a user only when the text in messages matches the given keyword or regular expressions.|
45+
|`app.messageShortcut`|callback_id: `String` \| `Pattern`|[Shortcuts](/tools/java-slack-sdk/guides/shortcuts): Responds to shortcut invocations in message menus.|
46+
|`app.viewClosed`|callback_id: `String` \| `Pattern`|[Modals](/tools/java-slack-sdk/guides/modals): Responds to the events where users close modals by clicking Cancel buttons. The `notify_on_close` has to be `true` when opening/pushing the modal.|
47+
|`app.viewSubmission`|callback_id: `String` \| `Pattern`|[Modals](/tools/java-slack-sdk/guides/modals): Responds to data submissions in modals.|
4848

4949
---
5050
## Development guides by feature
5151

5252
On these guide pages, you'll find example code for each.
5353

54-
* [Slash Commands](/java-slack-sdk/guides/slash-commands)
55-
* [Interactive Components](/java-slack-sdk/guides/interactive-components)
56-
* [Modals](/java-slack-sdk/guides/modals)
57-
* [Shortcuts](/java-slack-sdk/guides/shortcuts)
58-
* [App Home](/java-slack-sdk/guides/app-home)
59-
* [Events API](/java-slack-sdk/guides/events-api)
60-
* [App Distribution (OAuth Flow)](/java-slack-sdk/guides/app-distribution)
54+
* [Slash Commands](/tools/java-slack-sdk/guides/slash-commands)
55+
* [Interactive Components](/tools/java-slack-sdk/guides/interactive-components)
56+
* [Modals](/tools/java-slack-sdk/guides/modals)
57+
* [Shortcuts](/tools/java-slack-sdk/guides/shortcuts)
58+
* [App Home](/tools/java-slack-sdk/guides/app-home)
59+
* [Events API](/tools/java-slack-sdk/guides/events-api)
60+
* [App Distribution (OAuth Flow)](/tools/java-slack-sdk/guides/app-distribution)
6161

6262
---
6363
## Acknowledge incoming requests
@@ -322,7 +322,7 @@ Make sure it's safe enough when you turn a built-in middleware off. **We strongl
322322
---
323323
## Supported web frameworks
324324

325-
Refer to the [supported web frameworks page](/java-slack-sdk/guides/supported-web-frameworks) for more details.
325+
Refer to the [supported web frameworks page](/tools/java-slack-sdk/guides/supported-web-frameworks) for more details.
326326

327327
---
328328
## Deployments

‎docs/english/guides/composing-messages.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ lang: en
44

55
# Composing Messages
66

7-
This section shows how to build Slack messages using the `slack-api-client` library. If you're not familiar with the [`chat.postMessage`](/reference/methods/chat.postMessage) API method yet, read [the Web API basics page](/java-slack-sdk/guides/web-api-basics) before trying the samples here.
7+
This section shows how to build Slack messages using the `slack-api-client` library. If you're not familiar with the [`chat.postMessage`](/reference/methods/chat.postMessage) API method yet, read [the Web API basics page](/tools/java-slack-sdk/guides/web-api-basics) before trying the samples here.
88

99
Before jumping into Java code, we recommend developing an understanding of composing Slack messages. [Read the API documentation](/messaging/) for more information.
1010

0 commit comments

Comments
 (0)