-
Notifications
You must be signed in to change notification settings - Fork 401
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
docs: replace redirected or missing links to bolt documentation #2367
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2367 +/- ##
=======================================
Coverage 92.59% 92.59%
=======================================
Files 36 36
Lines 7472 7472
Branches 653 653
=======================================
Hits 6919 6919
Misses 545 545
Partials 8 8 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we bless edengod on this day
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lukegalbraithrussell Blessed be the reviewer too!
I found a few more complete links to https://tools.slack.dev/bolt-js/...
within docs, which were replaced with the absolute alternative in 607a76b. Otherwise, I am thinking it's merge time 🚢 💨
@@ -41,9 +41,9 @@ Listener functions have access to a set of arguments that may change based on th | |||
|
|||
| Argument | Listener | Description | | |||
| :--- | :--- | :--- | | |||
| `payload` | All listeners | The unwrapped contents of the incoming event, which varies based on event. This is a subset of the information included in `body` which is detailed below. `payload` is also accessible via the alias corresponding to the method name that the listener is passed to (`message`, `event`, `action`, `shortcut`, `view`, `command`, `options`) **An easy way to understand what's in a payload is to log it**, or [use TypeScript](/tutorial/using-typescript). | | |||
| `payload` | All listeners | The unwrapped contents of the incoming event, which varies based on event. This is a subset of the information included in `body` which is detailed below. `payload` is also accessible via the alias corresponding to the method name that the listener is passed to (`message`, `event`, `action`, `shortcut`, `view`, `command`, `options`) **An easy way to understand what's in a payload is to log it**, or [use TypeScript](https://github.com/slackapi/bolt-js/tree/main/examples/getting-started-typescript). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page was removed in 52687bf but I believe the included example is alright for getting started here!
@@ -1301,7 +1301,7 @@ export default class App<AppCustomContext extends StringIndexed = StringIndexed> | |||
|
|||
if (authorize === undefined && !usingOauth) { | |||
throw new AppInitializationError( | |||
`${tokenUsage} \n\nSince you have not provided a token or authorize, you might be missing one or more required oauth installer options. See https://slack.dev/bolt-js/concepts/authenticating-oauth for these required fields.\n`, | |||
`${tokenUsage} \n\nSince you have not provided a token or authorize, you might be missing one or more required oauth installer options. See https://tools.slack.dev/bolt-js/concepts/authenticating-oauth/ for these required fields.\n`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love to see tests that are checking for this error code!
bolt-js/test/unit/App/basic.spec.ts
Lines 111 to 119 in 34b93ab
it('should fail without a token for single team authorization, authorize callback, nor oauth installer', async () => { | |
const MockApp = await importApp(); | |
try { | |
new MockApp({ signingSecret: '' }); | |
assert.fail(); | |
} catch (error) { | |
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError); | |
} | |
}); |
Summary
This PR replaces redirected or unexpected links related to
tools.slack.dev
✨Some of these were found with searches for "https://slack.dev" and some were found in outputs from
npm run build
fordocs
📚Preview
Before changes
Notes
Requirements