Skip to content

Commit 79cacce

Browse files
docs: tweaks formatting to match rest of docs (#150)
* docs: formatting * added a few more relative links
1 parent e5b2dd0 commit 79cacce

8 files changed

+33
-52
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ Setting up a CI/CD pipeline requires authorization using a service token. Servic
7272

7373
To get a service token, you'll use the `slack auth token` command to get a `slackauthticket`, which you'll copy and paste into your workspace to exchange for the service token. The service token will not be saved to your `credentials.json` file; instead, it is presented in the terminal for you to copy and paste for use in your CI/CD pipeline. Once copied, you'll use the `slack login --auth <your-service-token>` command to authorize your Slack CLI. Detailed instructions are below.
7474
75-
:::info
75+
:::info[The service token will not conflict with your regular authentication token.]
7676
77-
The service token will not conflict with your regular authentication token; you can continue using your regular authentication token within the Slack CLI while using the service token for your CI/CD pipeline.
77+
You can continue using your regular authentication token within the Slack CLI while using the service token for your CI/CD pipeline.
7878
7979
:::
8080

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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](https://tools.slack.dev/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)
95+
➡️ [CI/CD overview and setup](/slack-cli/guides/setting-up-ci-cd-with-the-slack-cli)
9696
9797
➡️ [CI/CD authorization](/slack-cli/guides/authorizing-the-slack-cli#ci-cd)

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

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ The Slack CLI is a set of tools critical to building workflow apps. This is your
1212

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

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

17-
The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`. If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
17+
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
1818

1919
:::
2020

@@ -79,6 +79,7 @@ curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash -s -- -d
7979
Error: _Failed to create a symbolic link! The installer doesn't have write access to /usr/local/bin. Please check permission and try again..._
8080

8181
Solution: Sudo actions within the scripts were removed so as not to create any security concerns. The `$HOME` env var is updated to `/root` &mdash; however, the installer is using `$HOME` for both Deno and the SDK install, which causes the whole install to be placed under `/root`, making both Deno and the SDK unusable for users without root permissions.
82+
8283
* For users who do not have root permissions, run the sudo actions manually as follows: `sudo mkdir -p -m 775 /usr/local/bin`, then `sudo ln -sf "$slack_cli_bin_path" "/usr/local/bin/$SLACK_CLI_NAME"` where `$slack_cli_bin_path` is typically `$HOME/.slack/bin/slack` and `$SLACK_CLI_NAME` is typically the alias (by default it’s `slack`).
8384
* For users who do have root permissions, you can run the installation script as `sudo curl -fsSL https://downloads.slack-edge.com/slack-cli/install.sh | bash`. In this case, the script is executed as root.
8485

@@ -101,23 +102,22 @@ v8 10.*
101102
typescript 4.*
102103
```
103104

104-
**3\. Download and install
105-
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a
106-
dependency of the** `slack` **CLI.**
105+
**3\. Download and install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a dependency of the** `slack` **CLI.**
107106

108107
**4\. Download the** `slack` **CLI installer for your environment.**
109108

110-
<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz"><strong>Download for macOS Apple Silicon (.tar.gz)</strong></a>
109+
🍎 ⚡️ [**Download for macOS Apple Silicon (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_arm64.tar.gz)
111110

112-
<ts-icon class="ts_icon_apple"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz"><strong>Download for macOS Intel (.tar.gz)</strong></a>
111+
🍏 🪨 [**Download for macOS Intel (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_macOS_amd64.tar.gz)
113112

114-
<ts-icon class="ts_icon_plug"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_linux_64-bit.tar.gz"><strong>Download for Linux (.tar.gz)</strong></a>
113+
🐧 💾 [**Download for Linux (.tar.gz)**](https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_linux_64-bit.tar.gz)
115114

116115
**5\. Add the** `slack` **CLI to your path.**
117116

118-
:::info
119-
<p><strong>Existing</strong> <code>slack</code> <strong>binary in path?</strong></p>
120-
<p>If you have another CLI tool in your path called <code>slack</code>, we recommend renaming our slack binary to a different name before adding it to your path. See the <strong>Automated installation</strong> tab for more details.</p>
117+
:::info[Existing `slack` binary in path?]
118+
119+
If you have another CLI tool in your path called `slack`, we recommend renaming our slack binary to a different name before adding it to your path. See the **Automated installation** tab for more details.
120+
121121
:::
122122

123123
**6\. Verify that** `slack` **is installed and in your path.**
@@ -165,8 +165,7 @@ In addition, if you attempt to run the `slack run` command without this dependen
165165

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

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

171170
</TabItem>
172171
</Tabs>

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

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,13 @@ The Slack CLI is a set of tools critical to building workflow apps. This is your
1212

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

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

17-
The minimum required Slack CLI version for Enterprise Grid as of September 19th, 2023 is `v2.9.0`. If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
17+
If you attempt to log in with an older version, you'll receive a `cli_update_required` error from the Slack API. Run `slack upgrade` to get the latest version.
1818

1919
:::
2020

21-
:::warning
22-
23-
**PowerShell is required for installing the Slack CLI on Windows machines.** An alternative shell will not work.
21+
:::warning[PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.]
2422

2523
:::
2624

@@ -33,17 +31,11 @@ The minimum required Slack CLI version for Enterprise Grid as of September 19th,
3331
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 | iex
3432
```
3533

36-
:::warning
37-
38-
PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.
34+
:::warning[PowerShell is required for installing the Slack CLI on Windows machines; an alternative shell will not work.]
3935

4036
:::
4137

42-
This will install the Slack CLI and all required dependencies, including [Deno](/deno-slack-sdk/guides/installing-deno),
43-
the runtime environment for workflow apps. If you have VSCode installed,
44-
the [VSCode Deno
45-
extension](https://marketplace.visualstudio.com/items?itemName=denoland.vscode-deno)
46-
will be installed.
38+
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.
4739

4840
<details>
4941
<summary>Optional: Use an alias for the Slack CLI binary</summary>
@@ -63,9 +55,7 @@ You can also use the `-Alias` flag as described within **Optional: customize ins
6355
<details>
6456
<summary>Optional: customize installation using flags</summary>
6557

66-
There are several flags available to customize the installation. Since flags
67-
cannot be passed to remote scripts, you must first download the installation
68-
script to a local file:
58+
There are several flags available to customize the installation. Since flags cannot be passed to remote scripts, you must first download the installation script to a local file:
6959

7060
```zsh
7161
irm https://downloads.slack-edge.com/slack-cli/install-windows.ps1 -outfile 'install-windows.ps1'
@@ -123,19 +113,17 @@ v8 10.*
123113
typescript 4.*
124114
```
125115

126-
**3\. Download and install
127-
[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a
128-
dependency of the** `slack` **CLI.**
116+
**3\. Download and install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), a dependency of the** `slack` **CLI.**
129117

130118
**4\. Download the** `slack` **CLI installer for your environment.**
131119

132120
<ts-icon class="ts_icon_windows"></ts-icon> &nbsp; <a href="https://downloads.slack-edge.com/slack-cli/slack_cli_3.5.0_windows_64-bit.zip"><strong>Windows (.zip)</strong></a>
133121

134122
**5\. Add the** `slack` **CLI to your path.**
135123

136-
:::info
137-
<p><strong>Existing</strong> <code>slack</code> <strong>binary in path?</strong></p>
138-
<p>If you have another CLI tool in your path called <code>slack</code>, we recommend renaming our slack binary to a different name before adding it to your path. See the <strong>Automated installation</strong> tab for more details.</p>
124+
:::info[Existing `slack` binary in path?]
125+
126+
If you have another CLI tool in your path called `slack`, we recommend renaming our slack binary to a different name before adding it to your path. See the **Automated installation** tab for more details.
139127

140128
:::
141129

docs/guides/running-slack-cli-commands.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ slug: /slack-cli/guides/running-slack-cli-commands
77

88
The Slack CLI allows you to interact with your apps via the command line. Using the main command `slack`, you can create, run, and deploy apps, as well as create triggers and query datastores.
99

10-
:::info
11-
12-
Running `slack help` will display available commands in your terminal window.
10+
:::info[Running `slack help` will display available commands in your terminal window.]
1311

1412
:::
1513

docs/guides/setting-up-ci-cd-with-the-slack-cli.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,7 @@ This also includes calling Deno's [task runner](https://deno.land/manual/tools/t
168168

169169
✨ **For more information about creating unit tests**, refer to [Testing custom functions](/deno-slack-sdk/guides/creating-custom-functions#testing).
170170

171-
:::info
172-
173-
If you've created your project by [cloning one of our sample apps](/deno-slack-sdk/guides/creating-an-app), note that the `.github` folder will not be included. You'll need to create it yourself, but you can use the handy dandy **Copy** button next to the code samples on this page to get started!
171+
:::info[If you've created your project by [cloning one of our sample apps](/deno-slack-sdk/guides/creating-an-app), note that the `.github` folder will not be included. You'll need to create it yourself, but you can use the handy dandy **Copy** button next to the code samples on this page to get started!]
174172

175173
:::
176174

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ rd -r $HOME\AppData\Local\slack-cli
3232

3333
where `$HOME` is substituted for the full path, e.g. `C:\Users\<your_username>`.
3434

35-
:::warning
36-
37-
**As with installation, PowerShell is required for uninstallation of the Slack CLI from Windows machines.** An alternative shell will not work.
35+
:::warning[As with installation, PowerShell is required for uninstallation of the Slack CLI from Windows machines; an alternative shell will not work.]
3836

3937
:::
4038

docs/guides/using-slack-cli-with-bolt-frameworks.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ sidebar_label: Using with Bolt frameworks
44

55
# Using the Slack CLI with Bolt frameworks
66

7-
You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](/tools.slack.dev/bolt-js) and [Bolt for Python](/tools.slack.dev/bolt-python).
7+
You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](/bolt-js) and [Bolt for Python](/bolt-python).
88

9-
:::info
9+
:::info[Feeling adventurous?]
1010

11-
To create a Bolt app using features currently under development, refer to the [experiments](https://tools.slack.dev/slack-cli/reference/experiments) page.
11+
To create a Bolt app using features currently under development, refer to the [experiments](/slack-cli/reference/experiments) page.
1212

1313
:::
1414

@@ -34,9 +34,9 @@ You will then be prompted to choose between **Bolt for JavaScript** or **Bolt fo
3434

3535
Your app will be cloned from the respective [JavaScript](https://github.com/slack-samples/bolt-js-starter-template) or [Python](https://github.com/slack-samples/bolt-python-starter-template) project template on our Slack Platform Sample Code repository, and its project dependencies will be installed. Then, `cd` into your project folder.
3636

37-
:::info
37+
:::info[For Bolt for Python projects, automatic project dependency installation is currently unsupported, and will need to be done manually.]
3838

39-
For Bolt for Python projects, automatic project dependency installation is currently unsupported, and will need to be done manually. For more information, refer to [Getting started with Bolt for Python](https://tools.slack.dev/bolt-python/getting-started).
39+
For more information, refer to [Getting started with Bolt for Python](/bolt-python/getting-started).
4040

4141
:::
4242

0 commit comments

Comments
 (0)