Skip to content

Commit 2e9d58b

Browse files
Docs: updates links to point to docs.slack.dev/tools* paths (#176)
* updates links * update readme * updates sidebar * overzealous find and replace * deno links * saving * saving for real * removing overzealous ctrl f and r * fixing some links * removing autgen reference pages * windows links * mac links * download links * removing download link
1 parent cc25ecb commit 2e9d58b

15 files changed

+96
-96
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ submit an issue or pull request to start a discussion!
5353

5454
Thanks for stopping by! You're awesome :sunglasses:
5555

56-
[commands]: https://tools.slack.dev/slack-cli/reference/commands/slack
56+
[commands]: https://docs.slack.dev/tools/slack-cli/reference/commands/slack
5757
[dev]: https://github.com/slackapi/slack-cli/releases/tag/dev-build
5858
[enhancements]: https://github.com/slackapi/slack-cli/pulls
59-
[install]: https://tools.slack.dev/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
59+
[install]: https://docs.slack.dev/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
6060
[issues]: https://github.com/slackapi/slack-cli/issues/new?template=04_bug.md
6161
[maintainers]: .github/MAINTAINERS_GUIDE.md
6262
[releases]: https://github.com/slackapi/slack-cli/releases

docs/_sidebar.json

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
{
33
"type": "doc",
4-
"id": "slack-cli/index",
4+
"id": "tools/slack-cli/index",
55
"label": "Slack CLI",
66
"className": "sidebar-title"
77
},
@@ -11,17 +11,17 @@
1111
"label": "Guides",
1212
"collapsed": false,
1313
"items": [
14-
"slack-cli/guides/installing-the-slack-cli-for-mac-and-linux",
15-
"slack-cli/guides/installing-the-slack-cli-for-windows",
16-
"slack-cli/guides/authorizing-the-slack-cli",
17-
"slack-cli/guides/using-slack-cli-with-bolt-frameworks",
18-
"slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization",
19-
"slack-cli/guides/running-slack-cli-commands",
20-
"slack-cli/guides/using-environment-variables-with-the-slack-cli",
21-
"slack-cli/guides/troubleshooting-slack-cli-errors",
22-
"slack-cli/guides/setting-up-ci-cd-with-the-slack-cli",
23-
"slack-cli/guides/deploying-with-the-slack-cli-and-github-actions",
24-
"slack-cli/guides/uninstalling-the-slack-cli"
14+
"tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux",
15+
"tools/slack-cli/guides/installing-the-slack-cli-for-windows",
16+
"tools/slack-cli/guides/authorizing-the-slack-cli",
17+
"tools/slack-cli/guides/using-slack-cli-with-bolt-frameworks",
18+
"tools/slack-cli/guides/using-slack-cli-on-an-enterprise-grid-organization",
19+
"tools/slack-cli/guides/running-slack-cli-commands",
20+
"tools/slack-cli/guides/using-environment-variables-with-the-slack-cli",
21+
"tools/slack-cli/guides/troubleshooting-slack-cli-errors",
22+
"tools/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli",
23+
"tools/slack-cli/guides/deploying-with-the-slack-cli-and-github-actions",
24+
"tools/slack-cli/guides/uninstalling-the-slack-cli"
2525
]
2626
},
2727
{ "type": "html", "value": "<hr>" },
@@ -36,18 +36,18 @@
3636
"items": [
3737
{
3838
"type": "autogenerated",
39-
"dirName": "slack-cli/reference/commands"
39+
"dirName": "tools/slack-cli/reference/commands"
4040
}
4141
]
4242
},
4343
{
4444
"type": "doc",
45-
"id": "slack-cli/reference/errors",
45+
"id": "tools/slack-cli/reference/errors",
4646
"label": "Errors"
4747
},
4848
{
4949
"type": "doc",
50-
"id": "slack-cli/reference/experiments",
50+
"id": "tools/slack-cli/reference/experiments",
5151
"label": "Experiments"
5252
}
5353
]

docs/guides/authorizing-the-slack-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
slug: /slack-cli/guides/authorizing-the-slack-cli
2+
slug: /tools/slack-cli/guides/authorizing-the-slack-cli
33
---
44

55
# Authorizing the Slack CLI {#authorize-cli}
66

7-
Once you have the Slack CLI installed for either [Windows](/slack-cli/guides/installing-the-slack-cli-for-windows) or [Mac/Linux](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux), authorize the Slack CLI in your workspace with the following command:
7+
Once you have the Slack CLI installed for either [Windows](/tools/slack-cli/guides/installing-the-slack-cli-for-windows) or [Mac/Linux](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux), authorize the Slack CLI in your workspace with the following command:
88

99
```zsh
1010
slack login

docs/guides/deploying-with-the-slack-cli-and-github-actions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: Deploying with GitHub Actions
3-
slug: /slack-cli/guides/deploying-the-slack-cli-with-github-actions
3+
slug: /tools/slack-cli/guides/deploying-the-slack-cli-with-github-actions
44
---
55

66
# Deploying with the Slack CLI & GitHub Actions
@@ -10,26 +10,26 @@ This tutorial demonstrates how to use CI/CD to facilitate automatic deployments
1010
Before we begin, you'll need to do the following:
1111

1212
* Create a new GitHub repository &mdash; any name will do.
13-
* [Install](/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) the Slack CLI on your machine.
14-
* [Authorize](/slack-cli/guides/authorizing-the-slack-cli) the Slack CLI to your workspace.
13+
* [Install](/tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux) the Slack CLI on your machine.
14+
* [Authorize](/tools/slack-cli/guides/authorizing-the-slack-cli) the Slack CLI to your workspace.
1515

1616
Once those steps have been completed, we're ready to move on to building our automated deployment app.
1717

1818
## Create a new app {#create}
1919

2020
Run `slack create` to create a new Slack app project. Select a template to build from; in this case, hit **Enter** to choose the default `Issue submission` template.
2121

22-
Refer to [Create or remove an app](/deno-slack-sdk/guides/creating-an-app) for more details.
22+
Refer to [Create or remove an app](/tools/deno-slack-sdk/guides/creating-an-app) for more details.
2323

2424
## Initial deploy {#initial-deploy}
2525

26-
Run `slack deploy` to manually deploy the new app to your workspace for the first time. During the process, you'll be prompted to create a link trigger. Refer to [Link triggers](/deno-slack-sdk/guides/creating-link-triggers) for more details.
26+
Run `slack deploy` to manually deploy the new app to your workspace for the first time. During the process, you'll be prompted to create a link trigger. Refer to [Link triggers](/tools/deno-slack-sdk/guides/creating-link-triggers) for more details.
2727

2828
Once created, copy the link and share it in a Slack channel. You'll see a button appear to start the workflow; click it to verify that the default workflow is functioning properly.
2929

3030
## Obtain a service token {#obtain-service-token}
3131

32-
To automate subsequent deployments, we'll need to obtain a [service token](/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for the app.
32+
To automate subsequent deployments, we'll need to obtain a [service token](/tools/slack-cli/guides/authorizing-the-slack-cli#ci-cd) for the app.
3333

3434
Navigate to the root directory of your project and run the `slack auth token` command. You'll be prompted to run a slash command called `slackauthticket`, similar to the way you authorized your app earlier. Copy that command and run it in Slack, then copy the challenge code you receive and enter it into your terminal. You'll see a service token that starts with `xoxp-` &mdash; make sure you save this token. Note that this token is connected to a specific workspace and organization.
3535

@@ -92,6 +92,6 @@ Your GitHub repository is now set up for team collaboration! Your team members c
9292
9393
Check out these articles to expand your knowledge and skills of automated deployments and the Slack CLI:
9494
95-
➡️ [CI/CD overview and setup](/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)
95+
➡️ [CI/CD overview and setup](/tools/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)
9696
97-
➡️ [CI/CD authorization](/slack-cli/guides/authorizing-the-slack-cli#ci-cd)
97+
➡️ [CI/CD authorization](/tools/slack-cli/guides/authorizing-the-slack-cli#ci-cd)

docs/guides/installing-the-slack-cli-for-mac-and-linux.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
sidebar_label: Installing for MacOS & Linux
3-
slug: /slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
3+
slug: /tools/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux
44
---
55

66
# Installing the Slack CLI for Mac & Linux
77

88
The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.
99

10-
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
10+
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/tools/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
1111

12-
⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.
12+
⤵️ **If you need to authorize the Slack CLI, [go here](/tools/slack-cli/guides/authorizing-the-slack-cli)**.
1313

1414
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
1515

@@ -26,7 +26,7 @@ If you attempt to log in with an older version, you'll receive a `cli_update_req
2626
curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash
2727
```
2828

29-
This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno),
29+
This will install the Slack CLI and all required dependencies, including [Deno](/tools/deno-slack-sdk/guides/installing-deno),
3030
the runtime environment for workflow apps. If you have VSCode installed,
3131
the [VSCode Deno
3232
extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno)
@@ -92,7 +92,7 @@ Solution: Sudo actions within the scripts were removed so as not to create any s
9292

9393
Manual installation allows you to omit the Deno installation if you don't need it. Deno is needed if you are creating [workflow apps](https://docs.slack.dev/workflows). If you intend to solely use the CLI for Bolt apps, you do not need Deno. If you forgo the Deno installation, skip to step 3.
9494

95-
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/deno-slack-sdk/guides/installing-deno) for more details.
95+
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/tools/deno-slack-sdk/guides/installing-deno) for more details.
9696

9797
**2\. Verify that Deno is installed and in your path.**
9898

@@ -171,7 +171,7 @@ In addition, if you attempt to run the `slack run` command without this dependen
171171

172172
Ensure that `deno-slack-hooks` is installed at the project level and that the version is not less than `v1.3.0`.
173173

174-
**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
174+
**8\. [Install the VSCode extension for Deno](/tools/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
175175

176176
</TabItem>
177177
</Tabs>

docs/guides/installing-the-slack-cli-for-windows.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
sidebar_label: Installing for Windows
3-
slug: /slack-cli/guides/installing-the-slack-cli-for-windows
3+
slug: /tools/slack-cli/guides/installing-the-slack-cli-for-windows
44
---
55

66
# Installing the Slack CLI for Windows
77

88
The Slack CLI is a set of tools critical to building workflow apps. This is your one-stop shop for those tools.
99

10-
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
10+
**If you've not used the Slack CLI before, we recommend following our [Deno Slack SDK getting started guide](/tools/deno-slack-sdk/guides/getting-started) instead**. We'll still get your wagon loaded up before you depart for the trail, but we'll also give you some additional guidance.
1111

12-
⤵️ **If you need to authorize the Slack CLI, [go here](/slack-cli/guides/authorizing-the-slack-cli)**.
12+
⤵️ **If you need to authorize the Slack CLI, [go here](/tools/slack-cli/guides/authorizing-the-slack-cli)**.
1313

1414
:::info[The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`.]
1515

@@ -34,7 +34,7 @@ irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 | iex
3434

3535
:::
3636

37-
This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno), the runtime environment for workflow apps. If you have VSCode installed, the [VSCode Deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) will be installed.
37+
This will install the Slack CLI and all required dependencies, including [Deno](/tools/deno-slack-sdk/guides/installing-deno), the runtime environment for workflow apps. If you have VSCode installed, the [VSCode Deno extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno) will be installed.
3838

3939
<details>
4040
<summary>Optional: Use an alias for the Slack CLI binary</summary>
@@ -99,7 +99,7 @@ Solution: For the installer to work correctly, your PowerShell session's [langua
9999

100100
Manual installation allows you to omit the Deno installation if you don't need it. Deno is needed if you are creating [workflow apps](https://docs.slack.dev/workflows). If you intend to solely use the CLI for Bolt apps, you do not need Deno. If you forgo the Deno installation, skip to step 3.
101101

102-
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/deno-slack-sdk/guides/installing-deno) for more details.
102+
**1\. Download and install [Deno](https://deno.land).** Refer to [Install Deno](/tools/deno-slack-sdk/guides/installing-deno) for more details.
103103

104104
**2\. Verify that Deno is installed and in your path.**
105105

@@ -173,7 +173,7 @@ In addition, if you attempt to run the `slack run` command without this dependen
173173

174174
Ensure that `deno-slack-hooks` is installed at the project level and that the version is not less than `v1.3.0`.
175175

176-
**8\. [Install the VSCode extension for Deno](/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
176+
**8\. [Install the VSCode extension for Deno](/tools/deno-slack-sdk/guides/installing-deno#vscode) (recommended).**
177177

178178
</TabItem>
179179
</Tabs>
Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: Running commands
3-
slug: /slack-cli/guides/running-slack-cli-commands
3+
slug: /tools/slack-cli/guides/running-slack-cli-commands
44
---
55

66
# Running Slack CLI commands
@@ -29,28 +29,28 @@ Below you'll find all the commands and subcommands for the Slack CLI. Each one h
2929

3030
| Command | Description |
3131
| :--- | :--- |
32-
| [`slack activity`](/slack-cli/reference/commands/slack_activity) | Display the app activity logs from the Slack Platform
33-
| [`slack app`](/slack-cli/reference/commands/slack_app) | Install, uninstall, and list teams with the app installed
34-
| [`slack auth`](/slack-cli/reference/commands/slack_auth) | Add and remove local team authorizations
35-
| [`slack collaborator`](/slack-cli/reference/commands/slack_collaborator) | Manage app collaborators
36-
| [`slack create`](/slack-cli/reference/commands/slack_create) | Create a Slack project
37-
| [`slack datastore`](/slack-cli/reference/commands/slack_datastore) | Query an app's datastore
38-
| [`slack delete`](/slack-cli/reference/commands/slack_delete) | Delete the app
39-
| [`slack deploy`](/slack-cli/reference/commands/slack_deploy) | Deploy the app to the Slack Platform
40-
| [`slack doctor`](/slack-cli/reference/commands/slack_doctor) | Check and report on system and app information
41-
| [`slack env`](/slack-cli/reference/commands/slack_env) | Add, remove, and list environment variables
42-
| [`slack external-auth`](/slack-cli/reference/commands/slack_external-auth) | Add and remove external authorizations and client secrets for providers in your app
43-
| [`slack feedback`](/slack-cli/reference/commands/slack_feedback) | Share feedback about your experience or project
44-
| [`slack function`](/slack-cli/reference/commands/slack_function) | Manage the functions of an app
45-
| [`slack install`](/slack-cli/reference/commands/slack_install) | Install the app to a team
46-
| [`slack list`](/slack-cli/reference/commands/slack_list) | List all authorized accounts
47-
| [`slack login`](/slack-cli/reference/commands/slack_login) | Log in to a Slack account
48-
| [`slack logout`](/slack-cli/reference/commands/slack_logout) | Log out of a team
49-
| [`slack manifest`](/slack-cli/reference/commands/slack_manifest) | Print the app manifest of a project or app
50-
| [`slack platform`](/slack-cli/reference/commands/slack_platform) | Deploy and run apps on the Slack Platform
51-
| [`slack run`](/slack-cli/reference/commands/slack_run) | Start a local server to develop and run the app locally
52-
| [`slack samples`](/slack-cli/reference/commands/slack_samples) | List available sample apps
53-
| [`slack trigger`](/slack-cli/reference/commands/slack_trigger) | List details of existing triggers
54-
| [`slack uninstall`](/slack-cli/reference/commands/slack_uninstall) | Uninstall the app from a team
55-
| [`slack upgrade`](/slack-cli/reference/commands/slack_upgrade) | Checks for available updates to the CLI or SDK
56-
| [`slack version`](/slack-cli/reference/commands/slack_version) | Print the version number
32+
| [`slack activity`](/tools/slack-cli/reference/commands/slack_activity) | Display the app activity logs from the Slack Platform
33+
| [`slack app`](/tools/slack-cli/reference/commands/slack_app) | Install, uninstall, and list teams with the app installed
34+
| [`slack auth`](/tools/slack-cli/reference/commands/slack_auth) | Add and remove local team authorizations
35+
| [`slack collaborator`](/tools/slack-cli/reference/commands/slack_collaborator) | Manage app collaborators
36+
| [`slack create`](/tools/slack-cli/reference/commands/slack_create) | Create a Slack project
37+
| [`slack datastore`](/tools/slack-cli/reference/commands/slack_datastore) | Query an app's datastore
38+
| [`slack delete`](/tools/slack-cli/reference/commands/slack_delete) | Delete the app
39+
| [`slack deploy`](/tools/slack-cli/reference/commands/slack_deploy) | Deploy the app to the Slack Platform
40+
| [`slack doctor`](/tools/slack-cli/reference/commands/slack_doctor) | Check and report on system and app information
41+
| [`slack env`](/tools/slack-cli/reference/commands/slack_env) | Add, remove, and list environment variables
42+
| [`slack external-auth`](/tools/slack-cli/reference/commands/slack_external-auth) | Add and remove external authorizations and client secrets for providers in your app
43+
| [`slack feedback`](/tools/slack-cli/reference/commands/slack_feedback) | Share feedback about your experience or project
44+
| [`slack function`](/tools/slack-cli/reference/commands/slack_function) | Manage the functions of an app
45+
| [`slack install`](/tools/slack-cli/reference/commands/slack_install) | Install the app to a team
46+
| [`slack list`](/tools/slack-cli/reference/commands/slack_list) | List all authorized accounts
47+
| [`slack login`](/tools/slack-cli/reference/commands/slack_login) | Log in to a Slack account
48+
| [`slack logout`](/tools/slack-cli/reference/commands/slack_logout) | Log out of a team
49+
| [`slack manifest`](/tools/slack-cli/reference/commands/slack_manifest) | Print the app manifest of a project or app
50+
| [`slack platform`](/tools/slack-cli/reference/commands/slack_platform) | Deploy and run apps on the Slack Platform
51+
| [`slack run`](/tools/slack-cli/reference/commands/slack_run) | Start a local server to develop and run the app locally
52+
| [`slack samples`](/tools/slack-cli/reference/commands/slack_samples) | List available sample apps
53+
| [`slack trigger`](/tools/slack-cli/reference/commands/slack_trigger) | List details of existing triggers
54+
| [`slack uninstall`](/tools/slack-cli/reference/commands/slack_uninstall) | Uninstall the app from a team
55+
| [`slack upgrade`](/tools/slack-cli/reference/commands/slack_upgrade) | Checks for available updates to the CLI or SDK
56+
| [`slack version`](/tools/slack-cli/reference/commands/slack_version) | Print the version number

0 commit comments

Comments
 (0)