Add next-gen beta documentation by stevengill · Pull Request #1565 · slackapi/bolt-js

stevengill · 2022-08-25T21:54:45Z

Summary

Adds initial documentation for the next-generation Slack Platform beta features supported in Bolt for Javascript.

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

stevengill · 2022-08-25T21:55:34Z

codecov · 2022-08-25T21:58:28Z

Codecov Report

Merging #1565 (c3064ea) into main (6178645) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1565   +/-   ##
=======================================
  Coverage   82.01%   82.01%           
=======================================
  Files          18       18           
  Lines        1496     1496           
  Branches      436      436           
=======================================
  Hits         1227     1227           
  Misses        172      172           
  Partials       97       97

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

docs/_includes/sidebar.html

hello-ashleyintech · 2022-08-29T21:31:07Z

Updated screenshot of sidebar:

Guides under "Next generation platform" still in progress!

Kief5555 · 2022-09-07T02:48:15Z

Perhaps add a search bar to the top left so people can find what they are looking for

Kief5555 · 2022-09-07T02:48:22Z

I had a hard time with that

hello-ashleyintech · 2022-09-07T21:00:50Z

@Kief5555 Thank you for the feedback! 🙌 this PR will likely only cover adding in new documentation, but your suggestion would be a great docs enhancement to submit as an issue!

docs/_future/getting_started_future.md

hello-ashleyintech · 2022-09-12T22:01:45Z

docs/_future/custom_functions.md

+};
+```
+#### 4. Add function to app through workflow or manifest
+To actually call the defined function, `SampleFunctionDefinition`, don't forget to add your function to a workflow! When you're finished defining and implementing your functions, the next step is to add them to [Workflows](/bolt-js/future/workflows). Once added as a step in a Workflow, your Function will run when that Workflow is invoked by a [Trigger](/bolt-js/future/triggers).


@srajiang I omitted the distribution of functions since it required deployment - let me know if you feel that we should add it back in based on what we decide to include in the deploy guide! (cc: @E-Zim)

hello-ashleyintech · 2022-09-12T22:07:12Z

Small status update on these docs -
Still in progress:

Migration guide (@srajiang is working on instructions for this) (✅ this was added in as of 9/14/22)
Deploy guide (@E-Zim will take this on)

Ready for review / feedback / comments / questions:
Everything else! (I will also be doing another review of everything tomorrow)

docs/_future/migrate_existing_app.md

docs/_future/workflows.md

docs/_future/custom_functions.md

srajiang

1st three sections of create a new app

docs/_future/create_new_app.md

srajiang

Feedback on Run your app section

docs/_future/create_new_app.md

srajiang

Feedback on Workflows section

docs/_future/create_new_app.md

srajiang

Triggers and Functions feedback

docs/_future/create_new_app.md

stevengill

Custom function changes

docs/_future/create_new_app.md

docs/_future/custom_functions.md

hello-ashleyintech

A few suggestions on the custom function updates - let me know if you have any questions @stevengill!

docs/_future/custom_functions.md

Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com>

docs/_future/custom_functions.md

docs/_future/feedback.md

srajiang

Little nits on Triggers

docs/_future/triggers.md

hello-ashleyintech

Looking good to merge! 😤 💯

stevengill added the docs M-T: Documentation work only label Aug 25, 2022

stevengill commented Aug 25, 2022

View reviewed changes

docs/_includes/sidebar.html Outdated Show resolved Hide resolved

hello-ashleyintech self-assigned this Aug 26, 2022

hello-ashleyintech requested a review from srajiang August 29, 2022 21:31

hello-ashleyintech force-pushed the update-docs branch from 29f6dd2 to 5506f1e Compare September 7, 2022 21:00

hello-ashleyintech force-pushed the update-docs branch 2 times, most recently from cd17dda to 6a5097e Compare September 9, 2022 17:43

hello-ashleyintech added 9 commits September 9, 2022 18:04

Initial pass at adding beta labels and scaffolding for run on slack docs

2e83d2a

Add in formatting and label updates

5048d07

Small update

56d9aae

Update run on slack terminology and update section heading

43a1deb

Update deployment page

f077a6d

Update file name for deploy page

9783e78

Update sidebar title

48344cd

Add in more scaffolding for docs

fe2ee9a

Add in new pages and have a (nearly done) create new app page

38a6fd2

hello-ashleyintech force-pushed the update-docs branch from 48ec001 to 38a6fd2 Compare September 9, 2022 22:04

Add in new updates - full create app guide, custom functions, assets

710fef1

hello-ashleyintech reviewed Sep 12, 2022

View reviewed changes

docs/_future/getting_started_future.md Outdated Show resolved Hide resolved

hello-ashleyintech reviewed Sep 12, 2022

View reviewed changes

hello-ashleyintech added 3 commits September 12, 2022 20:13

Add in more updates and JS-ify things

df1b707

add in more JS specific clarification

f8ee225

Touch up content

6429de3

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/migrate_existing_app.md Outdated Show resolved Hide resolved

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/workflows.md Outdated Show resolved Hide resolved

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/workflows.md Outdated Show resolved Hide resolved

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/custom_functions.md Outdated Show resolved Hide resolved

Typo fixes and update pluralizations

ff30f8a

srajiang suggested changes Sep 14, 2022

View reviewed changes

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

srajiang suggested changes Sep 14, 2022

View reviewed changes

docs/_future/create_new_app.md Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

srajiang suggested changes Sep 14, 2022

View reviewed changes

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

srajiang suggested changes Sep 14, 2022

View reviewed changes

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

docs/_future/create_new_app.md Outdated Show resolved Hide resolved

stevengill commented Sep 14, 2022

View reviewed changes

stevengill added 2 commits September 14, 2022 13:33

Updated custom function doc

90a5d6c

Update docs/_future/create_new_app.md

8ef485a

hello-ashleyintech requested changes Sep 14, 2022

View reviewed changes

docs/_future/custom_functions.md Outdated Show resolved Hide resolved

docs/_future/custom_functions.md Outdated Show resolved Hide resolved

docs/_future/custom_functions.md Outdated Show resolved Hide resolved

hello-ashleyintech reviewed Sep 14, 2022

View reviewed changes

docs/_future/custom_functions.md Outdated Show resolved Hide resolved

stevengill and others added 3 commits September 14, 2022 13:51

Update docs/_future/custom_functions.md

c47630a

Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com>

Apply suggestions from code review

826754b

Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com>

Add in updates to triggers and workflows

48e1303

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/custom_functions.md Show resolved Hide resolved

srajiang reviewed Sep 14, 2022

View reviewed changes

docs/_future/feedback.md Outdated Show resolved Hide resolved

hello-ashleyintech added 2 commits September 14, 2022 17:17

Push up initial create new app feedback and update feedback page naming

d4a06cf

Add missing headers for conclusion

0219965

srajiang suggested changes Sep 14, 2022

View reviewed changes

docs/_future/triggers.md Outdated Show resolved Hide resolved

docs/_future/triggers.md Outdated Show resolved Hide resolved

docs/_future/triggers.md Outdated Show resolved Hide resolved

Add in updates for Triggers

c3064ea

hello-ashleyintech approved these changes Sep 14, 2022

View reviewed changes

hello-ashleyintech requested a review from srajiang September 14, 2022 22:08

srajiang approved these changes Sep 14, 2022

View reviewed changes

hello-ashleyintech merged commit c9e30ac into main Sep 14, 2022

stevengill deleted the update-docs branch September 14, 2022 22:34

renovate bot mentioned this pull request Mar 28, 2025

Update dependencies-non-major-updates napple-team/bubbu#145

Merged

1 task

Conversation

stevengill commented Aug 25, 2022 • edited by srajiang Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Requirements (place an x in each [ ])

Uh oh!

stevengill commented Aug 25, 2022

Uh oh!

codecov bot commented Aug 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

hello-ashleyintech commented Aug 29, 2022

Uh oh!

Kief5555 commented Sep 7, 2022

Uh oh!

Kief5555 commented Sep 7, 2022

Uh oh!

hello-ashleyintech commented Sep 7, 2022

Uh oh!

Uh oh!

hello-ashleyintech Sep 12, 2022

Choose a reason for hiding this comment

Uh oh!

hello-ashleyintech commented Sep 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srajiang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srajiang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

srajiang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srajiang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevengill left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hello-ashleyintech left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srajiang left a comment

stevengill commented Aug 25, 2022 •

edited by srajiang

Loading

Requirements (place an `x` in each `[ ]`)

codecov bot commented Aug 25, 2022 •

edited

Loading

hello-ashleyintech commented Sep 12, 2022 •

edited

Loading