mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-10 17:53:36 +02:00
docs: prioritize search results (#10369)
This commit is contained in:
parent
2ff1aa78a0
commit
253c2d71b3
@ -49,6 +49,26 @@ rm -rf yarn.lock
|
||||
touch yarn.lock
|
||||
```
|
||||
|
||||
## Search
|
||||
|
||||
This website uses Algolia DocSearch v3 with a dedicated Algolia application and a hosted crawler. All configuration is managed directly through the Algolia dashboard.
|
||||
|
||||
### Search prioritization
|
||||
|
||||
Conceptual and reference documentation pages should rank over specific API endpoints, while still allowing Algolia's relevance algorithm to find the most accurate results.
|
||||
|
||||
#### The configuration
|
||||
|
||||
**Inside the Algolia crawler**:
|
||||
The crawler configuration has been updated to look for a <meta name="search_priority" content="..." /> tag in the HTML of each page.
|
||||
It extracts the numerical value and saves it as a priority attribute on the search record. Pages without this tag are automatically assigned a default priority of 0.
|
||||
Algolia is configured to use the `priority` attribute for custom ranking in descending order.
|
||||
|
||||
**Within the docs**:
|
||||
We have a reusable React component, `<SearchPriority />` -> `src/components/SearchPriority.jsx`. This component provides a simple shortcut to add the correct <meta> tag to any .mdx page.
|
||||
|
||||
For high priority pages, use `<SearchPriority level="high" />`. For pages referencing deprecated features use `<SearchPriority level="noindex" />`.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### `TypeError: source_default(...).bold is not a function`
|
||||
|
@ -4,6 +4,10 @@ description: "An overview of the three main Unleash APIs: Client API, Frontend A
|
||||
displayed_sidebar: documentation
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Unleash APIs
|
||||
|
||||
Unleash provides a set of APIs to give you full programmatic control over your feature flags and to connect your applications and services to Unleash. There are three main APIs, each designed for a specific purpose.
|
||||
|
@ -4,6 +4,10 @@ slug: /feature-flag-tutorials/use-cases/a-b-testing
|
||||
pagination_next: feature-flag-tutorials/use-cases/ai
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Feature flags are a great way to run A/B or multivariate tests with minimal code modifications, and Unleash offers built-in features that make it easy to get started. In this tutorial, we will walk through how to do an A/B test using Unleash with your application.
|
||||
|
||||
## How to perform A/B testing with feature flags
|
||||
|
@ -4,6 +4,10 @@ slug: /feature-flag-tutorials/use-cases/gradual-rollout
|
||||
pagination_next: feature-flag-tutorials/use-cases/a-b-testing
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## What is a gradual rollout?
|
||||
|
||||
A **gradual rollout** is a controlled release strategy where a new feature is first released to a small subset of users. This allows for monitoring user behavior, identifying potential issues, and gathering feedback before a full-scale launch. It also allows us to experiment quickly and safely.
|
||||
|
@ -4,6 +4,9 @@ title: Scaling Unleash for enterprise workloads
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
When evaluating Unleash for [enterprise-wide adoption](https://www.getunleash.io/blog/feature-ops-is-the-next-frontier), your primary concerns likely revolve around scalability, performance, and availability. You need assurance that your chosen [feature management system](https://www.getunleash.io/) can handle potentially tens of millions of users and millions of flags across a number of regions, without compromising user experience or introducing system fragility.
|
||||
|
||||
|
@ -3,6 +3,10 @@ title: Feature flag security and compliance for enterprises
|
||||
slug: /feature-flag-tutorials/use-cases/security-and-compliance
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Security and compliance are important aspects of building and managing complex software in large enterprises. For software architects, engineering leaders, and technical decision-makers, every tool in your tech stack needs to pass security reviews. The weakest link in your software bill of materials, known as the SBOM, can be the one that compromises your security, so every dependency and integration must meet strict standards. Security isn't just about individual components—it’s about the entire system working together without introducing risk.
|
||||
|
||||
In the modern security landscape, compliance frameworks like FedRAMP, SOC 2, and ISO 27001 set strict standards for proving good security posture in your software tool implementations. Feature flag management systems are no exception.
|
||||
|
@ -3,6 +3,10 @@ title: Implement trunk-based development using feature flags
|
||||
slug: /feature-flag-tutorials/use-cases/trunk-based-development
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Developers are increasingly adopting trunk-based development to accelerate software delivery and improve efficiency and reliability. A key principle of trunk-based development is merging code into the main branch (aka "trunk") as quickly as possible. This practice reduces the complexity of long-lived feature branches, minimizes merge conflicts, and ensures that teams can continuously integrate and test their code. However, it also means unfinished or experimental features may exist in production. This is where feature flags become essential.
|
||||
|
||||
Unleash provides a powerful mechanism for safely managing and controlling these features in production, enabling enterprises to deliver software faster and with greater reliability. Effective feature flag management ensures that trunk-based development supports continuous delivery without compromising stability. In this tutorial, we’ll use Unleash to manage trunk-based development in your codebase.
|
||||
|
@ -4,6 +4,12 @@ slug: /feature-flag-tutorials/use-cases/user-management-access-controls-auditing
|
||||
pagination_next: feature-flag-tutorials/use-cases/security-compliance
|
||||
---
|
||||
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
|
||||
Feature flags are a game-changer for how software teams build, test, and release products. They enable you to roll out new features with confidence, manage risk, and keep your software development agile and secure.
|
||||
|
||||
Imagine a large banking platform company with hundreds of engineering teams across multiple continents. Their software development lifecycle is complex and dynamic. Feature flags simplify their processes, but managing all those users is an additional layer of complexity. Unleash solves this with user management capabilities, role-based access controls, and auditing features to help organizations release code with confidence while maintaining security and compliance.
|
||||
|
@ -3,6 +3,12 @@ title: 'Set up SSO with Google'
|
||||
description: Set up SSO for Unleash with Google.
|
||||
---
|
||||
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
:::caution Deprecation notice
|
||||
|
||||
Single Sign-on via the Google Authenticator provider has been removed in Unleash v5 (deprecated in v4). We recommend using [OpenID Connect](./how-to-add-sso-open-id-connect.md) instead. If you're running a self hosted version of Unleash and you need to temporarily re-enable Google SSO, you can do so by setting the `GOOGLE_AUTH_ENABLED` environment variable to `true`. If you're running a hosted version of Unleash, you'll need to reach out to us and ask us to re-enable the flag. Note that this code will be removed in a future release and this is not safe to depend on.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: How to create API Tokens
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
All Unleash APIs require authentication using an [API token](/reference/api-tokens-and-client-keys). The type of token you use depends on the API you are accessing and your specific use case.
|
||||
|
||||
### Token types
|
||||
|
@ -3,6 +3,11 @@ title: Environment import and export
|
||||
---
|
||||
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx'
|
||||
|
||||
:::note Availability
|
||||
|
@ -2,6 +2,12 @@
|
||||
title: How to run the Unleash Proxy
|
||||
---
|
||||
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
import ApiRequest from '@site/src/components/ApiRequest'
|
||||
|
||||
:::warning
|
||||
|
@ -1,84 +0,0 @@
|
||||
---
|
||||
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 integration guide](../reference/integrations/slack.md) instead.
|
||||
|
||||
Event hook option is removed in Unleash v5
|
||||
|
||||
:::
|
||||
|
||||
## Create a custom Slack WebHook URL: {#create-a-custom-slack-webhook-url}
|
||||
|
||||
1. Go to [https://slack.com/apps/manage/custom-integrations](https://slack.com/apps/manage/custom-integrations)
|
||||
1. Click Incoming WebHooks
|
||||
1. Click “Add Configuration”
|
||||
1. This is Slack's help page on how to do this: https://api.slack.com/messaging/webhooks
|
||||
- Choose a channel, follow the wizard, get the custom URL.
|
||||
|
||||
## Send data to Slack using an event hook function {#send-data-to-slack-using-an-event-hook-function}
|
||||
|
||||
Using the `eventHook` option, create a function that will send the data you'd like into Slack when mutation events happen.
|
||||
|
||||
```javascript
|
||||
const unleash = require('unleash-server');
|
||||
const axios = require('axios');
|
||||
|
||||
function onEventHook(event, eventData) {
|
||||
const { createdBy: user, data } = eventData;
|
||||
let text = '';
|
||||
|
||||
const unleashUrl = 'http://your.unleash.host.com';
|
||||
const feature = `<${unleashUrl}/#/features/strategies/${data.name}|${data.name}>`;
|
||||
|
||||
switch (event) {
|
||||
case 'feature-created':
|
||||
case 'feature-updated': {
|
||||
const verb =
|
||||
event === 'feature-created' ? 'created a new' : 'updated the';
|
||||
text = `${user} ${verb} feature ${feature}\ndescription: ${
|
||||
data.description
|
||||
}\nenabled: ${data.enabled}\nstrategies: \`${JSON.stringify(
|
||||
data.strategies,
|
||||
)}\``;
|
||||
break;
|
||||
}
|
||||
case 'feature-archived':
|
||||
case 'feature-revived': {
|
||||
const verb = event === 'feature-archived' ? 'archived' : 'revived';
|
||||
text = `${user} ${verb} the feature ${feature}`;
|
||||
break;
|
||||
}
|
||||
default: {
|
||||
console.error(`Unknown event ${event}`);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
axios
|
||||
.post(
|
||||
'https://hooks.slack.com/services/THIS_IS_WHERE_THE_CUSTOM_URL_GOES',
|
||||
{
|
||||
username: 'Unleash',
|
||||
icon_emoji: ':unleash:', // if you added a custom emoji, otherwise you can remove this field.
|
||||
text: text,
|
||||
},
|
||||
)
|
||||
.then((res) => {
|
||||
console.log(`Slack post statusCode: ${res.status}. Text: ${text}`);
|
||||
})
|
||||
.catch((error) => {
|
||||
console.error(error);
|
||||
});
|
||||
}
|
||||
|
||||
const options = {
|
||||
eventHook: onEventHook,
|
||||
};
|
||||
|
||||
unleash.start(options).then((server) => {
|
||||
console.log(`Unleash started on http://localhost:${server.app.get('port')}`);
|
||||
});
|
||||
```
|
@ -4,14 +4,10 @@ pagination_next: topics/what-is-a-feature-flag
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
||||
import TabItem from '@theme/TabItem';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
import Head from '@docusaurus/Head';
|
||||
|
||||
<Head>
|
||||
<meta name="search_priority" content="3" />
|
||||
</Head>
|
||||
<SearchPriority level="high" />
|
||||
|
||||
The easiest way to get started with Unleash is through a [cloud-hosted free trial](https://www.getunleash.io/plans/enterprise-payg). This gives you a ready-to-use instance, so you can explore all Unleash features without any local setup.
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Actions
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
||||
|
@ -3,6 +3,9 @@ title: Activation strategies
|
||||
---
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Overview
|
||||
|
||||
|
@ -3,6 +3,10 @@ title: API tokens and client keys
|
||||
pagination_next: reference/front-end-api
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Overview
|
||||
|
||||
Unleash uses API keys to facilitate communication between consuming clients such as [SDKs](../reference/sdks), [Unleash Edge](../reference/unleash-edge), or other tools and automation.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/addons
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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 integrations and providers {#list-integrations-and-providers}
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/archive
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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.
|
||||
|
||||
|
||||
|
@ -2,6 +2,11 @@
|
||||
title: /api/admin/context
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain a API token](/how-to/how-to-create-api-tokens) with admin permissions.
|
||||
|
||||
### List context fields defined in Unleash {#list-context-fields-defined-in-unleash}
|
||||
|
@ -3,6 +3,10 @@ title: /api/admin/events
|
||||
---
|
||||
|
||||
import ApiRequest from '@site/src/components/ApiRequest'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
:::note
|
||||
|
||||
|
@ -3,6 +3,10 @@ id: feature-types
|
||||
title: /api/admin/feature-types
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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.
|
||||
|
||||
# Feature Types API
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/projects/:projectId
|
||||
---
|
||||
import ApiRequest from '@site/src/components/ApiRequest'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
:::info
|
||||
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.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/features
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::caution Deprecation notice
|
||||
|
||||
Most of this API was removed in Unleash v5 (after being deprecated since Unleash v4.3). You should use [the project-based API (/api/admin/projects/:projectId)](/reference/api/legacy/unleash/admin/features-v2.mdx) instead.
|
||||
|
@ -3,6 +3,10 @@ id: metrics
|
||||
title: /api/admin/metrics
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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.
|
||||
|
||||
# This document describes the metrics endpoint for admin ui
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/projects
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain an API token](/how-to/how-to-create-api-tokens) with admin permissions.
|
||||
|
||||
### List projects in Unleash {#list-projects-in-unleash}
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/segments
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
import ApiRequest from '@site/src/components/ApiRequest'; export const basePath = "api/admin/segments"; export const path = (p) => `${basePath}/${p}`;
|
||||
|
||||
:::note Availability
|
||||
|
@ -3,6 +3,10 @@ id: state
|
||||
title: /api/admin/state
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::caution Removal notice
|
||||
|
||||
Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export).
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/strategies
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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.
|
||||
|
||||
### Fetch Strategies {#fetch-strategies}
|
||||
|
@ -3,6 +3,10 @@ id: tags
|
||||
title: /api/admin/tags
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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.
|
||||
|
||||
### Create a new tag {#create-a-new-tag}
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/admin/user-admin
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> 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 all users {#list-all-users}
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Basic Auth
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
# Basic auth
|
||||
|
||||
When using the `insecure` authentication method, identifying using basic auth against the API is enough. Since the `insecure` method doesn't require a password, it is enough to define the username when making HTTP requests.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /api/client/features
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a CLIENT token](/how-to/how-to-create-api-tokens.mdx) and add an Authorization header using the token.
|
||||
|
||||
### Fetching Feature Flags {#fetching-feature-toggles}
|
||||
|
@ -3,6 +3,10 @@ id: metrics
|
||||
title: /api/client/metrics
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a CLIENT token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Send metrics {#send-metrics}
|
||||
|
@ -3,6 +3,10 @@ id: register
|
||||
title: /api/client/register
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a CLIENT token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
|
||||
|
||||
### Client registration {#client-registration}
|
||||
|
@ -3,6 +3,10 @@ id: index
|
||||
title: Legacy API Documentation
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::caution
|
||||
|
||||
These APIs have been deprecared. Wse the [Unleash OpenAPI docs](/api-overview) reference instead.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: /health
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
# Health API
|
||||
|
||||
`GET http://unleash.host.com/health`
|
||||
|
@ -2,6 +2,11 @@
|
||||
title: /internal-backstage/prometheus
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
|
||||
# Internal Backstage API
|
||||
|
||||
`GET http://unleash.host.com/internal-backstage/prometheus`
|
||||
|
@ -3,6 +3,10 @@ title: Applications
|
||||
pagination_next: reference/service-accounts
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `5.11+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Banners
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.7+`
|
||||
|
@ -3,6 +3,9 @@ title: Change requests
|
||||
---
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Command menu
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `6.2+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Custom activation strategies
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="medium" />
|
||||
|
||||
**Custom activation strategies** let you define your own activation strategies to use with Unleash. When the [built-in activation strategies](../reference/activation-strategies.md) aren't enough, custom activation strategies are there to provide you with the flexibility you need.
|
||||
|
||||
Custom activation strategies work exactly like the built-in activation strategies when working in the admin UI.
|
||||
|
@ -2,6 +2,9 @@
|
||||
title: Import and export
|
||||
---
|
||||
import ApiRequest from '@site/src/components/ApiRequest'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -3,11 +3,16 @@ id: environments
|
||||
title: Environments
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.3+`
|
||||
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
||||
Environments represent different stages in your development lifecycle. They allow you to manage your product releases from local development to production. [Projects](/reference/projects) and [feature flags](/reference/feature-toggles) are accessible in all environments, but each environment has different feature flag configurations. This allows you to enable a flag in development or test without enabling it in production.
|
||||
|
@ -1,6 +1,10 @@
|
||||
---
|
||||
title: Events
|
||||
---
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
|
@ -1,6 +1,11 @@
|
||||
---
|
||||
title: Feature flag variants (deprecated)
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::warning
|
||||
|
||||
Feature Flag Variants at the environment level are deprecated in favor of the [strategy variants](./strategy-variants).
|
||||
|
@ -3,6 +3,10 @@ title: Feature flags
|
||||
pagination_next: reference/activation-strategies
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Overview
|
||||
|
||||
Feature flags are a core concept of Unleash. They allow you to release, test, and manage features and functionality across your application without changing the source code.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Frontend API
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.18+`
|
||||
|
@ -3,6 +3,10 @@ title: Impression data
|
||||
pagination_next: reference/events
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.7+`. Requires [SDK compatibility](../reference/sdks#feature-compatibility-in-server-side-sdks).
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Analytics
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.0+`
|
||||
|
@ -3,6 +3,10 @@ id: datadog
|
||||
title: Datadog
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.0+`
|
||||
|
@ -3,6 +3,9 @@ id: index
|
||||
title: Integrations
|
||||
---
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -2,6 +2,11 @@
|
||||
title: Jira Cloud Integration - Installation
|
||||
---
|
||||
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.0+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Jira Cloud Integration - Usage
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
With the Unleash Jira Cloud Plugin you can create, view and manage Unleash feature flags directly from a Jira issue.
|
||||
|
||||
The plugin also shows you current status of connected flags.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Jira Server Integration - Installation
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::info Deprecated
|
||||
|
||||
The Jira Server plugin is **deprecated**, please use the [Unleash Jira Cloud plugin](https://docs.getunleash.io/reference/integrations/jira-cloud-plugin-installation) instead
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Jira Server Integration - Usage
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::info Deprecated
|
||||
|
||||
The Jira Server plugin is **deprecated**, please use the [Unleash Jira Cloud plugin](https://docs.getunleash.io/reference/integrations/jira-cloud-plugin-installation) instead
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: App for Slack
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `5.5+`
|
||||
|
@ -3,6 +3,10 @@ id: slack
|
||||
title: Slack (deprecated)
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="noindex" />
|
||||
|
||||
:::caution Deprecation notice
|
||||
|
||||
This Slack integration is deprecated and will be removed in a future release. We recommend using the new [App for Slack](./slack-app) integration instead.
|
||||
|
@ -3,6 +3,10 @@ id: teams
|
||||
title: Microsoft Teams
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.0+`
|
||||
|
@ -3,6 +3,10 @@ id: webhook
|
||||
title: Webhook
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `3.11+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Login history
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Maintenance mode
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.22+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Network
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
|
||||
|
@ -2,6 +2,9 @@
|
||||
title: Playground
|
||||
---
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Project collaboration mode
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.22+`
|
||||
|
@ -4,6 +4,10 @@ title: Projects
|
||||
pagination_next: reference/project-collaboration-mode
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Overview
|
||||
|
||||
Projects help you organize feature flags within Unleash. For example, you can use projects to group feature flags by development teams or different functional modules within your application.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Public invite links
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Public invite links allow you to invite new team members to your Unleash instance. Any user who receives an invite link can use it to sign up for the Unleash instance that generated the link. When users sign up using an invite link, they are automatically assigned the [Viewer](../reference/rbac.md#predefined-roles) role.
|
||||
|
||||
A token becomes active as soon as you create it, and remains valid until it expires or is deleted. Once a token is invalid, users can no longer sign up using an invite link containing that token.
|
||||
|
@ -3,6 +3,10 @@ id: rbac
|
||||
title: Role-based access control
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `4.0+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Release templates
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) cloud-hosted | **Version**: `6.8+` in [BETA](/availability#beta-features).
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Resource limits
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `6.2+`
|
||||
|
@ -3,6 +3,10 @@ id: scim
|
||||
title: Provisioning
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `6.1+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: SDK overview
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Unleash offers a number of client libraries (SDKs) designed to help you integrate Unleash into your applications. The SDKs provide an interface for fetching and evaluating feature flags.
|
||||
|
||||
With [Unleash's architecture](../understanding-unleash/unleash-overview#system-overview), feature flags can be evaluated within the SDKs or [Unleash Edge](./unleash-edge), making evaluations incredibly fast. SDKs cache feature flag data in memory, providing high reliability.
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Search
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `5.9+`
|
||||
|
@ -3,7 +3,9 @@ title: Segments
|
||||
---
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Service accounts
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.21+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Signals
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `5.11+` in BETA
|
||||
|
@ -2,6 +2,9 @@
|
||||
title: Single Sign-On
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Stickiness
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
_Stickiness_ is how Unleash guarantees that the same user gets the same features every time. Stickiness is useful in any scenario where you want to either show a feature to only a subset of users or give users a variant of a feature.
|
||||
|
||||
## Calculation
|
||||
|
@ -3,6 +3,9 @@ title: Strategy variants
|
||||
---
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx'
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
|
@ -3,6 +3,10 @@ title: Technical debt
|
||||
pagination_next: reference/insights
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
## Overview
|
||||
|
||||
Feature flag technical debt accumulates when you don’t manage or retire feature flags after their intended use. Over time, the codebase becomes cluttered with outdated flags, making the code more complex and harder to maintain. This can slow productivity as developers spend more time understanding and navigating the code.
|
||||
|
@ -3,6 +3,10 @@ title: Using Unleash through Terraform
|
||||
description: "Set up and configure your Unleash instance using infastructure as code."
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Version**: `5.6+`
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Unleash context
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
The **Unleash context** contains information related to the current feature flag request. Unleash uses this context to evaluate [activation strategies](activation-strategies) and [strategy constraints](../reference/activation-strategies#constraints) and to calculate [flag stickiness](../reference/stickiness). The Unleash Context is an important feature of all the [Unleash client SDKs](../reference/sdks).
|
||||
|
||||
## Overview
|
||||
|
@ -3,6 +3,9 @@ title: 'Feature flag management: Best practices'
|
||||
description: 'A guide for feature flag management. Best practices for organization, lifecycle management, and avoiding common pitfalls to keep your system efficient and secure.'
|
||||
toc_max_heading_level: 2
|
||||
---
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
# Feature flag management at scale: best practices
|
||||
|
||||
|
@ -6,6 +6,9 @@ pagination_next: topics/feature-flags/best-practices-using-feature-flags-at-scal
|
||||
---
|
||||
|
||||
import VideoContent from '@site/src/components/VideoContent.jsx';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Feature flags, [sometimes called feature toggles or feature switches](../../what-is-a-feature-flag), are a powerful software development technique that allows engineering teams to decouple the release of new functionality from software deployments.
|
||||
|
||||
|
@ -3,6 +3,10 @@ title: Unleash hosting options
|
||||
description: "Explore the flexible hosting options for Unleash and Unleash Edge, including cloud-hosted, hybrid, and self-hosted deployments. Compare features, scalability, and support to find the right setup for your team."
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Unleash provides flexible hosting options for Unleash and [Unleash Edge](../generated/unleash-edge.md), allowing you to meet specific requirements for scaling, privacy, and infrastructure control. This document covers the main hosting models for the Unleash API server and Unleash Edge. Choosing a hosting model is a key architectural decision.
|
||||
|
||||
Before considering hosting options, we recommend that you explore the [Unleash architecture and its key components](./unleash-overview).
|
||||
|
@ -2,6 +2,10 @@
|
||||
title: Core concepts
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
This guide's purpose is to give you a conceptual overview of how Unleash works. It covers the various components that exist within our system and how they interact with each other and with external applications. The diagrams help you understand the fundamental building blocks, such as [projects](../reference/projects), [environments](../reference/environments), [variants](../reference/strategy-variants) and of course, [feature flags](../reference/feature-toggles).
|
||||
|
||||
The end of this guide presents a [short use case, explaining how you might configure Unleash](#use-case) to start working with feature flags.
|
||||
|
@ -3,6 +3,10 @@ title: Unleash architecture overview
|
||||
pagination_next: understanding-unleash/the-anatomy-of-unleash
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Unleash is designed for privacy, speed, and resilience, enabling feature flag evaluations to occur locally within your applications. The architecture provides:
|
||||
- **Fast feature flag evaluations**: Feature flags are evaluated within the [SDKs](#unleash-sdks) or [Unleash Edge](#unleash-edge), making evaluations incredibly fast (nanoseconds).
|
||||
- **Privacy and security**: No user data is shared with the Unleash server, ensuring [privacy and security](/understanding-unleash/data-collection).
|
||||
|
@ -3,6 +3,10 @@ title: Compliance for feature flags
|
||||
description: 'Secure and compliant feature flags at scale with Unleash.'
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
# Compliance
|
||||
|
||||
## Overview
|
||||
|
@ -4,6 +4,10 @@ description: "Steps and options for configuring your self-hosted Unleash instanc
|
||||
toc_max_heading_level: 3
|
||||
---
|
||||
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
|
||||
|
||||
This guide explains how to configure your self-hosted Unleash instance when running it via [Docker Compose or the Docker CLI](/using-unleash/deploy/getting-started).
|
||||
|
@ -7,6 +7,9 @@ pagination_next: using-unleash/deploy/configuring-unleash
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
<SearchPriority level="high" />
|
||||
|
||||
Unleash offers several [hosting options](/understanding-unleash/hosting-options), including fully self-hosted setups. This guide helps you set up Unleash Open Source or Unleash Enterprise in your own environment using Docker.
|
||||
|
||||
|
@ -541,10 +541,6 @@ class="header-github-link"
|
||||
],
|
||||
to: '/reference/integrations/webhook',
|
||||
},
|
||||
{
|
||||
from: '/guides/feature_updates_to_slack',
|
||||
to: '/how-to/how-to-send-feature-updates-to-slack-deprecated',
|
||||
},
|
||||
{
|
||||
from: [
|
||||
'/integrations/integrations',
|
||||
|
35
website/src/components/SearchPriority.jsx
Normal file
35
website/src/components/SearchPriority.jsx
Normal file
@ -0,0 +1,35 @@
|
||||
// src/components/SearchPriority.js
|
||||
import React from 'react';
|
||||
import Head from '@docusaurus/Head';
|
||||
|
||||
// Define the mapping from level names to numbers
|
||||
const priorityMap = {
|
||||
low: 1,
|
||||
medium: 2,
|
||||
high: 3,
|
||||
};
|
||||
|
||||
export default function SearchPriority({ level }) {
|
||||
// If no level is provided, render nothing.
|
||||
if (!level) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// If level is 'noindex', render the robots tag.
|
||||
if (level === 'noindex') {
|
||||
return (
|
||||
<Head>
|
||||
<meta name='robots' content='noindex' />
|
||||
</Head>
|
||||
);
|
||||
}
|
||||
|
||||
// If a valid level was found, render the priority tag
|
||||
const priorityValue = priorityMap[level];
|
||||
|
||||
return priorityValue ? (
|
||||
<Head>
|
||||
<meta name='search_priority' content={priorityValue} />
|
||||
</Head>
|
||||
) : null;
|
||||
}
|
@ -311,11 +311,6 @@
|
||||
"destination": "/reference/integrations/webhook",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/guides/feature_updates_to_slack",
|
||||
"destination": "/how-to/how-to-send-feature-updates-to-slack-deprecated",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/integrations/integrations",
|
||||
"destination": "/reference/integrations",
|
||||
|
Loading…
Reference in New Issue
Block a user