From 1539d1955fec1482fb93728cab1cb5069d98c17c Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Thu, 14 Sep 2023 15:27:51 +0200 Subject: [PATCH] docs(1-1262): Change addons -> integrations (#4523) This PR replaces references to _addons_ in the docs with references to _integrations_. In doing so, I have also: - moved `/reference/addons` documents into `/reference/integrations` - combined the previous "Addons" and "Integrations" categories into a new "Integrations" category - added redirects from all the old addons pages to their new locations I have updated the wording, but have not changed things such as API paths, event names, etc, because these will not change at the moment (maybe a breaking change to schedule for v6?). --------- Co-authored-by: Tymoteusz Czech <2625371+Tymek@users.noreply.github.com> --- website/docs/about-the-docs.md | 3 +- ...end-feature-updates-to-slack-deprecated.md | 2 +- website/docs/reference/addons/addons.md | 21 --------- .../api/legacy/unleash/admin/addons.md | 20 ++++----- .../reference/deploy/configuring-unleash.md | 8 ++-- website/docs/reference/environments.md | 4 +- website/docs/reference/event-types.mdx | 8 ++-- .../docs/reference/feature-toggle-types.md | 2 +- .../{addons => integrations}/datadog.md | 8 ++-- .../reference/integrations/integrations.md | 45 +++++++++++++++---- .../{addons => integrations}/slack.md | 8 ++-- .../{addons => integrations}/teams.md | 8 ++-- .../{addons => integrations}/webhook.md | 4 +- website/docs/reference/rbac.md | 38 ++++++++-------- website/docs/reference/whats-new-v4.md | 8 ++-- website/docusaurus.config.js | 20 ++++----- website/sidebars.js | 23 +++------- 17 files changed, 112 insertions(+), 118 deletions(-) delete mode 100644 website/docs/reference/addons/addons.md rename website/docs/reference/{addons => integrations}/datadog.md (64%) rename website/docs/reference/{addons => integrations}/slack.md (64%) rename website/docs/reference/{addons => integrations}/teams.md (50%) rename website/docs/reference/{addons => integrations}/webhook.md (88%) diff --git a/website/docs/about-the-docs.md b/website/docs/about-the-docs.md index 79393e373d..eeb0a80411 100644 --- a/website/docs/about-the-docs.md +++ b/website/docs/about-the-docs.md @@ -45,11 +45,10 @@ The reference docs contain technical reference for Unleash and the API. Go here The reference docs are organized into the following topics: -- [Addons](./reference/addons/addons.md) - [API documentation](./reference/api/legacy/unleash/index.md) - [Unleash SDKs](./reference/sdks/index.md) - [Deployment and management of Unleash](./reference/deploy) -- [Integrations with other systems](./reference/integrations/integrations.md) +- [Integrations](./reference/integrations/integrations.md) - [Unleash concepts](./reference/concepts) ### Topic guides diff --git a/website/docs/how-to/how-to-send-feature-updates-to-slack-deprecated.md b/website/docs/how-to/how-to-send-feature-updates-to-slack-deprecated.md index f80f35ca7f..00500fd9b0 100644 --- a/website/docs/how-to/how-to-send-feature-updates-to-slack-deprecated.md +++ b/website/docs/how-to/how-to-send-feature-updates-to-slack-deprecated.md @@ -4,7 +4,7 @@ title: Feature Updates To slack :::caution -This guide is deprecated. If you're looking for ways to integrate with Slack, you should refer to [the Slack add-on guide](../reference/addons/slack.md) instead. +This guide is deprecated. If you're looking for ways to integrate with Slack, you should refer to [the Slack integration guide](../reference/integrations/slack.md) instead. Event hook option is removed in Unleash v5 diff --git a/website/docs/reference/addons/addons.md b/website/docs/reference/addons/addons.md deleted file mode 100644 index 9402d20e3b..0000000000 --- a/website/docs/reference/addons/addons.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: index -title: Addons ---- - -> This feature was introduced in _Unleash v3.11.0_. - -Unleash Addons allows you to extend Unleash with new functionality. Currently, addons allow you to listen to changes in Unleash and trigger updates in other systems, typical via a WebHook. - -Currently Unleash support the following Addons 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 addons. - -### Notes {#notes} - -When updating or creating a new addon configuration it can take up to one minute before Unleash picks up the new config on all instances due to caching. diff --git a/website/docs/reference/api/legacy/unleash/admin/addons.md b/website/docs/reference/api/legacy/unleash/admin/addons.md index 5682893ecc..db279d9ca6 100644 --- a/website/docs/reference/api/legacy/unleash/admin/addons.md +++ b/website/docs/reference/api/legacy/unleash/admin/addons.md @@ -4,11 +4,11 @@ title: /api/admin/addons > In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. -### List addons and providers {#list-addons-and-providers} +### List integrations and providers {#list-integrations-and-providers} `GET https://unleash.host.com/api/admin/addons` -Returns a list of _configured addons_ and available _addon providers_. +Returns a list of _configured integrations_ and available _integration providers_. **Example response:** @@ -92,7 +92,7 @@ Returns a list of _configured addons_ and available _addon providers_. "tags": [ { "name": "slack", - "description": "Slack tag used by the slack-addon to specify the slack channel.", + "description": "Slack tag used by the slack integration to specify the slack channel.", "icon": "S" } ] @@ -101,11 +101,11 @@ Returns a list of _configured addons_ and available _addon providers_. } ``` -### Create a new addon configuration {#create-a-new-addon-configuration} +### Create a new integration configuration {#create-a-new-integration-configuration} `POST https://unleash.host.com/api/addons` -Creates an addon configuration for an addon provider. +Creates an integration configuration for an integration provider. **Body** @@ -123,13 +123,13 @@ Creates an addon configuration for an addon provider. ### Notes {#notes} -- `provider` must be a valid addon provider +- `provider` must be a valid integration provider -### Update new addon configuration {#update-new-addon-configuration} +### Update new integration configuration {#update-new-integration-configuration} `POST https://unleash.host.com/api/addons/:id` -Updates an addon configuration. +Updates an integration configuration. **Body** @@ -149,8 +149,8 @@ Updates an addon configuration. - `provider` can not be changed. -### Delete an addon configuration {#delete-an-addon-configuration} +### Delete an integration configuration {#delete-an-integration-configuration} `DELETE https://unleash.host.com/api/admin/addons/:id` -Deletes the addon with id=`id`. +Deletes the integration with id=`id`. diff --git a/website/docs/reference/deploy/configuring-unleash.md b/website/docs/reference/deploy/configuring-unleash.md index c842dc2ec7..fa3028b2c6 100644 --- a/website/docs/reference/deploy/configuring-unleash.md +++ b/website/docs/reference/deploy/configuring-unleash.md @@ -20,7 +20,7 @@ In order for Unleash server to work, you need a running database and its connect - Used to create - Reset password URLs - Welcome link for new users - - Links in events for our Slack, Microsoft Teams and Datadog addons + - Links in events for our Slack, Microsoft Teams and Datadog integrations ### Email server details {#email-server-details} @@ -95,7 +95,7 @@ unleash.start(unleashOptions); - `sender` - Which email should be set as sender of mails being sent from Unleash? - `smtpuser` - Username for your SMTP server - `smtppass` - Password for your SMTP server -- ~~eventHook~~ (`function(event, data)`) - (_deprecated in Unleash 4.3_ in favor of the [Webhook addon](../addons/webhook.md). **Removed in Unleash 5**) If provided, this function will be invoked whenever a feature is mutated. The possible values for `event` are `'feature-created'`, `'feature-archived'` and `'feature-revived'`. The `data` argument contains information about the mutation. Its fields are `type` (string) - the event type (same as `event`); `createdBy` (string) - the user who performed the mutation; `data` - the contents of the change. The contents in `data` differs based on the event type; For `'feature-archived'` and `'feature-revived'`, the only field will be `name` - the name of the feature. For `'feature-created'` the data follows a schema defined in the code [here](https://github.com/Unleash/unleash/blob/7b7f0b84e8cddd5880dcf29c231672113224b9a7/src/lib/schema/feature-schema.ts#L77). See an [api here](/reference/api/legacy/unleash/admin/events). +- ~~eventHook~~ (`function(event, data)`) - (_deprecated in Unleash 4.3_ in favor of the [Webhook integration](../integrations/webhook.md). **Removed in Unleash 5**) If provided, this function will be invoked whenever a feature is mutated. The possible values for `event` are `'feature-created'`, `'feature-archived'` and `'feature-revived'`. The `data` argument contains information about the mutation. Its fields are `type` (string) - the event type (same as `event`); `createdBy` (string) - the user who performed the mutation; `data` - the contents of the change. The contents in `data` differs based on the event type; For `'feature-archived'` and `'feature-revived'`, the only field will be `name` - the name of the feature. For `'feature-created'` the data follows a schema defined in the code [here](https://github.com/Unleash/unleash/blob/7b7f0b84e8cddd5880dcf29c231672113224b9a7/src/lib/schema/feature-schema.ts#L77). See an [api here](/reference/api/legacy/unleash/admin/events). - **getLogger** (function) - Used to register a [custom log provider](#how-do-i-configure-the-log-output). - **logLevel** (`debug` | `info` | `warn` | `error` | `fatal`) - The lowest level to log at, also configurable using environment variable `LOG_LEVEL`. - **enableRequestLogger** (boolean) - use this to enable logging for requested urls and response codes (default: false). @@ -356,7 +356,7 @@ Unleash builds directly on the [node-postgres library](https://node-postgres.com ### Proxying requests from Unleash -You can configure proxy services that intercept all outgoing requests from Unleash. This lets you use the Microsoft Teams or the Webhook addon for external services, even if the internet can only be reached via a proxy on your machine or container (for example if restricted by a firewall or similiar). +You can configure proxy services that intercept all outgoing requests from Unleash. This lets you use the Microsoft Teams or the Webhook integration for external services, even if the internet can only be reached via a proxy on your machine or container (for example if restricted by a firewall or similiar). As an example, here's how you could do it using the [node-global-proxy](https://www.npmjs.com/package/node-global-proxy) package: @@ -371,6 +371,6 @@ proxy.setConfig({ proxy.start(); //this starts the proxy, after this call all requests will be proxied ``` -Using above code-snippet, every outgoing request from unleash or its addons will be subsequently routed through set proxy. If the proxy routing needs to be bypassed or stopped, its possible to stop it by using +Using above code-snippet, every outgoing request from unleash or its integrations will be subsequently routed through set proxy. If the proxy routing needs to be bypassed or stopped, its possible to stop it by using `proxy.stop();` diff --git a/website/docs/reference/environments.md b/website/docs/reference/environments.md index 11e568e9a9..4ab780376d 100644 --- a/website/docs/reference/environments.md +++ b/website/docs/reference/environments.md @@ -100,11 +100,11 @@ If you're currently using strategy constraints together with the “environment ![A strategy constraint using the environment field of the unleash context.](/img/environments_strategy_constraints.png 'You will not use strategy constraints for environments any more.') -### Addons +### Integrations We have made some slight changes to events related to feature toggles: there's one deprecation and several new event types. Most of the new events contain _project_ and _environment_ data. -To avoid missing important updates, you will also need to update your addon configuration to subscribe to the new events. +To avoid missing important updates, you will also need to update your integration configuration to subscribe to the new events. **Deprecated events:** diff --git a/website/docs/reference/event-types.mdx b/website/docs/reference/event-types.mdx index 5260c6072c..08fcc63b5f 100644 --- a/website/docs/reference/event-types.mdx +++ b/website/docs/reference/event-types.mdx @@ -1171,11 +1171,11 @@ This event fires when you drop all existing tag types as part of a configuration } ``` -## Addon events +## Integration events ### `addon-config-created` -This event fires when you create an addon configuration. The `data` property contains the provider type. +This event fires when you create an integration configuration. The `data` property contains the provider type. ```json title="example event: addon-config-created" { @@ -1196,7 +1196,7 @@ This event fires when you create an addon configuration. The `data` property con ### `addon-config-updated` -This event fires when you update an addon configuration. The `data` property contains the addon's ID and provider type. +This event fires when you update an integration configuration. The `data` property contains the integration's ID and provider type. ```json title="example event: addon-config-updated" { @@ -1218,7 +1218,7 @@ This event fires when you update an addon configuration. The `data` property con ### `addon-config-deleted` -This event fires when you update an addon configuration. The `data` property contains the addon's ID. +This event fires when you update an integration configuration. The `data` property contains the integration's ID. ```json title="example event: addon-config-deleted" { diff --git a/website/docs/reference/feature-toggle-types.md b/website/docs/reference/feature-toggle-types.md index fabe371152..aca086dcff 100644 --- a/website/docs/reference/feature-toggle-types.md +++ b/website/docs/reference/feature-toggle-types.md @@ -48,7 +48,7 @@ Unleash admins can change the expected lifetime of Unleash's feature types from You can mark feature toggles as `stale`. This is a way to deprecate a feature toggle without removing the active configuration for connected applications. Use this to signal that you should stop using the feature in your applications. Stale toggles will show as stale in the ["technical debt dashboard"](technical-debt.md). -When you mark a toggle as stale, Unleash will emit an event. You can use [an addon](addons/addons.md) to integrate this with your systems, for instance to post a message in a Slack channel. +When you mark a toggle as stale, Unleash will emit an event. You can use [an integration](integrations/integrations.md) to integrate this with your systems, for instance to post a message in a Slack channel. Additionally, with some extra work, you can also use the `stale` property to: diff --git a/website/docs/reference/addons/datadog.md b/website/docs/reference/integrations/datadog.md similarity index 64% rename from website/docs/reference/addons/datadog.md rename to website/docs/reference/integrations/datadog.md index 247ac60d32..1ce1eaf66f 100644 --- a/website/docs/reference/addons/datadog.md +++ b/website/docs/reference/integrations/datadog.md @@ -5,9 +5,9 @@ title: Datadog > This feature was introduced in _Unleash v4.0.0_. -The Datadog addon allows Unleash to post Updates to Datadog when a feature toggle is updated. To set up this addon, you need to set up a webhook connector for your channel. You can follow [Submitting events to Datadog](https://docs.datadoghq.com/api/latest/events/#post-an-event) on how to do that. +The Datadog integration allows Unleash to post Updates to Datadog when a feature toggle is updated. To set up this integration, you need to set up a webhook connector for your channel. You can follow [Submitting events to Datadog](https://docs.datadoghq.com/api/latest/events/#post-an-event) on how to do that. -The Datadog addon will perform a single retry if the HTTP POST against the Datadog Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order. +The Datadog integration will perform a single retry if the HTTP POST against the Datadog Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order. ## Configuration {#configuration} @@ -33,7 +33,7 @@ You can choose to trigger updates for the following events: #### Parameters {#parameters} -Unleash Datadog addon takes the following parameters. +Unleash Datadog integration takes the following parameters. - **Datadog Events URL** - This property is optional. The default url is https://api.datadoghq.com/api/v1/events. Needs to be changed if you are not not on the US1 [Datadog site](https://docs.datadoghq.com/getting_started/site/). Possible alternatives: - EU: https://app.datadoghq.eu/api/v1/events @@ -44,4 +44,4 @@ Unleash Datadog addon takes the following parameters. #### Tags {#tags} -Datadog's incoming webhooks are app specific. You will be able to create multiple addons to support messaging on different apps. +Datadog's incoming webhooks are app specific. You will be able to create multiple integrations to support messaging on different apps. diff --git a/website/docs/reference/integrations/integrations.md b/website/docs/reference/integrations/integrations.md index 888a227220..9cfece40b0 100644 --- a/website/docs/reference/integrations/integrations.md +++ b/website/docs/reference/integrations/integrations.md @@ -1,23 +1,50 @@ --- -id: integrations -title: External Integrations and plugins +id: index +title: Integrations --- import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; +:::info Availability -Unleash can also integrate with other systems in different ways. +Unleash integrations were introduced in _Unleash v3.11.0_. + +Integrations were previously 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 provides these 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-contributed integrations: +:::tip Missing an integration? Request it! + +If you're looking for an integration that Unleash doesn't have at the moment, you can fill out this [integration request form](https://docs.google.com/forms/d/e/1FAIpQLScR1_iuoQiKq89c0TKtj0gM02JVWyQ2hQ-YchBMc2GRrGf7uw/viewform) to register it with us. + +::: + +## Community integrations Our wonderful community has also created the following integrations: -- [Vue Unleash plugin](https://github.com/crishellco/vue-unleash) -- [Quarkus](https://github.com/quarkiverse/quarkus-unleash) - [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 + + diff --git a/website/docs/reference/addons/slack.md b/website/docs/reference/integrations/slack.md similarity index 64% rename from website/docs/reference/addons/slack.md rename to website/docs/reference/integrations/slack.md index 60f89f0427..4e2aa4c511 100644 --- a/website/docs/reference/addons/slack.md +++ b/website/docs/reference/integrations/slack.md @@ -5,9 +5,9 @@ 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 integration 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. +The Slack integration 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} @@ -33,7 +33,7 @@ You can choose to trigger updates for the following events: #### Parameters {#parameters} -Unleash Slack addon takes the following parameters. +Unleash Slack integration 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. @@ -46,7 +46,7 @@ Unleash Slack addon takes the following parameters. #### 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. +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. ![Slack Tags](/img/slack_addon_tags.png) diff --git a/website/docs/reference/addons/teams.md b/website/docs/reference/integrations/teams.md similarity index 50% rename from website/docs/reference/addons/teams.md rename to website/docs/reference/integrations/teams.md index cef5e075a7..e9ec00366c 100644 --- a/website/docs/reference/addons/teams.md +++ b/website/docs/reference/integrations/teams.md @@ -5,9 +5,9 @@ title: Microsoft Teams > This feature was introduced in _Unleash v4.0.0_. -The Microsoft Teams addon allows Unleash to post Updates when a feature toggle is updated. To set up this addon, you need to set up a webhook connector for your channel. You can follow [Creating an Incoming Webhook for a channel](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) on how to do that. +The MicrosoftTeams integration allows Unleash to post Updates when a feature toggle is updated. To set up this integration, you need to set up a webhook connector for your channel. You can follow [Creating an Incoming Webhook for a channel](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) on how to do that. -The Microsoft Teams addon will perform a single retry if the HTTP POST against the Microsoft Teams Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order. +The Microsoft Teams integration will perform a single retry if the HTTP POST against the Microsoft Teams Webhook URL fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order. ## Configuration {#configuration} @@ -33,10 +33,10 @@ You can choose to trigger updates for the following events: #### Parameters {#parameters} -Unleash Microsoft Teams addon takes the following parameters. +Unleash Microsoft Teams integration takes the following parameters. - **Microsoft Teams Webhook URL** - This is the only required property. #### Tags {#tags} -Microsoft teams's incoming webhooks are channel specific. You will be able to create multiple addons to support messaging on multiple channels. +Microsoft teams's incoming webhooks are channel specific. You will be able to create multiple integrations to support messaging on multiple channels. diff --git a/website/docs/reference/addons/webhook.md b/website/docs/reference/integrations/webhook.md similarity index 88% rename from website/docs/reference/addons/webhook.md rename to website/docs/reference/integrations/webhook.md index 0e0a334a7f..45a2d7cf95 100644 --- a/website/docs/reference/addons/webhook.md +++ b/website/docs/reference/integrations/webhook.md @@ -5,7 +5,7 @@ title: Webhook > This feature was introduced in _Unleash v3.11.0_. -The Webhook Addon introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens for changes in Unleash and posts them to a third party services. +The Webhook Integration introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens changes in Unleash and post them to a third party services. The webhook will perform a single retry if the HTTP POST call fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order. @@ -33,7 +33,7 @@ You can choose to trigger updates for the following events (we might add more ev #### Parameters {#parameters} -Unleash Webhook addon takes the following parameters. +Unleash Webhook integration takes the following parameters. **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 the channel you want to post to. diff --git a/website/docs/reference/rbac.md b/website/docs/reference/rbac.md index 144d347406..fce8d3382d 100644 --- a/website/docs/reference/rbac.md +++ b/website/docs/reference/rbac.md @@ -12,7 +12,7 @@ Unleash has two levels in its hierarchy of resources: 1. **Root resources** - Everything that lives across the entire Unleash instance. Examples of this include: - activation strategies - context field definitions - - addon configurations + - integration configurations - applications - users 2. **Project resources** - Resources which are only available under a project. Today this is only “feature toggles” (but we expect more resources to live under a project in the future). A feature toggle will belong to only one single project. In Unleash-Open source there exists only a single project, the “default” project, while Unleash Enterprise supports multiple projects. @@ -55,37 +55,37 @@ Each custom root role consists of: You can assign the following root permissions: -#### Addon permissions +#### Integration permissions -| Permission Name | Description | -|-----------------------|-----------------------------------| -| Create addons | Lets the user create addons. | -| Update addons | Lets the user update addons. | -| Delete addons | Lets the user delete addons. | +| Permission Name | Description | +|---------------------|------------------------------------| +| Create integrations | Lets the user create integrations. | +| Update integrations | Lets the user update integrations. | +| Delete integrations | Lets the user delete integrations. | #### API token permissions -| Permission Name | Description | -|-----------------------|-----------------------------------| -| Read frontend API tokens | Lets the user read frontend API tokens. | +| Permission Name | Description | +|----------------------------|-------------------------------------------| +| Read frontend API tokens | Lets the user read frontend API tokens. | | Create frontend API tokens | Lets the user create frontend API tokens. | | Update frontend API tokens | Lets the user update frontend API tokens. | | Delete frontend API tokens | Lets the user delete frontend API tokens. | -| Read client API tokens | Lets the user read client API tokens. | -| Create client API tokens | Lets the user create client API tokens. | -| Update client API tokens | Lets the user update client API tokens. | -| Delete client API tokens | Lets the user delete client API tokens. | +| Read client API tokens | Lets the user read client API tokens. | +| Create client API tokens | Lets the user create client API tokens. | +| Update client API tokens | Lets the user update client API tokens. | +| Delete client API tokens | Lets the user delete client API tokens. | #### Application permissions -| Permission Name | Description | -|-----------------------|-----------------------------------| -| Update applications | Lets the user update applications. | +| Permission Name | Description | +|---------------------|------------------------------------| +| Update applications | Lets the user update applications. | #### Context field permissions -| Permission Name | Description | -|-----------------------|-----------------------------------| +| Permission Name | Description | +|-----------------------|--------------------------------------| | Create context fields | Lets the user create context fields. | | Update context fields | Lets the user update context fields. | | Delete context fields | Lets the user delete context fields. | diff --git a/website/docs/reference/whats-new-v4.md b/website/docs/reference/whats-new-v4.md index 84416ad51f..5fa72da67c 100644 --- a/website/docs/reference/whats-new-v4.md +++ b/website/docs/reference/whats-new-v4.md @@ -21,12 +21,12 @@ With Role-Based Access Control you can now assign groups to users in order to co [Read more](rbac.md) -### New Addons {#new-addons} +### New Integrations {#new-integrations} -Addons make it easy to integrate Unleash with other systems. In version 4 we bring two new integrations to Unleash: +Integrations make it easy to integrate Unleash with other systems. In version 4 we bring two new integrations to Unleash: -- [Microsoft Teams](../reference/addons/teams.md) -- [Datadog](../reference/addons/datadog.md) +- [Microsoft Teams](../reference/integrations/teams.md) +- [Datadog](../reference/integrations/datadog.md) ### Improved UX {#improved-ux} diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index eb613be063..e475fac406 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -328,24 +328,24 @@ module.exports = { to: '/reference/deploy/securing-unleash-v3', }, { - from: '/addons', - to: '/reference/addons', + from: ['/addons', '/reference/addons'], + to: '/reference/integrations', }, { - from: '/addons/datadog', - to: '/reference/addons/datadog', + from: ['/addons/datadog', '/reference/addons/datadog'], + to: '/reference/integrations/datadog', }, { - from: '/addons/slack', - to: '/reference/addons/slack', + from: ['/addons/slack', '/reference/addons/slack'], + to: '/reference/integrations/slack', }, { - from: '/addons/teams', - to: '/reference/addons/teams', + from: ['/addons/teams', '/reference/addons/teams'], + to: '/reference/integrations/teams', }, { - from: '/addons/webhook', - to: '/reference/addons/webhook', + from: ['/addons/webhook', '/reference/addons/webhook'], + to: '/reference/integrations/webhook', }, { from: '/guides/feature_updates_to_slack', diff --git a/website/sidebars.js b/website/sidebars.js index 3c4b2d8dab..3a38a2c21f 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -185,17 +185,6 @@ module.exports = { slug: '/reference', }, items: [ - { - type: 'category', - link: { type: 'doc', id: 'reference/addons/index' }, - items: [ - 'reference/addons/datadog', - 'reference/addons/slack', - 'reference/addons/teams', - 'reference/addons/webhook', - ], - label: 'Addons', - }, { type: 'category', label: 'APIs', @@ -309,12 +298,9 @@ module.exports = { }, { type: 'category', - label: 'Integrations', - link: { - type: 'doc', - id: 'reference/integrations/integrations', - }, + link: { type: 'doc', id: 'reference/integrations/index' }, items: [ + 'reference/integrations/datadog', { 'Jira Server': [ 'reference/integrations/jira-server-plugin-installation', @@ -325,8 +311,11 @@ module.exports = { 'reference/integrations/jira-cloud-plugin-usage', ], }, - , + 'reference/integrations/slack', + 'reference/integrations/teams', + 'reference/integrations/webhook', ], + label: 'Integrations', }, { type: 'category',