mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
---
|
|
id: slack
|
|
title: Slack
|
|
---
|
|
|
|
> This feature was introduced in _Unleash v3.11.0_.
|
|
|
|
The Slack addon allows Unleash to post Updates when a feature toggle is updated. To set up Slack, you need to configure an incoming Slack webhook URL. You can follow [Sending messages using Incoming Webhooks](https://api.slack.com/incoming-webhooks) on how to do that. You can also choose to [create a slack app for Unleash](https://api.slack.com/apps), which will provide you with additional functionality to control how Unleash communicates messages on your Slack workspace.
|
|
|
|
The Slack addon will perform a single retry if the HTTP POST against the Slack Webhook URL fails (either a 50x or network error). Duplicate events may happen. You should never assume events always comes in order.
|
|
|
|
## Configuration {#configuration}
|
|
|
|
#### Events {#events}
|
|
|
|
You can choose to trigger updates for the following events:
|
|
|
|
- feature-created
|
|
- feature-updated (*)
|
|
- feature-metadata-updated
|
|
- feature-project-change
|
|
- feature-archived
|
|
- feature-revived
|
|
- feature-strategy-update
|
|
- feature-strategy-add
|
|
- feature-strategy-remove
|
|
- feature-stale-on
|
|
- feature-stale-off
|
|
- feature-environment-enabled
|
|
- feature-environment-disabled
|
|
|
|
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
|
|
|
|
#### Parameters {#parameters}
|
|
|
|
Unleash Slack addon takes the following parameters.
|
|
|
|
- **Slack Webhook URL** - This is the only required property. If you are using a Slack Application you must also make sure your application is allowed to post to the channel you want to post to.
|
|
- **Username** - Used to override the username used to post the update to a Slack channel.
|
|
- **Emoji Icon** - Used to override the emoji icon used to post the update to a Slack channel.
|
|
- **Default channel** - Where to post the message if the feature toggles has not overridden the channel via the slack tags.
|
|
|
|
#### Global configuration
|
|
|
|
- **Unleash URL** - The slack plugin uses the `server.unleashUrl` property to create the link back to Unleash in the posts. This can be set using the **UNLEASH_URL** environment variable or the `server.unleashUrl` property when starting the server from node.
|
|
|
|
#### Tags {#tags}
|
|
|
|
The Slack addon also defined the Tag type "slack". You may use this tag to override which Slack channel Unleash should post updates to for this feature toggle.
|
|
|
|
|
|
|
|
In the picture you can see we have defined two slack tags for the "new-payment-system" toggle. In this example Unleash will post updates to the **#notifications** and **#random** channel.
|