Skip to content

Commit 066d26d

Browse files
seratchseratch
authored
Merge pull request #432 from shaydewael/update-some-documentation
Revise some documentation navigation and organization
2 parents 0be98fb + e75e53d commit 066d26d

File tree

7 files changed

+63
-55
lines changed

7 files changed

+63
-55
lines changed

‎docs/_includes/common-header.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
1515
</a>
1616
<a href="https://api.slack.com/" id="header_logo" class="api hide_on_mobile"
1717
style="float:left; display: inline-block;">
18-
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png"
19-
style="width: 225px; padding-right: 25px; border-right: 1px solid #DDD;" />
18+
<img alt="Slack API" src="https://a.slack-edge.com/3026cb/img/slack_api_logo_vogue.png" />
2019
</a>
21-
<span style="display: inline-block; padding-left: 20px; margin-top: 25px; font-weight: bold; font-size: 1.4rem;">
20+
<span style="display: inline-block; margin-top: 22px; font-weight: bold; font-size: 1.4rem;">
2221
Slack SDK for Java
2322
</span>

‎docs/_includes/sidebar-ja.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,13 @@
44
<li class="toctree-l1 current"><div class="toctree-h">Slack SDK for Java</div>
55
<ul>
66
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/">SDK の概要</a></li>
7-
</ul>
8-
</li>
9-
</ul>
10-
<ul class="current">
11-
<li class="toctree-l1 current"><div class="toctree-h">API クライアント</div>
12-
<ul>
13-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/web-api-client-setup">API クライアントのセットアップ</a></li>
14-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/web-api-basics">API クライアントの基本</a></li>
15-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/composing-messages">メッセージの組み立て方</a></li>
16-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/incoming-webhooks">Incoming Webhooks</a></li>
17-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/rtm">Real Time Messaging (RTM)</a></li>
7+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/getting-started-with-bolt">Bolt️ ことはじめ</a></li>
188
</ul>
199
</li>
2010
</ul>
2111
<ul class="current">
2212
<li class="toctree-l1 current"><div class="toctree-h">Bolt for Java</div>
2313
<ul>
24-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/getting-started-with-bolt">Bolt️ ことはじめ</a></li>
2514
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/bolt-basics">Bolt️ の概要</a></li>
2615
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/slash-commands">スラッシュコマンド</a></li>
2716
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/interactive-components">インタラクティブコンポーネント</a></li>
@@ -34,6 +23,17 @@
3423
</ul>
3524
</li>
3625
</ul>
26+
<ul class="current">
27+
<li class="toctree-l1 current"><div class="toctree-h">API クライアント</div>
28+
<ul>
29+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/web-api-client-setup">API クライアントのセットアップ</a></li>
30+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/web-api-basics">API クライアントの基本</a></li>
31+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/composing-messages">メッセージの組み立て方</a></li>
32+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/incoming-webhooks">Incoming Webhooks</a></li>
33+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/ja/rtm">Real Time Messaging (RTM)</a></li>
34+
</ul>
35+
</li>
36+
</ul>
3737
<ul class="current">
3838
<li class="toctree-l1 current"><div class="toctree-h">エンタープライズ</div>
3939
<ul>

‎docs/_includes/sidebar.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,36 @@
44
<li class="toctree-l1 current"><div class="toctree-h">Slack SDK for Java</div>
55
<ul>
66
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/">Overview</a></li>
7-
</ul>
8-
</li>
9-
</ul>
10-
<ul class="current">
11-
<li class="toctree-l1 current"><div class="toctree-h">Slack API Client</div>
12-
<ul>
13-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/web-api-client-setup">API Client Installation</a></li>
14-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/web-api-basics">API Client Basics</a></li>
15-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/composing-messages">Composing Messages</a></li>
16-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/incoming-webhooks">Incoming Webhooks</a></li>
17-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/rtm">Real Time Messaging (RTM)</a></li>
7+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt">Getting Started with Bolt</a></li>
188
</ul>
199
</li>
2010
</ul>
2111
<ul class="current">
2212
<li class="toctree-l1 current"><div class="toctree-h">Bolt for Java</div>
2313
<ul>
24-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt">Getting Started</a></li>
25-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/bolt-basics">Bolt Basics</a></li>
26-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/slash-commands">Slash Commands</a></li>
14+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/bolt-basics">Basic Concepts</a></li>
15+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/shortcuts">Shortcuts</a></li>
2716
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/interactive-components">Interactive Components</a></li>
2817
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/modals">Modals</a></li>
29-
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/shortcuts">Shortcuts</a></li>
3018
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/app-home">App Home</a></li>
19+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/slash-commands">Slash Commands</a></li>
3120
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/events-api">Events API</a></li>
3221
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/app-distribution">App Distribution (OAuth)</a></li>
3322
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/supported-web-frameworks">Supported Web Frameworks</a></li>
3423
</ul>
3524
</li>
3625
</ul>
26+
<ul class="current">
27+
<li class="toctree-l1 current"><div class="toctree-h">Slack API Client</div>
28+
<ul>
29+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/web-api-client-setup">API Client Installation</a></li>
30+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/web-api-basics">API Client Basics</a></li>
31+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/composing-messages">Composing Messages</a></li>
32+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/incoming-webhooks">Incoming Webhooks</a></li>
33+
<li class="toctree-l2"><a href="{{ site.url | append: site.baseurl }}/guides/rtm">Real Time Messaging (RTM)</a></li>
34+
</ul>
35+
</li>
36+
</ul>
3737
<ul class="current">
3838
<li class="toctree-l1 current"><div class="toctree-h">Enterprise</div>
3939
<ul>

‎docs/assets/default.css‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
a.headerlink {
2-
display: none !important;
2+
display: none !important;
33
}
44

55
.section-title {
@@ -10,6 +10,10 @@ a.headerlink {
1010
margin: 0 0 1rem;
1111
}
1212

13+
nav#api_nav {
14+
padding: 0 30px;
15+
}
16+
1317
nav#api_nav .toctree-l1 {
1418
margin-bottom: 1.5rem;
1519
}
@@ -21,13 +25,13 @@ nav#api_nav #api_sections ul {
2125
}
2226

2327
nav#api_nav #api_sections ul li.toctree-l1>.toctree-h {
24-
color: #1264a3;
28+
color: #1d1c1d;
2529
letter-spacing: 0;
26-
/* font-size: .8rem; */
30+
font-size: 1.1rem;
2731
font-weight: 800;
2832
/* text-transform: uppercase; */
2933
border: none;
30-
padding: 0;
34+
padding: 0 0 5px 2px;
3135
}
3236

3337
nav#api_nav #api_sections ul li.toctree-l2 {
@@ -41,21 +45,21 @@ nav#api_nav #api_sections ul li.toctree-l2 a {
4145
font-weight: inherit;
4246
padding: 0;
4347
display: block;
44-
text-overflow: ellipsis;
48+
word-wrap: break-word;
4549
overflow: hidden;
46-
white-space: nowrap;
4750
font-size: 15px!important;
4851
line-height:15px;
49-
padding: 4px 8px;
50-
border: 1px solid transparent;
52+
padding: 3px 8px;
5153
border-radius: 4px;
54+
border: 1px solid transparent;
55+
line-height: 1.35em;
5256
}
5357

5458
nav#api_nav #api_sections ul li.toctree-l2 a:hover {
5559
cursor: pointer;
5660
text-decoration: none;
57-
background-color:#e8f5fa;
58-
border-color:#dcf0fb;
61+
background-color:#e6eff5;
62+
border-color: #dff0fa;
5963
}
6064

6165
nav#api_nav #footer #footer_nav {

‎docs/assets/docs.css‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,16 @@ body {
44
font-size: 1.0rem;
55
}
66

7+
#header_logo img {
8+
max-height: 36px;
9+
width: auto !important;
10+
padding-right: 25px;
11+
border-right: 1px solid #DDD;
12+
margin-left: 15px;
13+
}
14+
715
#page_contents {
8-
width: 90%;
16+
width: 80%;
917
}
1018

1119
.card {

‎docs/guides/shortcuts.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ lang: en
66

77
# Shortcuts
88

9-
[Shortcuts](https://api.slack.com/interactivity/shortcuts) are an evolution of slash commands, surfaced in both the composer menu and the quick switcher. Shortcuts allow users to trigger your app's workflows from intuitive surface areas within Slack.
9+
**Shortcuts** are simple entry points for users to invoke your app. [**Global shortcuts**](https://api.slack.com/interactivity/shortcuts/using#global_shortcuts) are surfaced from everywhere in Slack, while [**message shortcuts**](https://api.slack.com/interactivity/shortcuts/using#message_shortcuts) are surfaced in the message context menu.
1010

1111
Your app has 3 seconds to call `ack()`, which acknowledges a shortcut request is received from Slack.
1212

13-
## Global / Message Shortcuts
13+
## Global and Message Shortcuts
1414

1515
### Slack App Configuration
1616

‎docs/index.md‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,34 +5,31 @@ title: "Overview"
55

66
# Slack SDK for Java
77

8-
**Slack SDK for Java** supports all public Slack platform functionality in a Java idiomatic way. The SDK is completely written in Java, so that developers can use this SDK in any JVM language, including Kotlin, Groovy, and Scala without any hurdles.
8+
**Slack SDK for Java** supports the Slack platform in a Java idiomatic way. The SDK written in Java so developers can use it in any JVM language including Kotlin, Groovy, and Scala.
99

10-
The SDK offers two different modules depending on what platform features you intend to use:
10+
Within the SDK, there are two different modules:
1111

12-
* [**Slack API Client**]({{ site.url | append: site.baseurl }}/guides/web-api-basics) for calling a variety of Slack APIs
13-
* [**Bolt for Java**]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt) Framework for Slack App development with full platform features
14-
15-
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.
12+
* [**Bolt for Java**]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), which is a framework with a simple API that makes it easy to write modern Slack apps in Java.
13+
* [**Slack API Client**]({{ site.url | append: site.baseurl }}/guides/web-api-basics), for when you need a more customized approach to building a Slack app in Java.
1614

1715
---
1816

1917
## Modules
2018

21-
The table below shows all the available modules. All of them have the same latest version as we release all at the same time, even in the case that some don't have any changes apart from updates on their dependency side.
19+
The table below shows all the available modules in the Slack Java SDK. All of them have the same latest version as we release all at the same time, even in the case that some don't have any changes apart from updates on their dependency side.
2220

2321
All released versions are available on the Maven Central repositories. The latest version is **{{ site.sdkLatestVersion }}**.
2422

2523
|groupId:artifactId|Description|
2624
|---|---|
27-
|[**com.slack.api:slack-api-model**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-api-model) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-model/{{ site.sdkLatestVersion }}/slack-api-model-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is a collection of the classes representing the [Slack core objects](https://api.slack.com/types) such as conversations, messages, users, blocks, and surfaces. As this is an essential part of the SDK, all other modules depend on this.|
28-
|[**com.slack.api:slack-api-client**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-api-client) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/{{ site.sdkLatestVersion }}/slack-api-client-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is a collection of the Slack API clients. The supported are Basic API Methods, RTM (Real Time Messaging) API, SCIM API, Audit Logs API, and Status API.|
29-
|[**com.slack.api:slack-app-backend**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-app-backend) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-app-backend/{{ site.sdkLatestVersion }}/slack-app-backend-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This module is a set of Slack app server-side handlers and data classes for Events API, Interactive Components, Slash Commands, Actions, and OAuth flow. These are used by Bolt framework as the foundation of it in primitive layers.|
30-
|[**com.slack.api:bolt**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt/{{ site.sdkLatestVersion }}/bolt-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|Bolt is a framework that offers an abstraction layer to build Slack apps with full platform features.|
31-
|[**com.slack.api:bolt-servlet**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-servlet) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-servlet/{{ site.sdkLatestVersion }}/bolt-servlet-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is an adapter for Servlet environments.|
25+
|[**com.slack.api:bolt**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt/{{ site.sdkLatestVersion }}/bolt-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|Bolt is a framework that offers an abstraction layer to build Slack apps safely and quickly. The most commonly used Servlet environment is supported out-of-the-box.|
3226
|[**com.slack.api:bolt-jetty**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-jetty) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-jetty/{{ site.sdkLatestVersion }}/bolt-jetty-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This module offers a handy way to run Bolt apps on the [Jetty HTTP server](https://www.eclipse.org/jetty/).|
3327
|[**com.slack.api:bolt-aws-lambda**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-aws-lambda) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-aws-lambda/{{ site.sdkLatestVersion }}/bolt-aws-lambda-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This module offers a handy way to run Bolt apps on AWS [API Gateway](https://aws.amazon.com/api-gateway/) + [Lambda](https://aws.amazon.com/lambda/).|
3428
|[**com.slack.api:bolt-micronaut**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-micronaut) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-micronaut/{{ site.sdkLatestVersion }}/bolt-micronaut-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is an adapter for [Micronaut](https://micronaut.io/) to run Bolt apps on top of it.|
3529
|[**com.slack.api:bolt-helidon**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:bolt-helidon) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/bolt-helidon/{{ site.sdkLatestVersion }}/bolt-helidon-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is an adapter for [Helidon SE](https://helidon.io/docs/latest/) to run Bolt apps on top of it.|
30+
|[**com.slack.api:slack-api-model**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-api-model) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-model/{{ site.sdkLatestVersion }}/slack-api-model-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is a collection of the classes representing the [Slack core objects](https://api.slack.com/types) such as conversations, messages, users, blocks, and surfaces. As this is an essential part of the SDK, all other modules depend on this.|
31+
|[**com.slack.api:slack-api-client**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-api-client) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/{{ site.sdkLatestVersion }}/slack-api-client-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This is a collection of the Slack API clients. The supported are Basic API Methods, RTM (Real Time Messaging) API, SCIM API, Audit Logs API, and Status API.|
32+
|[**com.slack.api:slack-app-backend**](https://search.maven.org/search?q=g:com.slack.api%20AND%20a:slack-app-backend) [📖](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-app-backend/{{ site.sdkLatestVersion }}/slack-app-backend-{{ site.sdkLatestVersion }}-javadoc.jar/!/index.html#package)|This module is a set of Slack app server-side handlers and data classes for Events API, Interactive Components, Slash Commands, Actions, and OAuth flow. These are used by Bolt framework as the foundation of it in primitive layers.|
3633

3734
---
3835

0 commit comments

Comments
 (0)