1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-10 17:53:36 +02:00

fix: docs

This commit is contained in:
Fredrik Oseberg 2021-08-16 12:21:58 +02:00
parent 4a14e6f3aa
commit a8507ad7df
5 changed files with 25 additions and 25 deletions

View File

@ -7,7 +7,7 @@ It is powerful to be able to turn a feature on and off instantaneously, without
The definition of an activation strategy lives in the Unleash API and can be created via the Unleash UI. The implementation of activation strategies lives in various client implementations.
Unleash comes with a few common activation strategies. Some of them require the client to provide the [unleash-context](./unleash-context.md), which gives the necessary context for Unleash.
Unleash comes with a few common activation strategies. Some of them require the client to provide the [unleash-context](unleash-context.md), which gives the necessary context for Unleash.
## Standard {#standard}

View File

@ -45,4 +45,4 @@ In the example above we have to configure two activation strategies, **userWithI
You use activation strategies to control who the feature toggle will be enabled for. You can configure multiple strategies for a feature toggle, and they are considered in an OR fashion, meaning if one of them evaluates to true the toggle will be enabled.
If you need to limit the exposure (AND) you should look in to [strategy constraints](/advanced/strategy_constraints), which is the building block for that.
If you need to limit the exposure (AND) you should look in to [strategy constraints](advanced/strategy-constraints.md), which is the building block for that.

View File

@ -32,4 +32,4 @@ Before you can connect your application to Unleash you need a Unleash server. Yo
- **Unleash SDK** - Used by clients to check if a feature is enabled or disabled. The SDK also collects metrics and sends them to the Unleash API. [See all our SDKs](/sdks)
- **Unleash Proxy** - Sits between frontend/native applications and the Unleash API. Ensures high performance and that you don't expose the full feature toggle configuration to end-users. [Read more about Unleash Proxy](/sdks/unleash-proxy)
To be super fast (_we talk nano-seconds_), the [client SDK](/sdks/index) caches all feature toggles and their current configuration in memory. The activation strategies are also implemented in the SDK. This makes it really fast to check if a toggle is on or off because it is just a simple function operating on local state, without the need to poll data from the database.
To be super fast (_we talk nano-seconds_), the [client SDK](/sdks/index.md) caches all feature toggles and their current configuration in memory. The activation strategies are also implemented in the SDK. This makes it really fast to check if a toggle is on or off because it is just a simple function operating on local state, without the need to poll data from the database.

View File

@ -13,11 +13,11 @@ NOTE: This is a demo instance set up with the enterprise version. Some of the fu
### I want to test toggles in a client side environment
In order to use feature toggles on the client side you need to connect through [the unleash proxy](../sdks/unleash-proxy). The unleash proxy will provide a security and performance layer between your client application and the unleash instance. For now, you can use the proxy we have set up on the demo instance.
In order to use feature toggles on the client side you need to connect through [the unleash proxy](sdks/unleash-proxy.md). The unleash proxy will provide a security and performance layer between your client application and the unleash instance. For now, you can use the proxy we have set up on the demo instance.
#### Create your first toggle
In order to create a toggle through the UI, [you can follow this guide](./create_feature_toggle). Once you have created your feature toggle, you are ready to connect your application using an SDK.
In order to create a toggle through the UI, [you can follow this guide](create-feature-toggle.md). Once you have created your feature toggle, you are ready to connect your application using an SDK.
#### Connecting to the unleash proxy from your app
@ -30,10 +30,10 @@ Secret key: proxy-123 (edited)
Now you can open your application code and connect through one of the proxy SDKs:
- [Javascript Proxy SDK](../sdks/proxy-javascript)
- [iOS Proxy SDK](../sdks/proxy-ios)
- [Android Proxy SDK](../sdks/android_proxy_sdk)
- [React](../sdks/proxy-react)
- [Javascript Proxy SDK](sdks/proxy-javascript.md)
- [iOS Proxy SDK](sdks/proxy-ios.md)
- [Android Proxy SDK](sdks/android-proxy.md)
- [React](sdks/proxy-react.md)
Here is a connection example using the javascript proxy SDK:
@ -63,7 +63,7 @@ Now you are ready to use the feature toggle you created in your client side appl
#### Create your first toggle
In order to create a toggle through the UI, [you can follow this guide](./create_feature_toggle). Once you have created your feature toggle, you are ready to connect your application using an SDK.
In order to create a toggle through the UI, [you can follow this guide](create-feature-toggle.md). Once you have created your feature toggle, you are ready to connect your application using an SDK.
#### Connecting to the unleash instance from your app
@ -74,7 +74,7 @@ Api URL: https://app.unleash-hosted.com/demo/api/
Secret key: 56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d
```
Now you can open up your application code and create a connection to unleash using one of our [SDKs](../sdks). Here's an example using the NodeJS SDK:
Now you can open up your application code and create a connection to unleash using one of our [SDKs](sdks/index.md). Here's an example using the NodeJS SDK:
```javascript
const { initialize } = require('unleash-client');
@ -129,7 +129,7 @@ password: unleash4all
### Create your first toggle
In order to create a toggle through the UI, [you can follow this guide](./create_feature_toggle). Once you have created your feature toggle, you are ready to connect your application using an SDK.
In order to create a toggle through the UI, [you can follow this guide](create-feature-toggle.md). Once you have created your feature toggle, you are ready to connect your application using an SDK.
If you'd like to create your feature toggles with code, you can hit the create feature endpoint with the following command:
@ -159,9 +159,9 @@ http://CHANGEME/api/admin/features
### Connect your SDK
Next, find the navigation, open up the Admin panel and find the API Access tab. Click the "Add new api key" button and create a client key. This key can be used to connect to the instance with our [SDKs](../sdks).
Next, find the navigation, open up the Admin panel and find the API Access tab. Click the "Add new api key" button and create a client key. This key can be used to connect to the instance with our [SDKs](sdks/index.md).
You can find more [information about API keys here](./api-token).
You can find more [information about API keys here](token.md).
Now that you have your API key created, you have what you need to connect to the SDK (NodeJS example):
@ -199,7 +199,7 @@ The easiest way to run unleash locally is using [docker](https://www.docker.com/
Unleash should now be available on `http://localhost:4242`
[Click here to see all options to get started locally.](../deploy/getting_started)
[Click here to see all options to get started locally.](deploy/getting-started.md)
### Accessing your new instance
@ -212,7 +212,7 @@ password: unleash4all
### Create your first toggle
In order to create a toggle through the UI, [you can follow this guide](./create_feature_toggle). Once you have created your feature toggle, you are ready to connect your application using an SDK.
In order to create a toggle through the UI, [you can follow this guide](create-feature-toggle.md). Once you have created your feature toggle, you are ready to connect your application using an SDK.
If you'd like to create your feature toggles with code, you can hit the create feature endpoint with the following command:
@ -242,9 +242,9 @@ http://CHANGEME/api/admin/features
### Connect your SDK
Find the navigation, open up the Admin panel and find the API Access tab. Click the "Add new api key" button and create a client key. This key can be used to connect to the instance with our [SDKs](../sdks).
Find the navigation, open up the Admin panel and find the API Access tab. Click the "Add new api key" button and create a client key. This key can be used to connect to the instance with our [SDKs](sdks/index.md).
You can find more [information about API keys here](./api-token).
You can find more [information about API keys here](token.md).
Now that you have your API key created, you have what you need to connect to the SDK (NodeJS example):

View File

@ -7,7 +7,7 @@ Version 4 of Unleash brings a lot of improvements to Unleash. In this document w
### Upgrade with ease {#upgrade-with-ease}
Unleash can either be hosted by us or self-hosted. If you have a managed Unleash Enterprise instance you are automatically upgraded to version 4. If you manage Unleash yourself (either Open-Source or Enterprise Self-hosted) we recommend reading the [migration guide](../deploy/migration_guide).
Unleash can either be hosted by us or self-hosted. If you have a managed Unleash Enterprise instance you are automatically upgraded to version 4. If you manage Unleash yourself (either Open-Source or Enterprise Self-hosted) we recommend reading the [migration guide](deploy/migration-guide.md).
**PS! The first time you access Unleash v4 from a self-hosted instance you will need to login with the default admin user:**
@ -18,16 +18,16 @@ _(We recommend changing the password of the default user from the admin section.
### Role-Based Access Control {#role-based-access-control}
With Role-Based Access Control you can now assign groups to users in order to control access. You can control access to root resources in addition to controlling access to [projects](./projects). _Please be aware that all existing users will become "Owner" of all existing projects as part of the migration from v3 to v4._
With Role-Based Access Control you can now assign groups to users in order to control access. You can control access to root resources in addition to controlling access to [projects](projects.md). _Please be aware that all existing users will become "Owner" of all existing projects as part of the migration from v3 to v4._
[Read more](./rbac)
[Read more](rbac.md)
### New Addons {#new-addons}
Addons make it easy to integrate Unleash with other systems. In version 4 we bring two new integrations to Unleash:
- [Microsoft Teams](../addons/teams)
- [Datadog](../addons/datadog)
- [Datadog](addons/datadog.md)
### Improved UX {#improved-ux}
@ -41,14 +41,14 @@ In version 4 we added support for [OpenID Connect](https://openid.net/connect/)
In version 4 we improved the User Management and made it available for Unleash Open-Source and Unleash Enterprise. Starting in v4 all users accessing Unleash needs to exist in Unleash in order to gain access (because they need to have the proper permission from RBAC.)
[Read more](./user-management)
[Read more](user-management.md)
### API access {#api-access}
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](../advanced/api_access)
[Read more](advanced/api_access.md)
### Custom stickiness {#custom-stickiness}
In Unleash Enterprise v4 you can configure stickiness when you are doing a gradual rollout with the "flexible rollout" strategy or together with feature toggle variants. This means that you can now have consistent behavior based on any field available on the [Unleash context](./unleash_context).
In Unleash Enterprise v4 you can configure stickiness when you are doing a gradual rollout with the "flexible rollout" strategy or together with feature toggle variants. This means that you can now have consistent behavior based on any field available on the [Unleash context](unleash-context.md).