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.

Sign up for GitHub

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

Jump to bottom

Add in Hello World example across docs #1608

Merged
merged 3 commits into from Oct 3, 2022
Merged

Add in Hello World example across docs #1608

merged 3 commits into from Oct 3, 2022

Conversation

hello-ashleyintech
Copy link
Contributor

Summary

Standardizing examples across functions, triggers, and workflows pages to focus on the Hello World example so it is more coherent. Also adding some smaller updates / fixes for consistency.

Requirements (place an x in each [ ])

@hello-ashleyintech hello-ashleyintech added the docs M-T: Documentation work only label Sep 27, 2022
@hello-ashleyintech hello-ashleyintech self-assigned this Sep 27, 2022
@hello-ashleyintech
Copy link
Contributor Author

It was also mentioned in some feedback to potentially add another page related to Interactivity, would love to get thoughts on this and whether this is something that should be prioritized closer to GA or now!

@codecov
Copy link

codecov bot commented Sep 27, 2022 •
edited

Codecov Report

Merging #1608 (d51f86a) into main (682574b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1608   +/-   ##
=======================================
  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

@jsoref jsoref mentioned this pull request Sep 29, 2022
Merged
2 tasks
srajiang
srajiang reviewed Oct 3, 2022
View reviewed changes
docs/_future/app_manifests.md
features: {
appHome: {
homeTabEnabled: true,
messagesTabEnabled: true,
messagesTabEnabled: false,
Copy link
Member

Choose a reason for hiding this comment

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

Interesting... can you have messagesTabEnabled false but readOnlyEnabled as true?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ahh, yes it seems so! this is the current configuration for our manifest in the future branch of the starter template!

srajiang
srajiang reviewed Oct 3, 2022
View reviewed changes
docs/_future/custom_functions.md Outdated
@@ -116,19 +122,16 @@ To do this, create a file in `listeners/functions` directory for your function l
const { SlackFunction } = require('@slack/bolt');

// Get our Function Definition from the manifest!
const { SampleFunctionDefinition } = require('../../manifest/functions/sample-function');
const { SampleFunctionDefinition } = require('../../manifest/function/sample-function');
Copy link
Member

Choose a reason for hiding this comment

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

ooh did we decide for this to go back to singular?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i don't think so! I copied this directly from the most recent copy of future - let me check and see if the PR for pluralizing was merged and if not, I'll pluralize it and make the relevant updates!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

update - merged that PR in to pluralize the sample and updated this back to functions!

srajiang
srajiang reviewed Oct 3, 2022
View reviewed changes
docs/_future/getting_started_future.md Outdated
@@ -130,13 +130,13 @@ Once the app is successfully run, you'll see output in your Terminal to indicate

With your app running, access your workspace and paste the URL from the Trigger you created in the previous step into a message in a public channel.

> 💡 To make the trigger URL more widely accessible, we recommend saving the Trigger as a channel bookmark for easy access.
> 💡 The Trigger will automatically be saved as a channel bookmark under "Workflows" for easy access.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> 💡 The Trigger will automatically be saved as a channel bookmark under "Workflows" for easy access.
> 💡 App Triggers are automatically be saved as a channel bookmark under "Workflows" for easy access.

srajiang
srajiang reviewed Oct 3, 2022
View reviewed changes
docs/_future/request_time_off_tutorial.md Outdated
@@ -96,7 +96,7 @@ Once the app is successfully run, you'll see output in your Terminal to indicate

With your app running, access your workspace and paste the URL from the Trigger you created in the previous step into a message in a public channel.

> 💡 To make the trigger URL more widely accessible, we recommend saving the Trigger as a channel bookmark for easy access.
> 💡 The Trigger will automatically be saved as a channel bookmark under "Workflows" for easy access.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> 💡 The Trigger will automatically be saved as a channel bookmark under "Workflows" for easy access.
> 💡 App Triggers will automatically be saved as a channel bookmark under "Workflows" for easy access.

srajiang
srajiang reviewed Oct 3, 2022
View reviewed changes
docs/_future/triggers.md Outdated
@@ -39,6 +39,8 @@ Triggers created with the CLI are designed using Trigger Files. The Trigger File

The specifics of the Trigger File's structure will depend on what [type of Trigger](#types) you want to use.

The Hello World app from the Bolt for JavaScript starter template uses a Link Trigger, which is one of the [Trigger types](#types). You can view its Trigger File [here](https://github.com/slack-samples/bolt-js-starter-template/blob/future/triggers/hello-world-trigger.json).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The Hello World app from the Bolt for JavaScript starter template uses a Link Trigger, which is one of the [Trigger types](#types). You can view its Trigger File [here](https://github.com/slack-samples/bolt-js-starter-template/blob/future/triggers/hello-world-trigger.json).
The Hello World app from the Bolt for JavaScript starter template uses a Link Trigger, which is one of several [Trigger types](#types). You can view its Trigger File [here](https://github.com/slack-samples/bolt-js-starter-template/blob/future/triggers/hello-world-trigger.json).

srajiang
srajiang approved these changes Oct 3, 2022
View reviewed changes
Copy link
Member

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

Minor suggestions for tweaks here and there!

@hello-ashleyintech hello-ashleyintech merged commit 31a2dae into slackapi:main Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srajiang srajiang srajiang approved these changes

@stevengill stevengill Awaiting requested review from stevengill

Assignees

@hello-ashleyintech hello-ashleyintech

Labels
docs M-T: Documentation work only
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@hello-ashleyintech @srajiang