mirror of
https://github.com/Unleash/unleash.git
synced 2025-11-24 20:06:55 +01:00
update get started
This commit is contained in:
melindafekete
parent
3b8e72bd3b
commit
528f31f886
@ -18,7 +18,7 @@ For this tutorial, you'll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. For backend applications or automated scripts, Unleash exposes an [API](/api-overview) defined by an OpenAPI specification, allowing you to perform these actions programmatically.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. For backend applications or automated scripts, Unleash exposes an [API](/get-started/api-overview) defined by an OpenAPI specification, allowing you to perform these actions programmatically.
|
||||
|
||||
## 1. Install a local feature flag provider
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ For this tutorial, you’ll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or app.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or app.
|
||||
|
||||
## 1. Install a local feature flag provider
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ For this tutorial, you'll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. You can perform the same actions straight from your CLI or server-side app using the [Unleash API](/api-overview).
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. You can perform the same actions straight from your CLI or server-side app using the [Unleash API](/get-started/api-overview).
|
||||
|
||||
## Best practices for back-end apps with Unleash
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ In this tutorial, you will need the following:
|
||||
|
||||
This architecture diagram breaks down how the Java app works with Unleash to control feature flags. We connect the Unleash service to your Java app using the Java SDK.
|
||||
|
||||
The Unleash Server acts as a Feature Flag Control Service, managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports the sending of data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
The Unleash Server acts as a Feature Flag Control Service, managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports the sending of data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
|
||||
## 1. Feature Flag best practices for backend apps
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ In this tutorial, you will need the following:
|
||||
|
||||
This architecture diagram breaks down how the Java Spring Boot app works with Unleash to use feature flags.
|
||||
|
||||
The Unleash Server is a Feature Flag Control Service for managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports sending data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. API commands are also [available](/api-overview) to perform the same actions from your CLI or server-side app.
|
||||
The Unleash Server is a Feature Flag Control Service for managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports sending data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. API commands are also [available](/get-started/api-overview) to perform the same actions from your CLI or server-side app.
|
||||
|
||||
The Spring Boot SDK is an extension of the Java SDK, configured for Spring Boot-specific architecture and conventions.
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ In this tutorial, you will need the following:
|
||||
|
||||
This architecture diagram breaks down how the Python app works with Unleash to control feature flags. We connect the Unleash service to your Python app using the Python SDK.
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which is a service that manages your feature flags and is used to retrieve flag data from (and send data to, especially when not using a UI). The Unleash server has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which is a service that manages your feature flags and is used to retrieve flag data from (and send data to, especially when not using a UI). The Unleash server has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
|
||||
## 1. Unleash best practice for backend apps
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ For this tutorial, you’ll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
|
||||
## 1. Best practices for back-end apps with Unleash
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ For this tutorial, you’ll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or server-side app.
|
||||
|
||||
## 1. Best practices for back-end apps with Unleash
|
||||
|
||||
|
||||
@ -26,7 +26,7 @@ For this tutorial, you’ll need the following:
|
||||
|
||||
|
||||
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or app.
|
||||
The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/get-started/api-overview) to perform the same actions straight from your CLI or app.
|
||||
|
||||
## 1. Install a local feature flag provider
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ Feature flags are a great way to run A/B or multivariate tests with minimal code
|
||||
|
||||
## How to perform A/B testing with feature flags
|
||||
|
||||
To follow along with this tutorial, you need access to an Unleash instance to create and manage feature flags. Head over to our [Quick Start documentation](/quickstart) for options, including running locally or using an [Unleash SaaS instance](https://www.getunleash.io/pricing?).
|
||||
To follow along with this tutorial, you need access to an Unleash instance to create and manage feature flags. Head over to our [Quick Start documentation](/get-started/quickstart) for options, including running locally or using an [Unleash SaaS instance](https://www.getunleash.io/pricing?).
|
||||
|
||||
With Unleash set up, you can use your application to talk to Unleash through one of our [SDKs](/reference/sdks).
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ The key benefits of gradual rollouts are that you can experiment rapidly on a co
|
||||
|
||||
## How to perform a gradual rollout with Unleash
|
||||
|
||||
To follow along with this tutorial, you will need an Unleash instance. If you’d prefer to self-host Unleash, read our [Quickstart guide](/quickstart). Alternatively, if you’d like your project to be hosted by Unleash, go to [getunleash.io](https://www.getunleash.io/pricing).
|
||||
To follow along with this tutorial, you will need an Unleash instance. If you’d prefer to self-host Unleash, read our [Quickstart guide](/get-started/quickstart). Alternatively, if you’d like your project to be hosted by Unleash, go to [getunleash.io](https://www.getunleash.io/pricing).
|
||||
|
||||
With Unleash set up, you can use your application to talk to Unleash through one of our SDKs.
|
||||
|
||||
|
||||
@ -135,7 +135,7 @@ A common challenge is managing a single feature that spans multiple services (fo
|
||||
- **Use separate, coordinated flags**: If the services are owned by different teams and have different release cadences, it's better to create separate flags in their respective projects. This prevents one team from impacting another's release. The rollout can then be coordinated across teams using release templates.
|
||||
|
||||
## Evolve your structure
|
||||
Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/reference/import-export) functionality or the [Admin API](/api-overview).
|
||||
Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/reference/import-export) functionality or the [Admin API](/get-started/api-overview).
|
||||
|
||||
The system is designed to evolve with your organization, so don't be afraid to start with a simple setup and refactor as your needs change.
|
||||
|
||||
|
||||
@ -177,7 +177,7 @@ For more advanced implementations, integrate Unleash event logs directly into br
|
||||
|
||||
### Leverage access logs for broader auditing
|
||||
|
||||
Let’s think back to the importance of user management that we covered earlier. Developers and other stakeholders go through onboarding to use the platform. Authentication protocols and user provisioning ensure these processes are secure, unified, and automated. During this process, access logs keep track of what users and systems accessed Unleash and what actions they performed, including [Unleash API interactions](/api-overview) from your services and applications. You can export these logs to S3 buckets for long-term data storage. This is valuable if you need to preserve data for complying with legal or regulatory compliance, storing critical backups for disaster recovery, and archiving.
|
||||
Let’s think back to the importance of user management that we covered earlier. Developers and other stakeholders go through onboarding to use the platform. Authentication protocols and user provisioning ensure these processes are secure, unified, and automated. During this process, access logs keep track of what users and systems accessed Unleash and what actions they performed, including [Unleash API interactions](/get-started/api-overview) from your services and applications. You can export these logs to S3 buckets for long-term data storage. This is valuable if you need to preserve data for complying with legal or regulatory compliance, storing critical backups for disaster recovery, and archiving.
|
||||
|
||||
Auditing your feature flag system is made simple for traceability and reportability with Unleash’s event logs and access logs. We recommend leveraging these features as data sources for third-party services that make your data a valuable asset for security reviews, meeting compliance standards, and overall risk mitigation.
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ Unleash provides a powerful mechanism for safely managing and controlling these
|
||||
|
||||
## How to implement trunk-based development with feature flags
|
||||
|
||||
To follow along with this tutorial, you need access to an Unleash instance to create and manage feature flags. Head over to our [Quick Start documentation](/quickstart) for options, including running locally or using an [Unleash SaaS instance](https://www.getunleash.io/pricing?).
|
||||
To follow along with this tutorial, you need access to an Unleash instance to create and manage feature flags. Head over to our [Quick Start documentation](/get-started/quickstart) for options, including running locally or using an [Unleash SaaS instance](https://www.getunleash.io/pricing?).
|
||||
|
||||
With Unleash set up, you can use your application to talk to Unleash through one of our [SDKs](/reference/sdks).
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ displayed_sidebar: documentation
|
||||
|
||||
This overview helps you explore our hands-on tutorials and best-practice guides. Each section groups resources around a specific theme, helping you build, ship, and scale features with confidence.
|
||||
|
||||
If you're new to Unleash, start with our [Quickstart](/quickstart) guide to set up your environment, then choose a track below based on what you're building.
|
||||
If you're new to Unleash, start with our [Quickstart](/get-started/quickstart) guide to set up your environment, then choose a track below based on what you're building.
|
||||
|
||||
---
|
||||
## Feature management best practices
|
||||
@ -72,13 +72,13 @@ Beyond scalability, Unleash Edge also offers privacy and security benefits for f
|
||||
|
||||
#### Client API
|
||||
|
||||
The [Client API](/api-overview) is the API used by backend SDKs to fetch feature flag configurations and send SDK usage metrics to Unleash.
|
||||
The [Client API](/get-started/api-overview) is the API used by backend SDKs to fetch feature flag configurations and send SDK usage metrics to Unleash.
|
||||
|
||||
#### Frontend API
|
||||
The [Frontend API](/api-overview) is the API used by frontend SDKs to retrieve all enabled feature flags for a given [Unleash Context](/reference/unleash-context) and send SDK usage metrics to Unleash.
|
||||
The [Frontend API](/get-started/api-overview) is the API used by frontend SDKs to retrieve all enabled feature flags for a given [Unleash Context](/reference/unleash-context) and send SDK usage metrics to Unleash.
|
||||
|
||||
#### Admin API
|
||||
The [Admin API](/api-overview) is an API layer for managing all aspects of your Unleash instance, including creating, updating, and deleting resources, such as feature flags, activation strategies, and environments. This API is used by the [Unleash Admin UI](#the-unleash-admin-ui) and other tools and [integrations](/reference/integrations).
|
||||
The [Admin API](/get-started/api-overview) is an API layer for managing all aspects of your Unleash instance, including creating, updating, and deleting resources, such as feature flags, activation strategies, and environments. This API is used by the [Unleash Admin UI](#the-unleash-admin-ui) and other tools and [integrations](/reference/integrations).
|
||||
|
||||
| API | Used by | Available endpoints |
|
||||
|---------------|---------|---|
|
||||
|
||||
@ -11,7 +11,7 @@ This document helps you get started with [Unleash Edge](https://docs.getunleash.
|
||||
## Why Unleash Edge
|
||||
|
||||
Unleash Edge is a lightweight layer between your SDKs and your Unleash instance.
|
||||
It exposes the same HTTP interface as the main [Unleash API](/api-overview) but is built for higher throughput and lower latency.
|
||||
It exposes the same HTTP interface as the main [Unleash API](/get-started/api-overview) but is built for higher throughput and lower latency.
|
||||
|
||||
<Tabs>
|
||||
|
||||
@ -39,7 +39,7 @@ It exposes the same HTTP interface as the main [Unleash API](/api-overview) but
|
||||
|
||||
Here's what you need before getting started:
|
||||
|
||||
1. An [Unleash instance](https://docs.getunleash.io/quickstart) running locally or remotely (version `4.15` or later)
|
||||
1. An [Unleash instance](https://docs.getunleash.io/get-started/quickstart) running locally or remotely (version `4.15` or later)
|
||||
2. A valid [API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys) for your Unleash instance
|
||||
3. [Docker](https://www.docker.com/get-started/) installed and running
|
||||
4. Your preferred Unleash SDK in a [sample app](https://github.com/Unleash/unleash-sdk-examples)
|
||||
|
||||
@ -9,7 +9,7 @@ import SearchPriority from '@site/src/components/SearchPriority';
|
||||
|
||||
:::caution
|
||||
|
||||
These APIs have been deprecared. Wse the [Unleash OpenAPI docs](/api-overview) reference instead.
|
||||
These APIs have been deprecared. Wse the [Unleash OpenAPI docs](/get-started/api-overview) reference instead.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@ -44,7 +44,7 @@ In version 4 we improved the User Management and made it available for Unleash O
|
||||
|
||||
In version 4 we improved the API Access and made it available for Unleash Open-Source and Unleash Enterprise. Starting from Unleash v4 we require all SDKs to use an access token in order to connect to Unleash.
|
||||
|
||||
[Read more](/api-overview)
|
||||
[Read more](/get-started/api-overview)
|
||||
|
||||
### Custom stickiness {#custom-stickiness}
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ This page highlights the key differences between Unleash OSS and Unleash Enterpr
|
||||
| [Projects](/reference/projects) | 1 | Unlimited |
|
||||
| [Environments](/reference/environments) | 2 | Unlimited |
|
||||
| [Private or protected projects](/reference/project-collaboration-mode) | ❌ | ✅ |
|
||||
| [SDKs](/reference/sdks) and [APIs](/api-overview) | ✅ | ✅ |
|
||||
| [SDKs](/reference/sdks) and [APIs](/get-started/api-overview) | ✅ | ✅ |
|
||||
| [Activation strategies](/reference/activation-strategies) and [stickiness](/reference/stickiness) | ✅ | ✅ |
|
||||
| [Playground](/reference/playground) | ✅ | ✅ |
|
||||
| [Release templates](/reference/release-templates) | ❌ | ✅ |
|
||||
|
||||
@ -110,7 +110,7 @@ Cross-Origin Resource Sharing (CORS) issues can prevent your client-side applica
|
||||
- Define the allowed origins (e.g., `https://your-app.com`).
|
||||
- **For troubleshooting:** You can temporarily set the allowed origin to `*` (a single asterisk) to allow all origins. This helps confirm if CORS is the root cause.
|
||||
- **Important Security Note:** Using `*` in production is generally discouraged. Always restrict origins to only those that require access.
|
||||
- These settings can also be managed via the [Unleash API](/api-overview).
|
||||
- These settings can also be managed via the [Unleash API](/get-started/api-overview).
|
||||
|
||||
### Configuring CORS for Unleash Edge
|
||||
|
||||
|
||||
@ -359,7 +359,7 @@ class="header-github-link"
|
||||
items: [
|
||||
{
|
||||
label: 'Quickstart',
|
||||
to: '/quickstart',
|
||||
to: '/get-started/quickstart',
|
||||
},
|
||||
{
|
||||
label: 'Unleash architecture',
|
||||
|
||||
@ -42,13 +42,13 @@ const sidebars: SidebarsConfig = {
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: 'quickstart',
|
||||
id: 'get-started/quickstart',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
label: 'Quickstart',
|
||||
id: 'quickstart',
|
||||
id: 'get-started/quickstart',
|
||||
},
|
||||
{
|
||||
type: 'doc',
|
||||
@ -201,7 +201,7 @@ const sidebars: SidebarsConfig = {
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: 'guides-overview',
|
||||
id: 'get-started/guides-overview',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
@ -552,7 +552,7 @@ const sidebars: SidebarsConfig = {
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'doc',
|
||||
id: 'api-overview',
|
||||
id: 'get-started/api-overview',
|
||||
},
|
||||
items: [
|
||||
docsSidebar,
|
||||
|
||||
@ -113,12 +113,12 @@
|
||||
},
|
||||
{
|
||||
"source": "/reference/api/unleash",
|
||||
"destination": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/api/open_api",
|
||||
"destination": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -548,22 +548,22 @@
|
||||
},
|
||||
{
|
||||
"source": "/user_guide/quickstart",
|
||||
"destination": "/quickstart",
|
||||
"destination": "/get-started/quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/docs/getting_started",
|
||||
"destination": "/quickstart",
|
||||
"destination": "/get-started/quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/tutorials/quickstart",
|
||||
"destination": "/quickstart",
|
||||
"destination": "/get-started/quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/tutorials/getting-started",
|
||||
"destination": "/quickstart",
|
||||
"destination": "/get-started/quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -773,12 +773,12 @@
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-enable-openapi",
|
||||
"destination": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/api",
|
||||
"destination": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -813,7 +813,7 @@
|
||||
},
|
||||
{
|
||||
"source": "/using-unleash",
|
||||
"destination": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -1018,7 +1018,7 @@
|
||||
},
|
||||
{
|
||||
"source": "/topics",
|
||||
"destination": "/guides-overview",
|
||||
"destination": "/get-started/guides-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
@ -1071,6 +1071,21 @@
|
||||
"destination": "/support/oss-comparison",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/api-overview",
|
||||
"destination": "/get-started/api-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/guides-overview",
|
||||
"destination": "/get-started/guides-overview",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/quickstart",
|
||||
"destination": "/get-started/quickstart",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/sso",
|
||||
"destination": "/single-sign-on/how-to-add-sso-open-id-connect",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user