Skip to content

Comments

docs: replace redirected or missing links to bolt documentation#2367

Merged
zimeg merged 4 commits intomainfrom
zimeg-docs-tools-homepage
Dec 14, 2024
Merged

docs: replace redirected or missing links to bolt documentation#2367
zimeg merged 4 commits intomainfrom
zimeg-docs-tools-homepage

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Dec 13, 2024

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 for docs 📚

Preview

Before changes

[WARNING] Docusaurus found broken links!

Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.

Exhaustive list of all broken links found:
- Broken link on source page path = /bolt-js/reference:
   -> linking to /bolt-js/concepts/steps-from-apps
   -> linking to /bolt-js/tutorial/using-typescript
   -> linking to /bolt-js/concepts/acknowledging-events

Notes

  • Some links in Japanese translations are broken due to missing sections or pages. I was hoping to add a CI check that'd fail for broken links, but will hold off on that here 🙏

Requirements

@zimeg zimeg added docs M-T: Documentation work only semver:patch labels Dec 13, 2024
@zimeg zimeg added this to the 4.1.2 milestone Dec 13, 2024
@zimeg zimeg requested review from a team and lukegalbraithrussell December 13, 2024 21:50
@zimeg zimeg self-assigned this Dec 13, 2024
@codecov
Copy link

codecov bot commented Dec 13, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.59%. Comparing base (34b93ab) to head (607a76b).
Report is 2 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

lukegalbraithrussell
lukegalbraithrussell approved these changes Dec 13, 2024
View reviewed changes
Copy link
Contributor

@lukegalbraithrussell lukegalbraithrussell left a 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

zimeg
zimeg commented Dec 14, 2024
View reviewed changes
Copy link
Member Author

@zimeg zimeg left a 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 🚢 💨

docs/content/reference.md
| 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). |
Copy link
Member Author

@zimeg zimeg Dec 14, 2024

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!

src/App.ts
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`,
Copy link
Member Author

@zimeg zimeg Dec 14, 2024

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);
}
});

@zimeg zimeg merged commit 87b6872 into main Dec 14, 2024
@zimeg zimeg deleted the zimeg-docs-tools-homepage branch December 14, 2024 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lukegalbraithrussell lukegalbraithrussell lukegalbraithrussell approved these changes

Assignees

@zimeg zimeg

Labels

docs M-T: Documentation work only semver:patch

Projects

None yet

Milestone

4.1.2

Development

Successfully merging this pull request may close these issues.

2 participants

@zimeg @lukegalbraithrussell