Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/MAINTAINERS_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ You may need to update your `$PATH` environment variable with `$GOPATH/bin`:
```bash
$ vim ~/.zshrc
```

2. Add the following:

```bash
Expand Down Expand Up @@ -875,7 +875,7 @@ Steps to merge a pull request:
When in doubt, find the other maintainers and ask.

[circleci]: ../.circleci/config.yml
[commands]: https://tools.slack.dev/slack-cli/reference/commands/slack
[commands]: https://docs.slack.dev/tools/slack-cli/reference/commands/slack/
[commit]: https://www.conventionalcommits.org/en/v1.0.0/
[contributing]: ./CONTRIBUTING.md
[dev-release]: https://github.com/slackapi/slack-cli/releases/tag/dev-build
Expand Down
6 changes: 3 additions & 3 deletions .github/cli-sdk-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Some hooks may return data as part of their functionality. The CLI will use the

### ↪️ Discover hook scripts and default configuration with `get-hooks`

In order for the CLI to reliably discover the hooks for the [Deno SDK](https://github.com/slackapi/deno-slack-sdk), [Bolt Frameworks](https://tools.slack.dev), and future community-driven SDKs, the CLI employs a service-discovery-like approach to querying the SDK for what functionality it supports.
In order for the CLI to reliably discover the hooks for the [Deno SDK](https://github.com/slackapi/deno-slack-sdk), [Bolt Frameworks](https://docs.slack.dev/tools/), and future community-driven SDKs, the CLI employs a service-discovery-like approach to querying the SDK for what functionality it supports.

A project includes a `hooks.json` file in its `.slack` directory which by default contains a single hook (`get-hooks`). The SDK is responsible for implementing this hook and returning to the CLI a JSON object with all hook definitions and their relevant default configuration (one hook to rule them all 💍).

Expand Down Expand Up @@ -150,7 +150,7 @@ The [app manifest](https://docs.slack.dev/reference/app-manifest) in JSON format

### 🪝 `build` (optional)

Implementing this hook allows for the CLI to [deploy function code to Slack's managed infrastructure](https://tools.slack.dev/deno-slack-sdk/guides/deploying-to-slack). The work of assembling the application bundle according to Slack's application bundle format is delegated to the SDK via this hook.
Implementing this hook allows for the CLI to [deploy function code to Slack's managed infrastructure](https://docs.slack.dev/tools/deno-slack-sdk/guides/deploying-to-slack/). The work of assembling the application bundle according to Slack's application bundle format is delegated to the SDK via this hook.

The application bundle format has few restrictions, but the critical ones are:
- It must have a `manifest.json` at the root of the package
Expand All @@ -159,7 +159,7 @@ The application bundle format has few restrictions, but the critical ones are:

The above requirements come from the [deno-slack-runtime](https://github.com/slackapi/deno-slack-runtime) project, which implements the expected Slack deployment bundle format. It contains a hard-coded [reference](https://github.com/slackapi/deno-slack-runtime/blob/main/src/mod.ts#L73) to the above-mentioned `functions/` sub-directory, and combines it with the [specific custom function `callback_id`](https://github.com/slackapi/deno-slack-runtime/blob/main/src/mod.ts#L17-L19) to resolve an import path for userland function source code.

*Note: This hook should only be implemented by official Slack SDKs and is only relevant to apps [deployed to Slack's managed infrastructure](https://tools.slack.dev/deno-slack-sdk/guides/deploying-to-slack).*
*Note: This hook should only be implemented by official Slack SDKs and is only relevant to apps [deployed to Slack's managed infrastructure](https://docs.slack.dev/tools/deno-slack-sdk/guides/deploying-to-slack/).*

#### Input

Expand Down
2 changes: 1 addition & 1 deletion cmd/datastore/datastore.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
"This command is supported for apps deployed to Slack managed infrastructure but",
"other apps can attempt to run the command with the --force flag.",
"",
`Discover the datastores: {{LinkText "https://tools.slack.dev/deno-slack-sdk/guides/using-datastores"}}`,
`Discover the datastores: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores"}}`,
}, "\n"),
Example: style.ExampleCommandsf([]style.ExampleCommand{
{
Expand Down
2 changes: 1 addition & 1 deletion cmd/env/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
"This command is supported for apps deployed to Slack managed infrastructure but",
"other apps can attempt to run the command with the --force flag.",
"",
`Explore more: {{LinkText "https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli"}}`,
`Explore more: {{LinkText "https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli"}}`,
}, "\n"),
Example: style.ExampleCommandsf([]style.ExampleCommand{
{
Expand Down
2 changes: 1 addition & 1 deletion cmd/externalauth/externalauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
"This command is supported for apps deployed to Slack managed infrastructure but",
"other apps can attempt to run the command with the --force flag.",
"",
`Explore providers: {{LinkText "https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication"}}`,
`Explore providers: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication"}}`,
}, "\n"),
Example: style.ExampleCommandsf([]style.ExampleCommand{
{
Expand Down
2 changes: 1 addition & 1 deletion cmd/function/function.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func NewCommand(clients *shared.ClientFactory) *cobra.Command {
"Inspect and configure the custom functions included in an app with this command.",
"Functions can be added as a step in Workflow Builder and shared among teammates.",
"",
`Learn more about functions: {{LinkText "https://tools.slack.dev/deno-slack-sdk/guides/creating-functions"}}`,
`Learn more about functions: {{LinkText "https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions"}}`,
}, "\n"),
Example: style.ExampleCommandsf([]style.ExampleCommand{
{Command: "function distribute", Meaning: "Select a function and choose distribution options"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/help/help.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,6 @@ const helpTemplate string = `{{.Long}}
For more information about a specific command, run:
$ {{.CommandPath}}{{if eq .Name (GetProcessName)}} <command>{{end}} <subcommand> --help

For guides and documentation, head over to {{LinkText "https://tools.slack.dev/slack-cli"}}{{end}}
For guides and documentation, head over to {{LinkText "https://docs.slack.dev/tools/slack-cli"}}{{end}}

`
2 changes: 1 addition & 1 deletion cmd/project/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ func printCreateSuccess(ctx context.Context, clients *shared.ClientFactory, appP
Emoji: "compass",
Text: "Explore the documentation to learn more",
Secondary: []string{
"Read the README.md or peruse the docs over at " + style.Highlight("https://tools.slack.dev/deno-slack-sdk"),
"Read the README.md or peruse the docs over at " + style.Highlight("https://docs.slack.dev/tools/deno-slack-sdk"),
"Find available commands and usage info with " + style.Commandf("help", false),
},
}))
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func NewRootCommand(clients *shared.ClientFactory, updateNotification *update.Up
Long: strings.Join([]string{
`{{Emoji "sparkles"}}CLI to create, run, and deploy Slack apps`,
"",
`{{Emoji "books"}}Get started by reading the docs: {{LinkText "https://tools.slack.dev/slack-cli"}}`,
`{{Emoji "books"}}Get started by reading the docs: {{LinkText "https://docs.slack.dev/tools/slack-cli"}}`,
}, "\n"),
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
Expand Down
2 changes: 1 addition & 1 deletion cmd/triggers/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ func getFullyQualifiedTriggerFilePaths(ctx context.Context, clients *shared.Clie

if len(triggerFilePaths) <= 0 {
clients.IO.PrintInfo(ctx, false, style.SectionSecondaryf(
"No trigger definition files found\nLearn more about triggers:\nhttps://tools.slack.dev/deno-slack-sdk/guides/creating-link-triggers",
"No trigger definition files found\nLearn more about triggers:\nhttps://docs.slack.dev/tools/deno-slack-sdk/guides/creating-link-triggers",
))
return nil, nil
} else {
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Slack command-line tool

CLI to create, run, and deploy Slack apps

Get started by reading the docs: [https://tools.slack.dev/slack-cli](https://tools.slack.dev/slack-cli)
Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli/)

```
slack <command> <subcommand> [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_datastore.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Interact with the items stored in an app's datastore.
This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.

Discover the datastores: [https://tools.slack.dev/deno-slack-sdk/guides/using-datastores](https://tools.slack.dev/deno-slack-sdk/guides/using-datastores)
Discover the datastores: [https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores](https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores/)

```
slack datastore <subcommand> <expression> [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ infrastructure.
This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.

Explore more: [https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli](https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli)
Explore more: [https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli](https://docs.slack.dev/tools/slack-cli/guides/using-environment-variables-with-the-slack-cli/)

```
slack env <subcommand> [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_external-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Adjust external authorization and authentication providers of a workflow app.
This command is supported for apps deployed to Slack managed infrastructure but
other apps can attempt to run the command with the --force flag.

Explore providers: [https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication](https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication)
Explore providers: [https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/](https://docs.slack.dev/tools/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication/)

```
slack external-auth <subcommand> [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/commands/slack_function.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Builder. Whatever that puzzle might be.
Inspect and configure the custom functions included in an app with this command.
Functions can be added as a step in Workflow Builder and shared among teammates.

Learn more about functions: [https://tools.slack.dev/deno-slack-sdk/guides/creating-functions](https://tools.slack.dev/deno-slack-sdk/guides/creating-functions)
Learn more about functions: [https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions](https://docs.slack.dev/tools/deno-slack-sdk/guides/creating-functions/)

```
slack function <subcommand> [flags]
Expand Down
4 changes: 2 additions & 2 deletions internal/slackerror/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ var ErrorCodeMap = map[string]Error{
},
Remediation: fmt.Sprintf(`Learn about building apps with the Deno Slack SDK:

https://tools.slack.dev/deno-slack-sdk
https://docs.slack.dev/tools/deno-slack-sdk

If you are using a Bolt framework, add a deploy hook then run: %s

Expand Down Expand Up @@ -561,7 +561,7 @@ Otherwise start your app for local development with: %s`,
ErrCLIAutoUpdate: {
Code: ErrCLIAutoUpdate,
Message: "Couldn't auto-update this command-line tool",
Remediation: "You can manually install the latest version from:\nhttps://tools.slack.dev/slack-cli",
Remediation: "You can manually install the latest version from:\nhttps://docs.slack.dev/tools/slack-cli",
},

ErrCLIConfigLocationError: {
Expand Down
2 changes: 1 addition & 1 deletion internal/update/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ func (c *CLIDependency) PrintUpdateNotification(cmd *cobra.Command) (bool, error
} else {
cmd.Printf(
"\n To manually update, visit the download page:\n %s\n\n",
style.CommandText("https://tools.slack.dev/slack-cli"),
style.CommandText("https://docs.slack.dev/tools/slack-cli"),
)
selfUpdatePrompt := fmt.Sprintf("%sDo you want to auto-update to the latest version now?", style.Emoji("rocket"))
return c.clients.IO.ConfirmPrompt(ctx, selfUpdatePrompt, false)
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-dev.sh
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ install_slack_cli() {
else
echo "🛑 Error: This installer is only supported on Linux and macOS"
echo "🔖 Try using a different installation method:"
echo "🔗 https://tools.slack.dev/slack-cli"
echo "🔗 https://docs.slack.dev/tools/slack-cli"
return 1
fi

Expand Down
2 changes: 1 addition & 1 deletion scripts/install-windows-dev.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ function next_step_message {
}
catch {
Write-Error "Slack CLI was not installed."
Write-Host "`nFind help troubleshooting: https://tools.slack.dev/slack-cli"
Write-Host "`nFind help troubleshooting: https://docs.slack.dev/tools/slack-cli"
throw
}
}
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-windows.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ function next_step_message {
}
catch {
Write-Error "Slack CLI was not installed."
Write-Host "`nFind help troubleshooting: https://tools.slack.dev/slack-cli"
Write-Host "`nFind help troubleshooting: https://docs.slack.dev/tools/slack-cli"
throw
}
}
Expand Down
2 changes: 1 addition & 1 deletion scripts/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ install_slack_cli() {
else
echo "🛑 Error: This installer is only supported on Linux and macOS"
echo "🔖 Try using a different installation method:"
echo "🔗 https://tools.slack.dev/slack-cli"
echo "🔗 https://docs.slack.dev/tools/slack-cli"
return 1
fi

Expand Down
Loading