mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-05 17:53:12 +02:00
Remove banners and adding users how-to guides
This commit is contained in:
melindafekete
parent
0c9c573d1a
commit
d2f7bb7082
@ -6,7 +6,7 @@ import ApiRequest from "@site/src/components/ApiRequest";
|
||||
import VideoContent from "@site/src/components/VideoContent.jsx";
|
||||
|
||||
|
||||
Unleash allows you to gather [impression data](../reference/impression-data) from your feature flags, giving you complete visibility into who checked what flags and when. What you do with this data is entirely up to you, but a common use case is to send it off to an aggregation and analytics service such as [Posthog](https://posthog.com/) or [Google Analytics](https://analytics.google.com/), either just for monitoring purposes or to facilitate [A/B testing](../feature-flag-tutorials/use-cases/a-b-testing).
|
||||
Unleash allows you to gather [impression data](/reference/impression-data) from your feature flags, giving you complete visibility into who checked what flags and when. What you do with this data is entirely up to you, but a common use case is to send it off to an aggregation and analytics service such as [Posthog](https://posthog.com/) or [Google Analytics](https://analytics.google.com/), either just for monitoring purposes or to facilitate [A/B testing](/feature-flag-tutorials/use-cases/a-b-testing).
|
||||
|
||||
This guide will take you through everything you need to do in Unleash to facilitate such a workflow. It will show you how to send data to Posthog as an example sink, but the exact same principles will apply to any other service of the same kind.
|
||||
|
||||
@ -19,7 +19,7 @@ We will assume that you have the necessary details for your third-party service:
|
||||
- **where to send the data to**. We'll refer to this in the code samples below as **`<sink-url>`**.
|
||||
- **what format the data needs to be in**. This will determine how you transform the event data before you send it.
|
||||
|
||||
In addition, you'll need to have a flag to record impression data for and an [Unleash client SDK](../reference/sdks) that supports impression data. This guide will use the [JavaScript proxy SDK](/reference/sdks/javascript-browser).
|
||||
In addition, you'll need to have a flag to record impression data for and an [Unleash client SDK](/reference/sdks) that supports impression data. This guide will use the [JavaScript proxy SDK](/reference/sdks/javascript-browser).
|
||||
|
||||
When you have those things sorted, follow the below steps.
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: How to add SSO with SAML 2.0 and Microsoft Entra ID
|
||||
title: SAML 2.0 with Microsoft Entra ID
|
||||
description: 'Configure Microsoft Entra ID SSO with SAML 2.0 for your Unleash instance.'
|
||||
---
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: 'How to add SSO with Google'
|
||||
title: 'Google'
|
||||
description: Set up SSO for Unleash with Google.
|
||||
---
|
||||
|
||||
:::caution Deprecation notice
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: How to add SSO with OpenID Connect
|
||||
title: OpenID Connect
|
||||
description: Set up SSO for Unleash with OpenID Connect.
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: How to add SSO with SAML 2.0 Keycloak
|
||||
title: SAML 2.0 with Keycloak
|
||||
description: Set up SSO for Unleash with SAML 2.0 and Keycloak.
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: How to add SSO with SAML 2.0 Okta
|
||||
title: SAML 2.0 with Okta
|
||||
description: Set up SSO for Unleash with SAML 2.0 and Okta.
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
title: How to add new users to your Unleash instance
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.0+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
You can add new users to Unleash in `Admin > Users`.
|
||||
|
||||
1. From the top-line menu – click on the “Settings Wheel” then click on “Users”.
|
||||
|
||||
|
||||
|
||||
2. To add a new user to your Unleash instance, use the "new user" button:
|
||||
|
||||
|
||||
3. Fill out the required fields in the "create user" form. Refer to the [predefined roles overview](../reference/rbac.md#predefined-roles) for more information on roles.
|
||||
|
||||
|
||||
|
||||
If you have configured an email server the user will receive the invite link in her inbox, otherwise you should share the magic invite link to Unleash presented in the confirmation dialogue.
|
||||
@ -1,44 +0,0 @@
|
||||
---
|
||||
title: How to create and display banners
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
|
||||
|
||||
:::
|
||||
|
||||
|
||||
This guide takes you through [how to create](#creating-banners "how to create banners") and [display](#displaying-banners "how to display banners") [banners](../reference/banners.md).
|
||||
|
||||
## Creating banners
|
||||
|
||||
### Step 1: Navigate to the banners page {#create-step-1}
|
||||
|
||||
Navigate to the _banners_ page in the admin UI (available at the URL `/admin/banners`). Use the _settings_ button in the navigation menu and select "banners".
|
||||
|
||||
|
||||
|
||||
### Step 2: Use the "new banner" button {#create-step-2}
|
||||
|
||||
Use the "new banner" button to open the "new banner" form.
|
||||
|
||||
|
||||
|
||||
### Step 3: Fill in the banner form {#create-step-3}
|
||||
|
||||
Choose whether the banner should be enabled right away. If enabled, the banner will be visible to all users in your Unleash instance. Select the banner type, icon, and write the message that you'd like to see displayed on the banner. The message and dialog fields support [Markdown](https://www.markdownguide.org/basic-syntax/). Optionally, you can also configure a banner action for user interactivity. For a full overview of all the banner options, consult the [banners reference documentation](../reference/banners).
|
||||
|
||||
You'll be able to preview the banner at the top as you fill in the form.
|
||||
|
||||
Once you're satisfied, use the "add banner" button to create the banner.
|
||||
|
||||
|
||||
|
||||
## Displaying banners
|
||||
|
||||
You can choose whether a banner is currently displayed to all users of your Unleash instance by toggling the "enabled" switch on the banner table.
|
||||
|
||||
Alternatively, you can edit the banner by using the "edit" button on the banner table and then toggle the "banner status" switch.
|
||||
|
||||
|
||||
@ -8,78 +8,61 @@ title: Banners
|
||||
|
||||
:::
|
||||
|
||||
Banners allow you to configure and display internal messages that all users of your Unleash instance can see and interact with. They are displayed at the top of the Unleash UI, and can be configured to be interactive.
|
||||
Banners allow you to configure and display instance-wide messages to all users of your Unleash instance. These messages appear at the top of the Unleash UI and can be configured to be interactive.
|
||||
|
||||
|
||||
|
||||
A common use case could be to have some pre-configured banners that you can enable when you need to communicate something to your users. For example, you could have a banner that you enable when you're doing maintenance on your Unleash instance, and another banner that you enable when you're running a survey.
|
||||
A common use case for banners is to pre-configure messages that you can enable when needed. For example, you might have a banner for scheduled maintenance or another to announce a user survey.
|
||||
|
||||
In order to create and display a banner, you can follow the [how to create and display banners](../how-to/how-to-create-and-display-banners.md) guide.
|
||||
Banners can be enabled or disabled at any time.
|
||||
|
||||
## Banner status
|
||||
## Create a banner
|
||||
|
||||
Banners can be enabled or disabled at any time. For more information on how to enable or disable a banner, see the section on [displaying banners](../how-to/how-to-create-and-display-banners.md#displaying-banners).
|
||||
To create a banner in the Admin UI, do the following:
|
||||
1. Go to **Admin settings > Instance config > Banners**.
|
||||
2. Click **New banner**.
|
||||
3. Configure the status, type, icon, message, action, and whether the banner should be sticky.
|
||||
4. Click **Add banner**.
|
||||
|
||||
| Option | Description |
|
||||
| ----------- | -------------------------------------------------------------------------------- |
|
||||
| **Enabled** | Whether the banner is currently displayed to all users of your Unleash instance. |
|
||||
Once created, if the banner's status is set to enabled, the banner is immediately visible to all users in your Unleash instance.
|
||||
|
||||
## Configuration
|
||||
## Configure the banner
|
||||
|
||||
Banners can be configured with the following options:
|
||||
| Option | Description | Values / Format |
|
||||
| :------ | :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------ |
|
||||
| Type | Sets the banner's style (color and default icon). | `Information`, `Warning`, `Error`, `Success` |
|
||||
| Status | Whether the banner is enabled and showing for all users of the instance. | Enabled or disabled |
|
||||
| Icon | Icon displayed on the banner. | `Default` (matches banner type), `None` (hidden), `Custom` ([custom icon](#use-a-custom-icon)) |
|
||||
| Message | Main text content of the banner. | Text format; supports [Markdown](https://www.markdownguide.org/basic-syntax/) |
|
||||
| Action | Adds interactivity to the banner using a link or a dialog. | `None`, `Link`, `Dialog` |
|
||||
| Sticky | Whether the banner remains fixed at the top of the Unleash UI, even when users scroll the page. | Enabled or disabled |
|
||||
|
||||
| Option | Description |
|
||||
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Type** | The type of banner, which controls the banner's color and its icon, if using the default icon option. |
|
||||
| **Icon** | The icon displayed on the banner. This can be the default for the banner type, a [custom icon](#custom-icon), or hidden by selecting "None". |
|
||||
| **Message** | The banner's message. Supports [Markdown](https://www.markdownguide.org/basic-syntax/). |
|
||||
### Use a custom icon
|
||||
|
||||
### Custom icon
|
||||
To further personalize your banner, you can use any icon from the [Material Symbols](https://fonts.google.com/icons) library.
|
||||
|
||||
To further personalize your banner, you can configure it with a custom icon.
|
||||
To use a custom icon:
|
||||
1. In the banner configuration, select **Custom** from the **Icon** dropdown menu.
|
||||
2. In the **Banner icon** field, enter the name of the desired Material Symbol. For example, to use the "Rocket Launch" icon, enter `rocket_launch`.
|
||||
|
||||
To use a custom icon in your banner:
|
||||
1. Select "Custom" in the icon dropdown.
|
||||
2. Enter the name of the desired [Material Symbol](https://fonts.google.com/icons).
|
||||
- For example, for the "Rocket Launch" icon, enter `rocket_launch` in the custom icon field.
|
||||
### Configure a link action
|
||||
|
||||
| Option | Description |
|
||||
| --------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| **Custom icon** | The custom icon to be displayed on the banner, using [Material Symbols](https://fonts.google.com/icons). |
|
||||
This action displays a link on the banner that directs users to a specified URL.
|
||||
|
||||
## Banner action
|
||||
- **Absolute URLs** (for example, `https://docs.getunleash.io/`) open in a new browser tab.
|
||||
- **Relative URLs** (for example, `/admin/network`) open in the same tab.
|
||||
|
||||
You can set up an action for your banner:
|
||||
| Option | Description |
|
||||
| :----- | :---------------------------------------------- |
|
||||
| URL | The URL the banner link should navigate to. |
|
||||
| Text | The text displayed for the link on the banner. |
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Banner action** | The action activated when a user interacts with the banner link. Defaults to "None". Options include a [link](#link) or a [dialog](#dialog). |
|
||||
### Configure a dialog action
|
||||
|
||||
### Link
|
||||
This action displays a link on the banner that, when clicked, opens a dialog box with additional information.
|
||||
|
||||
When choosing the link action, a link will be displayed on the banner that directs users to a specified URL.
|
||||
|
||||
The configured URL can be absolute, as in e.g. `https://docs.getunleash.io/`, or relative as in e.g. `/admin/network`. Absolute URLs will open in a new tab.
|
||||
|
||||
| Option | Description |
|
||||
| -------- | --------------------------------------------------------- |
|
||||
| **URL** | The URL to open when the user uses the banner link. |
|
||||
| **Text** | The text to display on the banner link. |
|
||||
|
||||
### Dialog
|
||||
|
||||
When opting for a dialog action, an interactable link appears on the banner which opens a dialog with additional information.
|
||||
|
||||
| Option | Description |
|
||||
| ------------------ | ------------------------------------------------------------------------------------------------------- |
|
||||
| **Text** | The text to display on the banner link. |
|
||||
| **Dialog title** | The title to display on the dialog. |
|
||||
| **Dialog content** | The content to display on the dialog. Supports [Markdown](https://www.markdownguide.org/basic-syntax/). |
|
||||
|
||||
## Sticky banner
|
||||
|
||||
For added visibility, banners can be configured to be "sticky," ensuring they remain at the top of the Unleash UI, even after scrolling the page. This is useful for banners that you want to make sure that your users see and interact with.
|
||||
|
||||
| Option | Description |
|
||||
| ---------- | ---------------------------------------------------------- |
|
||||
| **Sticky** | Whether the banner is sticky on the screen when scrolling. |
|
||||
| Option | Description |
|
||||
| :--------------- | :-------------------------------------------------------------------------- |
|
||||
| Text | The text displayed for the link on the banner. |
|
||||
| Dialog title | The title displayed at the top of the dialog box. |
|
||||
| Dialog content | The main content displayed within the dialog box. Supports [Markdown](https://www.markdownguide.org/basic-syntax/). |
|
||||
|
||||
@ -17,7 +17,7 @@ See our how to guides on setting up provisioning for [Okta](../how-to/how-to-set
|
||||
|
||||
**Deprovisioning**
|
||||
|
||||
Deprovisioning can be setup on the provider side and allow for automatic clean up of users in a single place. This is especially useful if you're trying to manage the cost of your Unleash instance, since deprovisioned users will not count towards the seat count of your license. See our [how to guides](../how-to/provisioning) for specific provider configurations.
|
||||
Deprovisioning can be setup on the provider side and allow for automatic clean up of users in a single place. This is especially useful if you're trying to manage the cost of your Unleash instance, since deprovisioned users will not count towards the seat count of your license.
|
||||
|
||||
**Group syncing**
|
||||
|
||||
|
||||
@ -503,22 +503,6 @@ class="header-github-link"
|
||||
from: '/advanced/stickiness',
|
||||
to: '/reference/stickiness',
|
||||
},
|
||||
{
|
||||
from: '/advanced/sso-google',
|
||||
to: '/how-to/how-to-add-sso-google',
|
||||
},
|
||||
{
|
||||
from: '/advanced/sso-open-id-connect',
|
||||
to: '/how-to/how-to-add-sso-open-id-connect',
|
||||
},
|
||||
{
|
||||
from: '/advanced/sso-saml-keycloak',
|
||||
to: '/how-to/how-to-add-sso-saml-keycloak',
|
||||
},
|
||||
{
|
||||
from: '/advanced/sso-saml',
|
||||
to: '/how-to/how-to-add-sso-saml',
|
||||
},
|
||||
{
|
||||
from: '/advanced/enterprise-authentication',
|
||||
to: '/reference/sso',
|
||||
@ -675,10 +659,6 @@ class="header-github-link"
|
||||
from: '/user_guide/unleash_context',
|
||||
to: '/reference/unleash-context',
|
||||
},
|
||||
{
|
||||
from: '/user_guide/user-management',
|
||||
to: '/how-to/how-to-add-users-to-unleash',
|
||||
},
|
||||
{
|
||||
from: '/user_guide/v4-whats-new',
|
||||
to: '/reference/whats-new-v4',
|
||||
|
||||
@ -682,7 +682,6 @@ const sidebars: SidebarsConfig = {
|
||||
},
|
||||
items: [
|
||||
'how-to/how-to-create-feature-toggles',
|
||||
'how-to/how-to-create-and-display-banners',
|
||||
'how-to/how-to-schedule-feature-releases',
|
||||
'how-to/how-to-synchronize-unleash-instances',
|
||||
],
|
||||
@ -701,7 +700,6 @@ const sidebars: SidebarsConfig = {
|
||||
{
|
||||
label: 'Users and permissions',
|
||||
items: [
|
||||
'how-to/how-to-add-users-to-unleash',
|
||||
'how-to/how-to-create-and-manage-user-groups',
|
||||
'how-to/how-to-set-up-group-sso-sync',
|
||||
],
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 139 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 190 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 201 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
@ -131,11 +131,21 @@
|
||||
"destination": "/reference/feature-toggles#set-a-naming-pattern",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-add-users-to-unleash",
|
||||
"destination": "/reference/rbac",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-clone-environments",
|
||||
"destination": "/reference/environments#clone-an-environment",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to-create-and-display-banners",
|
||||
"destination": "/reference/banners",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/toggle_variants",
|
||||
"destination": "/reference/feature-toggle-variants",
|
||||
@ -461,11 +471,6 @@
|
||||
"destination": "/reference/unleash-context",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/user_guide/user-management",
|
||||
"destination": "/how-to/how-to-add-users-to-unleash",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/user_guide/v4-whats-new",
|
||||
"destination": "/reference/whats-new-v4",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user