Skip to content

Commit a560f02

Browse files
docs: updates links to point to docs.slack.dev/tools* paths (#485)
1 parent 749d8a6 commit a560f02

File tree

7 files changed

+34
-34
lines changed

7 files changed

+34
-34
lines changed

docs/_sidebar.json

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
11
[
22
{
33
"type": "doc",
4-
"id": "slack-github-action/slack-github-action",
4+
"id": "tools/slack-github-action/slack-github-action",
55
"label": "Slack GitHub Action",
66
"className": "sidebar-title"
77
},
88
{ "type": "html", "value": "<hr>" },
9-
"slack-github-action/sending-variables",
9+
"tools/slack-github-action/sending-variables",
1010
{
1111
"type": "category",
1212
"label": "Sending techniques",
1313
"collapsed": false,
1414
"link": {
1515
"type": "doc",
16-
"id": "slack-github-action/sending-techniques/sending-techniques"
16+
"id": "tools/slack-github-action/sending-techniques/sending-techniques"
1717
},
1818
"items": [
19-
"slack-github-action/sending-techniques/sending-techniques",
19+
"tools/slack-github-action/sending-techniques/sending-techniques",
2020
{
2121
"type": "category",
2222
"label": "Sending data via a webhook to start a Slack workflow",
2323
"link": {
2424
"type": "doc",
25-
"id": "slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow"
25+
"id": "tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow"
2626
},
2727
"items": [
28-
"slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow",
29-
"slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/format-generated-files",
30-
"slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/post-release-announcements",
31-
"slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/update-a-channel-topic"
28+
"tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow",
29+
"tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/format-generated-files",
30+
"tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/post-release-announcements",
31+
"tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/update-a-channel-topic"
3232
]
3333
},
3434
{
3535
"type": "category",
3636
"label": "Sending data using a Slack API method",
3737
"link": {
3838
"type": "doc",
39-
"id": "slack-github-action/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method"
39+
"id": "tools/slack-github-action/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method"
4040
},
4141
"items": [
42-
"slack-github-action/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method",
43-
"slack-github-action/sending-techniques/sending-data-slack-api-method/direct-message-author",
44-
"slack-github-action/sending-techniques/sending-data-slack-api-method/invite-usergroup-to-channel"
42+
"tools/slack-github-action/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method",
43+
"tools/slack-github-action/sending-techniques/sending-data-slack-api-method/direct-message-author",
44+
"tools/slack-github-action/sending-techniques/sending-data-slack-api-method/invite-usergroup-to-channel"
4545
]
4646
},
4747
{
4848
"type": "category",
4949
"label": "Sending data as a message with a Slack incoming webhook URL",
5050
"link": {
5151
"type": "doc",
52-
"id": "slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook"
52+
"id": "tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook"
5353
},
5454
"items": [
55-
"slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook",
56-
"slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-text-message",
57-
"slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-block-message",
58-
"slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-blocks-found-in-file"
55+
"tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook",
56+
"tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-text-message",
57+
"tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-block-message",
58+
"tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-blocks-found-in-file"
5959
]
6060
}
6161
]
6262
},
63-
"slack-github-action/additional-configurations"
63+
"tools/slack-github-action/additional-configurations"
6464
]

docs/additional-configurations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Invalid inputs to the GitHub Action, such as not including a payload, will alway
2323
2424
## Flattening nested payloads
2525
26-
Variables and data provided in the payload might contain nested fields that need to be flattened before being sent with a [webhook trigger](/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow) to match the expected input format of [Workflow Builder](https://slack.com/features/workflow-automation).
26+
Variables and data provided in the payload might contain nested fields that need to be flattened before being sent with a [webhook trigger](/tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow) to match the expected input format of [Workflow Builder](https://slack.com/features/workflow-automation).
2727
2828
The `payload-delimiter` option will flatten the input payload using the provided delimiter and will also make values stringified:
2929

docs/sending-techniques/sending-data-slack-api-method/sending-data-slack-api-method.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,5 +141,5 @@ Calling [a Slack API method](https://docs.slack.dev/reference/methods) with [`@s
141141

142142
## Example workflows
143143

144-
* [**Direct message the author**](/slack-github-action/sending-techniques/sending-data-slack-api-method/direct-message-author): Write to the Slack user with a matching email.
145-
* [**Invite a usergroup to channel**](/slack-github-action/sending-techniques/sending-data-slack-api-method/invite-usergroup-to-channel): Create a channel and invite members.
144+
* [**Direct message the author**](/tools/slack-github-action/sending-techniques/sending-data-slack-api-method/direct-message-author): Write to the Slack user with a matching email.
145+
* [**Invite a usergroup to channel**](/tools/slack-github-action/sending-techniques/sending-data-slack-api-method/invite-usergroup-to-channel): Create a channel and invite members.

docs/sending-techniques/sending-data-slack-incoming-webhook/sending-data-slack-incoming-webhook.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ Add the collected webhook from above to a GitHub workflow and configure the step
4646
4747
## Example workflows
4848
49-
* [**Post an inline text message**](/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-text-message)
50-
* [**Post an inline block message**](/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-block-message)
51-
* [**Post blocks found in a file**](/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-blocks-found-in-file)
49+
* [**Post an inline text message**](/tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-text-message)
50+
* [**Post an inline block message**](/tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-inline-block-message)
51+
* [**Post blocks found in a file**](/tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/post-blocks-found-in-file)

docs/sending-techniques/sending-data-webhook-slack-workflow/sending-data-webhook-slack-workflow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ In the example below, the default GitHub event [context](https://github.com/acti
4141
webhook-type: webhook-trigger
4242
```
4343
44-
Accessing variables sent to [Workflow Builder](https://slack.com/features/workflow-automation) with a webhook require that the payload variables are flattened with stringified values. Nested variables in the provided payload can be both flattened and also stringified with the `payload-delimiter` option or changed with other [configurations](/slack-github-action/additional-configurations) to match this format expected from Workflow Builder.
44+
Accessing variables sent to [Workflow Builder](https://slack.com/features/workflow-automation) with a webhook require that the payload variables are flattened with stringified values. Nested variables in the provided payload can be both flattened and also stringified with the `payload-delimiter` option or changed with other [configurations](/tools/slack-github-action/additional-configurations) to match this format expected from Workflow Builder.
4545

4646
### Providing parsed payload information as strings
4747

@@ -73,6 +73,6 @@ Input values for the payload to be sent can also be provided in a file, either i
7373

7474
## Example workflows
7575

76-
* [**Format generated files**](/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/format-generated-files): Message outputs from prior steps.
77-
* [**Post release announcements**](/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/post-release-announcements): Share releases to a channel.
78-
* [**Update a channel topic**](/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/update-a-channel-topic): Highlight the current build status.
76+
* [**Format generated files**](/tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/format-generated-files): Message outputs from prior steps.
77+
* [**Post release announcements**](/tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/post-release-announcements): Share releases to a channel.
78+
* [**Update a channel topic**](/tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow/update-a-channel-topic): Highlight the current build status.

docs/sending-techniques/sending-techniques.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_label: Overview
66

77
This GitHub Action offers three different techniques to send data to Slack:
88

9-
* [Send data with a webhook to start a workflow in Workflow Builder](/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow).
10-
* [Send data using a Slack API method and a secret token with required scopes](/slack-github-action/sending-techniques/sending-data-slack-api-method/).
11-
* [Send data as a message with a Slack incoming webhook URL](/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/).
9+
* [Send data with a webhook to start a workflow in Workflow Builder](/tools/slack-github-action/sending-techniques/sending-data-webhook-slack-workflow).
10+
* [Send data using a Slack API method and a secret token with required scopes](/tools/slack-github-action/sending-techniques/sending-data-slack-api-method/).
11+
* [Send data as a message with a Slack incoming webhook URL](/tools/slack-github-action/sending-techniques/sending-data-slack-incoming-webhook/).
1212

1313
## Expected outputs
1414

docs/sending-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sending variables
22

3-
There are different [techniques to send data](/slack-github-action/sending-techniques) into Slack and whichever one is chosen will require a certain set of customized inputs, as described later.
3+
There are different [techniques to send data](/tools/slack-github-action/sending-techniques) into Slack and whichever one is chosen will require a certain set of customized inputs, as described later.
44

55
You can provide data to send to Slack from this GitHub Action and either source:
66

@@ -9,4 +9,4 @@ You can provide data to send to Slack from this GitHub Action and either source:
99

1010
These input options are valid for all techniques, but some techniques require specific constraints with certain requirements for valid inputs.
1111

12-
Additional [configurations](/slack-github-action/additional-configurations) and other details are also available for more customizations to the provided payload.
12+
Additional [configurations](/tools/slack-github-action/additional-configurations) and other details are also available for more customizations to the provided payload.

0 commit comments

Comments
 (0)