docs: replace redirected or missing links to sdk documentation #2125

zimeg · 2024-12-14T00:19:39Z

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

These updates are made to keep the homepages on npmjs.com up to date! On the next releases of these packages I'm hoping this changes 👀

Notes

The reference generation is causing a broken anchor link to appear! I'm hoping chore(deps-dev): bump the docusaurus group across 1 directory with 3 updates #2123 or related changes will fix this, but am avoiding adding CI checks due to this 🙏

Requirements

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.

zimeg

📝 Notes for the wonderful reviewers!

zimeg · 2024-12-14T00:21:10Z

packages/rtm-api/README.md

@@ -3,7 +3,7 @@
 The `@slack/rtm-api` package contains a simple, convenient, and configurable client for receiving events and sending simple messages to Slack's [Real Time Messaging API](https://api.slack.com/rtm). Use it in your
 app to stay connected to the Slack platform over a persistent Websocket connection.

-**Note**: RTM isn't available for modern scoped apps anymore. We recommend using the [Events API](https://slack.dev/node-slack-sdk/events-api) and [Web API](https://slack.dev/node-slack-sdk/web-api) instead. If you need to use RTM (possibly due to corporate firewall limitations), you can do so by creating a [legacy scoped app](https://api.slack.com/apps?new_classic_app=1). If you have an existing RTM app, do not update its scopes as it will be updated to a modern scoped app and stop working with RTM.
+**Note**: The RTM API isn't available for modern granular-permissions apps, and you can no longer create new legacy apps. We recommend using [Bolt for JavaScript](https://tools.slack.dev/bolt-js). If you have an existing RTM app, do not update its scopes as it will be updated to a granular-permissions app and stop working with the RTM API.


This matches the wording on tools.slack.dev itself!

https://tools.slack.dev/node-slack-sdk/rtm-api

zimeg · 2024-12-14T00:22:18Z

docs/content/packages/oauth.md

 </details>
+
 ---


Fixes possible confusion in markdown parsing - this might've been interpreted as a header called ""!

zimeg · 2024-12-14T00:23:29Z

docs/content/packages/oauth.md

@@ -170,7 +170,7 @@ app.get('/slack/oauth_redirect', (req, res) => {

 There are many situations where you may want to persist some custom data relevant to your application across the entire OAuth flow. For example, you may want to map Slack resources (like users) to your own application's resources, or verify and gate eligibility for proceeding with installing your Slack application to a workspace based on your application's requirements. To this end, this package provides a series of hooks, or callbacks, that allow your application to integrate throughout key points of the OAuth flow.

-These are all callbacks customizable via the [`CallbackOptions`](reference/oauth#callbackoptions) and [`InstallPathOptions`](reference/oauth#installpathoptions) interfaces - check their [reference documentation](reference/oauth) for more details.
+These are all callbacks customizable via the [`CallbackOptions`](/reference/oauth/interfaces/CallbackOptions) and [`InstallPathOptions`](/reference/oauth/interfaces/InstallPathOptions) interfaces - check their [reference documentation](reference/oauth) for more details.


Absolute linking off from the baseUrl here to avoid ambiguous links to these pages:
https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions

lukegalbraithrussell

godspeed!

(also this is def a good cleanup but for my own honor, i made sure the slack.dev site has rules to redirect slack.dev/any-sdk/* to tools.slack.dev/any-sdk/*! They should be redirecting)

zimeg

@lukegalbraithrussell Please know I never meant to imply these redirect weren't excellent! Just hoping to avoid extra redirects wherever posisble 📚 🔍

I found a few repetitive https://tools.slack.dev/node-slack-sdk links included just now but these were updated. I left a note on a changed needed for this that I'm not soooo confident about. This seems to break the existing link for what might be expected!

I'll hold off on merging this right now, but would love to know if that change is safe 😬

zimeg · 2024-12-14T01:39:33Z

docs/content/packages/webhook.md

-permalink: /webhook
+slug: /webhook


This changes the webhook documentation from the first to second:

https://tools.slack.dev/node-slack-sdk/packages/webhook

https://tools.slack.dev/node-slack-sdk/webhook

Which matches the path of other packages - the others don't include "packages" in the path!

oh good catch -- you are indeed correct! permalink is what the old jekyll site used, i missed it

Super interesting moves by jekyll, thanks for making this clear!! 🙏

oh yes to wrap up explanation -- permalink is ignored entirely. when there's nothing set, docusaurus defaults to the folder structure the md file is in

zimeg · 2024-12-14T01:39:55Z

docs/content/packages/webhook.md

-# Slack Incoming Webhooks
-
-[![build-ci](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml/badge.svg)](https://github.com/slackapi/node-slack-sdk/actions/workflows/ci-build.yml)
-<!-- TODO: per-flag badge https://docs.codecov.io/docs/flags#section-flag-badges-and-graphs -->
-[![codecov](https://codecov.io/gh/slackapi/node-slack-sdk/branch/main/graph/badge.svg)](https://codecov.io/gh/slackapi/node-slack-sdk)
-<!-- TODO: npm versions with scoped packages: https://github.com/rvagg/nodei.co/issues/24 -->
-


🪓 Might've been carried over from the GitHub README.md but let me know if I should revert!

zimeg · 2024-12-14T01:40:25Z

docs/content/index.md

@@ -13,10 +13,10 @@ The Node Slack SDK has corresponding packages for Slack APIs. They are small and

 | Slack API    | Use | NPM package      |
 |--------------|--------------|-------------------|
-| Web API      | Send data to or query data from Slack using any of [over 200 methods](https://api.slack.com/methods). | [`@slack/web-api`](https://tools.slack.dev/node-slack-sdk/web-api) |
-| OAuth        | Set up the authentication flow using V2 OAuth for Slack apps as well as V1 OAuth for classic Slack apps. | [`@slack/oauth`](https://tools.slack.dev/node-slack-sdk/oauth) |
-| Incoming Webhooks | Send notifications to a single channel which the user picks on installation. | [`@slack/webhook`](https://tools.slack.dev/node-slack-sdk/webhook) |


This is the link fixed by the change from permalink to slug below! 👾

lukegalbraithrussell

zimeg · 2024-12-14T02:32:23Z

@lukegalbraithrussell And with worries quelled, I think it's an alright time to merge this 🫡

codecov · 2024-12-14T05:22:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.89%. Comparing base (637fca2) to head (69f9cfc).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2125   +/-   ##
=======================================
  Coverage   91.89%   91.89%           
=======================================
  Files          38       38           
  Lines       10320    10320           
  Branches      649      649           
=======================================
  Hits         9484     9484           
  Misses        824      824           
  Partials       12       12

Flag	Coverage Δ
cli-hooks	`95.24% <ø> (ø)`
cli-test	`94.48% <ø> (ø)`
oauth	`77.39% <ø> (ø)`
socket-mode	`61.82% <ø> (ø)`
web-api	`96.88% <100.00%> (ø)`
webhook	`96.65% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

zimeg added 3 commits December 13, 2024 14:37

docs: prepend the tools subdomain to package paths

24491da

docs: replace indirect links to internal references

31049f3

chore: merge w main

5e52a45

zimeg added docs M-T: Documentation work only semver:patch labels Dec 14, 2024

zimeg requested review from lukegalbraithrussell and a team December 14, 2024 00:19

zimeg self-assigned this Dec 14, 2024

zimeg commented Dec 14, 2024

View reviewed changes

lukegalbraithrussell approved these changes Dec 14, 2024

View reviewed changes

zimeg added 2 commits December 13, 2024 17:35

docs: swap the permalink for a package slug w webhooks

cd89dea

docs: remove tags and badges from github pages

69f9cfc

zimeg commented Dec 14, 2024

View reviewed changes

zimeg requested a review from lukegalbraithrussell December 14, 2024 01:43

lukegalbraithrussell approved these changes Dec 14, 2024

View reviewed changes

zimeg merged commit 306b0aa into main Dec 14, 2024
57 checks passed

zimeg deleted the zimeg-docs-tools-homepage branch December 14, 2024 02:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: replace redirected or missing links to sdk documentation #2125

docs: replace redirected or missing links to sdk documentation #2125

zimeg commented Dec 14, 2024

zimeg left a comment

zimeg Dec 14, 2024

zimeg Dec 14, 2024

zimeg Dec 14, 2024

lukegalbraithrussell left a comment

zimeg left a comment

zimeg Dec 14, 2024

lukegalbraithrussell Dec 14, 2024

zimeg Dec 14, 2024

lukegalbraithrussell Dec 14, 2024

zimeg Dec 14, 2024

zimeg Dec 14, 2024

lukegalbraithrussell left a comment

zimeg commented Dec 14, 2024

codecov bot commented Dec 14, 2024 •

edited

Loading

		permalink: /webhook
		slug: /webhook

docs: replace redirected or missing links to sdk documentation #2125

docs: replace redirected or missing links to sdk documentation #2125

Conversation

zimeg commented Dec 14, 2024

Summary

Preview

Notes

Requirements

zimeg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukegalbraithrussell left a comment

Choose a reason for hiding this comment

zimeg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukegalbraithrussell left a comment

Choose a reason for hiding this comment

zimeg commented Dec 14, 2024

codecov bot commented Dec 14, 2024 • edited Loading

Codecov Report

codecov bot commented Dec 14, 2024 •

edited

Loading