Skip to content

Commit

Permalink
beta warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
lukegalbraithrussell committed Jun 26, 2024
1 parent 00cbedb commit b3faab3
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 12 deletions.
2 changes: 2 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ t:
deployments: Deployments
contribute: Contributing
deprecated: Deprecated
beta: Beta
ja-jp:
basic: 基本的な概念
advanced: 応用コンセプト
Expand All @@ -55,6 +56,7 @@ t:
reference: リファレンス
contribute: 貢献
deprecated: 非推奨
beta: Beta

# Metadata
repo_name: bolt-js
Expand Down
4 changes: 2 additions & 2 deletions docs/_functions/listening.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ order: 3

When your custom function is executed as a step in a workflow, your app will receive a `function_executed` event. The callback provided to the `function()` method will be run when this event is received.

The callback is where you can access `inputs`, make third-party API calls, save information to a database, update the user’s Home tab, or set the output values that will be available to subsequent workflow steps by mapping values to the `outputs` object.
The callback is where you can access `inputs`, make third-party API calls, or set the output values that will be available to subsequent workflow steps by mapping values to the `outputs` object.

Your app must call `complete()` to indicate that the function’s execution was successful, or `fail()` to signal that the function failed to complete.
Your app can call `complete()` to indicate that the function’s execution was successful, or `fail()` to signal that the function failed to complete.

To learn more about listening to custom function executions, see the [Slack API documentation](https://api.slack.com/automation/functions/custom-bolt#listener).

Expand Down
9 changes: 6 additions & 3 deletions docs/_includes/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,11 @@

<ul class="sidebar-section">
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/concepts#functions"
><li class="title">{{ site.t[page.lang].functions }}</li></a
>
><li class="title">{{ site.t[page.lang].functions }}
<span class="label-warning">
{{ site.t[page.lang].beta }}
</span>
</li></a>
{% assign functions_sections = site.functions | sort: "order" | where: "lang", page.lang %} {% for section in functions_sections
%}
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/concepts#{{ section.slug }}">
Expand All @@ -80,7 +83,7 @@
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/concepts#steps">
<li class="title">
{{ site.t[page.lang].steps }}
<span class="label-deprecated">
<span class="label-warning">
{{ site.t[page.lang].deprecated }}
</span>
</li>
Expand Down
10 changes: 6 additions & 4 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ <h3 id="{{section.slug}}">{{ section.title }}</h3>
{% assign functions_sections = site.functions | sort: "order" | where: "lang", page.lang %} {% for section in
functions_sections %}
<div class="section-wrapper">
<h3 id="{{section.slug}}">{{ section.title }}</h3>

<h3 id="{{section.slug}}">{{ section.title }}
<span class="label-warning">
{{ site.t[page.lang].beta }}
</span>
</h3>
{{ section.content | markdownify }}

<hr />
</div>
{% endfor %}
Expand All @@ -63,7 +65,7 @@ <h3 id="{{section.slug}}">{{ section.title }}</h3>
<div class="section-wrapper">
<h3 id="{{section.slug}}">
{{ section.title }}
<span class="label-deprecated">
<span class="label-warning">
{{ site.t[page.lang].deprecated }}
</span>
</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/_steps/workflow_steps_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 1

<div class="section-content">

**⚠️ Workflow Steps from Apps are a deprecated feature.dd**
**⚠️ Workflow Steps from Apps are a deprecated feature.**

**Workflow Steps from Apps are different than, and not interchangable with, Slack automation workflows. We encourage those who are currently publishing Workflow Steps from Apps to consider the new [Slack automation features](https://api.slack.com/automation), such as [custom functions for Bolt](#functions).**

Expand Down
4 changes: 2 additions & 2 deletions docs/assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ body {
font-weight: 600;
}

.panel .sidebar-content ul.sidebar-section .label-deprecated {
.panel .sidebar-content ul.sidebar-section .label-warning {
line-height: 1em;
vertical-align: middle;
color: var(--white);
Expand Down Expand Up @@ -234,7 +234,7 @@ body {
padding-bottom: 1em;
}

.label-deprecated {
.label-warning {
line-height: 1em;
vertical-align: middle;
color: var(--white);
Expand Down

0 comments on commit b3faab3

Please sign in to comment.