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

Add next-gen beta documentation #1565

merged 33 commits into from
Sep 14, 2022

Conversation

stevengill
Copy link
Member

@stevengill stevengill commented Aug 25, 2022

Summary

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

Requirements (place an x in each [ ])

@stevengill stevengill added the docs M-T: Documentation work only label Aug 25, 2022
@stevengill
Copy link
Member Author

Navbar rendered

@codecov
Copy link

codecov bot commented Aug 25, 2022

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

@hello-ashleyintech hello-ashleyintech self-assigned this Aug 26, 2022
@hello-ashleyintech
Copy link
Contributor

Updated screenshot of sidebar:
Screen Shot 2022-08-29 at 5 30 37 PM

Guides under "Next generation platform" still in progress!

@Kief5555
Copy link

Kief5555 commented Sep 7, 2022

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

@Kief5555
Copy link

Kief5555 commented Sep 7, 2022

I had a hard time with that

@hello-ashleyintech
Copy link
Contributor

@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!

@hello-ashleyintech hello-ashleyintech force-pushed the update-docs branch 2 times, most recently from cd17dda to 6a5097e Compare September 9, 2022 17:43
};
```
#### 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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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
Copy link
Contributor

hello-ashleyintech commented Sep 12, 2022

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/workflows.md Outdated Show resolved Hide resolved
docs/_future/workflows.md Outdated Show resolved Hide resolved
Copy link
Contributor

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1st three sections of create a new app

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
Copy link
Contributor

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback on Run your app section

docs/_future/create_new_app.md Show resolved Hide resolved
docs/_future/create_new_app.md Outdated Show resolved Hide resolved
Copy link
Contributor

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback on Workflows section

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
Copy link
Contributor

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Triggers and Functions feedback

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
Copy link
Member Author

@stevengill stevengill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Custom function changes

docs/_future/create_new_app.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
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
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
docs/_future/custom_functions.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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
stevengill and others added 3 commits September 14, 2022 13:51
Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com>
Co-authored-by: Ashley <12901850+hello-ashleyintech@users.noreply.github.com>
docs/_future/feedback.md Outdated Show resolved Hide resolved
Copy link
Contributor

@srajiang srajiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Little nits on Triggers

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
Copy link
Contributor

@hello-ashleyintech hello-ashleyintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good to merge! 😤 💯

@hello-ashleyintech hello-ashleyintech merged commit c9e30ac into main Sep 14, 2022
@stevengill stevengill deleted the update-docs branch September 14, 2022 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants