Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add next-gen beta documentation #1565

Merged
merged 33 commits into from
Sep 14, 2022
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2e83d2a
Initial pass at adding beta labels and scaffolding for run on slack docs
hello-ashleyintech Aug 25, 2022
5048d07
Add in formatting and label updates
hello-ashleyintech Aug 25, 2022
56d9aae
Small update
hello-ashleyintech Aug 25, 2022
43a1deb
Update run on slack terminology and update section heading
hello-ashleyintech Aug 29, 2022
f077a6d
Update deployment page
hello-ashleyintech Aug 29, 2022
9783e78
Update file name for deploy page
hello-ashleyintech Aug 29, 2022
48344cd
Update sidebar title
hello-ashleyintech Aug 31, 2022
fe2ee9a
Add in more scaffolding for docs
hello-ashleyintech Sep 7, 2022
38a6fd2
Add in new pages and have a (nearly done) create new app page
hello-ashleyintech Sep 9, 2022
710fef1
Add in new updates - full create app guide, custom functions, assets
hello-ashleyintech Sep 12, 2022
df1b707
Add in more updates and JS-ify things
hello-ashleyintech Sep 13, 2022
f8ee225
add in more JS specific clarification
hello-ashleyintech Sep 13, 2022
6429de3
Touch up content
hello-ashleyintech Sep 13, 2022
f3ce60d
Add migration docs
srajiang Sep 13, 2022
03c63d8
More migrate docs changes
srajiang Sep 13, 2022
9112623
Add in updates based on PR feedback
hello-ashleyintech Sep 14, 2022
5e467fa
Update feedback link and add in CTA for feedback
hello-ashleyintech Sep 14, 2022
e57091e
remove extra spacing
hello-ashleyintech Sep 14, 2022
f59fa75
Make feedback into a tooltip
hello-ashleyintech Sep 14, 2022
4e8a91d
Push up final updates and placeholder for deploy guide
hello-ashleyintech Sep 14, 2022
486bb2d
Additional triggers and workflows updates
hello-ashleyintech Sep 14, 2022
f417beb
Push up additional updates to workflow page
hello-ashleyintech Sep 14, 2022
2563d2b
Formatting fixes
hello-ashleyintech Sep 14, 2022
090c97e
Typo fix
hello-ashleyintech Sep 14, 2022
ff30f8a
Typo fixes and update pluralizations
hello-ashleyintech Sep 14, 2022
90a5d6c
Updated custom function doc
stevengill Sep 14, 2022
8ef485a
Update docs/_future/create_new_app.md
stevengill Sep 14, 2022
c47630a
Update docs/_future/custom_functions.md
stevengill Sep 14, 2022
826754b
Apply suggestions from code review
stevengill Sep 14, 2022
48e1303
Add in updates to triggers and workflows
hello-ashleyintech Sep 14, 2022
d4a06cf
Push up initial create new app feedback and update feedback page naming
hello-ashleyintech Sep 14, 2022
0219965
Add missing headers for conclusion
hello-ashleyintech Sep 14, 2022
c3064ea
Add in updates for Triggers
hello-ashleyintech Sep 14, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove extra spacing
hello-ashleyintech committed Sep 14, 2022
commit e57091e9f4daa5b2b2512a9e7715ff1024cf3596
1 change: 0 additions & 1 deletion docs/_future/app_manifests.md
Original file line number Diff line number Diff line change
@@ -22,7 +22,6 @@ Inside the manifest file, you will find an `module.exports = Manifest({})` block

```javascript
// manifest/manifest.js

const { Manifest } = require('@slack/bolt');
const { TimeOffWorkflow } = require('./workflow/approval');

5 changes: 0 additions & 5 deletions docs/_future/create_new_app.md
Original file line number Diff line number Diff line change
@@ -187,7 +187,6 @@ Once the function step is executed, that will be the end of the workflow! All re
The final workflow file will look like this:
```js
// /manifest/workflow/time-off-request.js

const { DefineWorkflow, Schema } = require('@slack/bolt');
// this function will live in manifest/function/approval.js
const { ApprovalFunction } = require('../function/approval');
@@ -289,7 +288,6 @@ In the Request Time Off application, we use one custom function, `ApprovalFuncti
Our `ApprovalFunction` is defined in `manifest/function/approval.js`. Custom functions are defined using `DefineFunction`.
```js
// manifest/function/approval.js

const { DefineFunction, Schema } = require('@slack/bolt');

const ApprovalFunction = DefineFunction({
@@ -450,7 +448,6 @@ We have two different handlers, one for each potential action—an Approval
The Approval Action looks like this:
```js
// listeners/functions/actions/approve-action.js

const approveActionHandler = async ({ ack, client, body, complete }) => {
const { manager, employee, start_date, end_date } = body.function_data.inputs;
const { channel_id, message_ts } = body.container;
@@ -658,7 +655,6 @@ To open or update a modal from a Slack Function [interactivity handler](https://
To get started with creating a modal, add a new [Action](#action) that will be triggered when the "Open Modal" button is selected. Create a new file in `listeners/functions/actions` called `open-modal-action.js`:
```js
// listeners/functions/actions/open-modal-action.js

const openModalActionHandler = async ({ ack, client, body, complete }) => {
ack();
const { manager } = body.function_data.inputs;
@@ -728,7 +724,6 @@ Now that the "Open Modal" button's action handler has been added in to the `requ
Inside `listeners/functions`, create a new directory called `views` and within it, add a new file called `modal-submit.js`:
```js
// listeners/functions/views/modal-submit.js

const openModalSubmissionHandler = async ({ ack, body, complete }) => {
ack();
const { manager, employee } = body.function_data.inputs;
2 changes: 0 additions & 2 deletions docs/_future/custom_functions.md
Original file line number Diff line number Diff line change
@@ -193,7 +193,6 @@ const helloWorldFunc = new SlackFunction(SampleFunctionDefinition.id, helloWorld
Once this file has been created, the function handler can be registered in an `index.js` file within the `listeners/functions` directory:
```js
// listeners/functions/index.js

const { helloWorldFunc } = require('./hello-world');

// Register a complete function
@@ -206,7 +205,6 @@ module.exports.register = (app) => {
In order to make sure this handler is triggered, make sure the Function listeners are registered in your `listeners/index.js` file:
stevengill marked this conversation as resolved.
Show resolved Hide resolved
```js
// listeners/index.js

const functions = require('./functions');

module.exports.registerListeners = (app) => {
1 change: 0 additions & 1 deletion docs/_future/workflows.md
Original file line number Diff line number Diff line change
@@ -218,7 +218,6 @@ module.exports = { SayHelloWorkflow };
Below in the Manifest, the `SayHelloWorkflow` is imported and passed in:
```javascript
// manifest/manifest.js

// Import DefineWorkflow:
const { Schema } = require('@slack/bolt');
const { SayHelloWorkflow } = require('./workflows/say-hello');