mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-01 13:47:27 +02:00
1-1262-docs-update-integrations: move addons files to integrations
This commit is contained in:
Thomas Heartman
parent
e7180af6dc
commit
0883131a26
@ -1,27 +0,0 @@
|
||||
---
|
||||
id: index
|
||||
title: Integrations
|
||||
---
|
||||
|
||||
:::info Availability
|
||||
|
||||
Unleash integrations were introduced in _Unleash v3.11.0_.
|
||||
|
||||
Prior to Unleash 5.x, they were known as _addons_.
|
||||
|
||||
:::
|
||||
|
||||
Unleash integrations allows you to extend Unleash with new functionality. Currently, integrations allow you to listen to changes in Unleash and trigger updates in other systems, typical via a WebHook.
|
||||
|
||||
Currently Unleash support the following integrations out of the box:
|
||||
|
||||
- [Webhook](webhook.md) - A generic way to post messages from Unleash to third party services.
|
||||
- [Slack](slack.md) - Allows Unleash to post updates to Slack.
|
||||
- [Microsoft Teams](teams.md) - Allows Unleash to post updates to Microsoft Teams.
|
||||
- [Datadog](datadog.md) -allows Unleash to post Updates to Datadog when a feature toggle is updated.
|
||||
|
||||
In future releases we plan to support community built integrations.
|
||||
|
||||
### Notes {#notes}
|
||||
|
||||
When updating or creating a new integration configuration it can take up to one minute before Unleash picks up the new config on all instances due to caching.
|
||||
44
website/docs/reference/integrations/addons.md
Normal file
44
website/docs/reference/integrations/addons.md
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
id: index
|
||||
title: Integrations
|
||||
---
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
|
||||
:::info Availability
|
||||
|
||||
Unleash integrations were introduced in _Unleash v3.11.0_.
|
||||
|
||||
Prior to Unleash 5.x, they were known as _addons_.
|
||||
|
||||
:::
|
||||
|
||||
Unleash integrations allows you to extend Unleash with new functionality and to connect to external applications.
|
||||
|
||||
Unleash has two types of integrations: Integrations that allow you to listen to changes in Unleash and trigger updates in other systems (for instance via webhooks or direct integrations) and integrations that communicate with Unleash (such as the Jira integrations).
|
||||
|
||||
## Official integrations
|
||||
|
||||
Unleash currently supports the following integrations out of the box:
|
||||
|
||||
- [Datadog](datadog.md) - Allows Unleash to post Updates to Datadog when a feature toggle is updated.
|
||||
- [Jira Cloud](jira-cloud-plugin-usage.md) - Allows you to create, view and manage Unleash feature flags directly from a Jira Cloud issue
|
||||
- [Jira Server](jira-server-plugin-usage.md) - Allows you to create and link Unleash feature flags directly from a Jira Server issue
|
||||
- [Microsoft Teams](teams.md) - Allows Unleash to post updates to Microsoft Teams.
|
||||
- [Slack](slack.md) - Allows Unleash to post updates to Slack.
|
||||
- [Webhook](webhook.md) - A generic way to post messages from Unleash to third party services.
|
||||
|
||||
## Community integrations
|
||||
|
||||
Our wonderful community has also created the following integrations:
|
||||
|
||||
- [Fastify feature flags plugin](https://gitlab.com/m03geek/fastify-feature-flags#unleash-provider)
|
||||
- [Quarkus](https://github.com/quarkiverse/quarkus-unleash)
|
||||
- [Vue Unleash plugin](https://github.com/crishellco/vue-unleash)
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
When updating or creating a new integration configuration it can take up to one minute before Unleash picks up the new config on all instances due to caching.
|
||||
|
||||
## Integration pages
|
||||
|
||||
<DocCardList />
|
||||
@ -48,6 +48,6 @@ Unleash Slack integration takes the following parameters.
|
||||
|
||||
The Slack integration 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.
|
||||
@ -171,14 +171,24 @@ module.exports = {
|
||||
items: [
|
||||
{
|
||||
type: 'category',
|
||||
link: { type: 'doc', id: 'reference/addons/index' },
|
||||
link: { type: 'doc', id: 'reference/integrations/index' },
|
||||
items: [
|
||||
'reference/addons/datadog',
|
||||
'reference/addons/slack',
|
||||
'reference/addons/teams',
|
||||
'reference/addons/webhook',
|
||||
'reference/integrations/datadog',
|
||||
{
|
||||
'Jira Server': [
|
||||
'reference/integrations/jira-server-plugin-installation',
|
||||
'reference/integrations/jira-server-plugin-usage',
|
||||
],
|
||||
'Jira Cloud': [
|
||||
'reference/integrations/jira-cloud-plugin-installation',
|
||||
'reference/integrations/jira-cloud-plugin-usage',
|
||||
],
|
||||
},
|
||||
'reference/integrations/slack',
|
||||
'reference/integrations/teams',
|
||||
'reference/integrations/webhook',
|
||||
],
|
||||
label: 'Addons',
|
||||
label: 'Integrations',
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
@ -291,27 +301,6 @@ module.exports = {
|
||||
'reference/deploy/securing-unleash',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Integrations',
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: 'reference/integrations/integrations',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
'Jira Server': [
|
||||
'reference/integrations/jira-server-plugin-installation',
|
||||
'reference/integrations/jira-server-plugin-usage',
|
||||
],
|
||||
'Jira Cloud': [
|
||||
'reference/integrations/jira-cloud-plugin-installation',
|
||||
'reference/integrations/jira-cloud-plugin-usage',
|
||||
],
|
||||
},
|
||||
,
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
link: {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user