mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-05 17:53:12 +02:00
feat: preliminary outline
This commit is contained in:
Fredrik Oseberg
parent
0c62809d9f
commit
682c74c9f3
64
websitev2/docs/user_guide/quickstart.md
Normal file
64
websitev2/docs/user_guide/quickstart.md
Normal file
@ -0,0 +1,64 @@
|
||||
---
|
||||
id: quickstart
|
||||
title: Quickstart
|
||||
---
|
||||
|
||||
In this section we will attempt to guide you in order to get started with Unleash easily. There are multiple options to get started with unleash, browse the headings to find the method that works best for you.
|
||||
|
||||
## I just want to get started creating toggles without much setup
|
||||
|
||||
Usually, you'll need to set up an unleash instance in order to work with unleash. However, for testing purposes we have set up a demo instance that you can use in order to test out different use-cases before setting up your own instance. You can find the demo instance admin panel here: https://unleash.herokuapp.com/
|
||||
|
||||
### I want to test toggles in a client side environment
|
||||
|
||||
### I want to test toggles in a backend environment
|
||||
|
||||
#### 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.
|
||||
|
||||
#### Connecting to the unleash instance from your app
|
||||
|
||||
You'll need the following information in order to connect with an SDK:
|
||||
|
||||
```
|
||||
Api URL: https://unleash.herokuapp.com/api/
|
||||
Secret key: 3bd74da5b341d868443134377ba5d802ea1e6fa2d2a948276ade1f092bec8d92
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
const { initialize } = require('unleash-client');
|
||||
const unleash = initialize({
|
||||
url: 'http://unleash.herokuapp.com/api/',
|
||||
appName: 'my-app-name',
|
||||
instanceId: 'my-unique-instance-id',
|
||||
customHeaders: {
|
||||
Authorization: '3bd74da5b341d868443134377ba5d802ea1e6fa2d2a948276ade1f092bec8d92',
|
||||
},
|
||||
});
|
||||
|
||||
unleash.on('synchronized', () => {
|
||||
// Unleash is ready to serve updated feature toggles.
|
||||
|
||||
// Check a feature flag
|
||||
const isEnabled = unleash.isEnabled('some-toggle');
|
||||
|
||||
// Check the variant
|
||||
const variant = unleash.getVariant('app.ToggleY');
|
||||
});
|
||||
```
|
||||
|
||||
## I want to setup my own instance for testing purposes
|
||||
|
||||
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._
|
||||
|
||||
[Read more](./rbac)
|
||||
|
||||
## I want to set up a production ready instance
|
||||
|
||||
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)
|
||||
@ -10,90 +10,98 @@
|
||||
*/
|
||||
|
||||
module.exports = {
|
||||
"documentation": {
|
||||
"Getting started": [
|
||||
"user_guide/index",
|
||||
"user_guide/v4-whats-new",
|
||||
"user_guide/create_feature_toggle",
|
||||
"user_guide/activation_strategy",
|
||||
"user_guide/control_rollout",
|
||||
"user_guide/projects",
|
||||
"user_guide/unleash_context",
|
||||
"user_guide/user-management",
|
||||
"user_guide/rbac",
|
||||
"user_guide/api-token",
|
||||
"user_guide/technical_debt"
|
||||
documentation: {
|
||||
'Getting started': [
|
||||
'user_guide/index',
|
||||
'user_guide/quickstart',
|
||||
'user_guide/v4-whats-new',
|
||||
'user_guide/create_feature_toggle',
|
||||
'user_guide/activation_strategy',
|
||||
'user_guide/control_rollout',
|
||||
'user_guide/projects',
|
||||
'user_guide/unleash_context',
|
||||
'user_guide/user-management',
|
||||
'user_guide/rbac',
|
||||
'user_guide/api-token',
|
||||
'user_guide/technical_debt',
|
||||
],
|
||||
"Unleash SDKs": [
|
||||
"sdks/index",
|
||||
"sdks/java_sdk",
|
||||
"sdks/node_sdk",
|
||||
"sdks/dot_net_sdk",
|
||||
"sdks/go_sdk",
|
||||
"sdks/python_sdk",
|
||||
"sdks/ruby_sdk",
|
||||
"sdks/unleash-proxy",
|
||||
"sdks/android_proxy_sdk",
|
||||
"sdks/proxy-javascript",
|
||||
"sdks/proxy-ios",
|
||||
"sdks/community"
|
||||
'Unleash SDKs': [
|
||||
'sdks/index',
|
||||
'sdks/java_sdk',
|
||||
'sdks/node_sdk',
|
||||
'sdks/dot_net_sdk',
|
||||
'sdks/go_sdk',
|
||||
'sdks/python_sdk',
|
||||
'sdks/ruby_sdk',
|
||||
'sdks/unleash-proxy',
|
||||
'sdks/android_proxy_sdk',
|
||||
'sdks/proxy-javascript',
|
||||
'sdks/proxy-ios',
|
||||
'sdks/community',
|
||||
],
|
||||
"Addons": [
|
||||
"addons/index",
|
||||
"addons/webhook",
|
||||
"addons/slack",
|
||||
"addons/teams",
|
||||
"addons/datadog"
|
||||
Addons: [
|
||||
'addons/index',
|
||||
'addons/webhook',
|
||||
'addons/slack',
|
||||
'addons/teams',
|
||||
'addons/datadog',
|
||||
],
|
||||
Advanced: [
|
||||
'advanced/strategy_constraints',
|
||||
'advanced/custom_activation_strategy',
|
||||
'advanced/feature_toggle_types',
|
||||
'advanced/toggle_variants',
|
||||
'advanced/archived_toggles',
|
||||
'advanced/audit_log',
|
||||
'advanced/api_access',
|
||||
'advanced/tags',
|
||||
'advanced/enterprise-authentication',
|
||||
],
|
||||
"Advanced": [
|
||||
"advanced/strategy_constraints",
|
||||
"advanced/custom_activation_strategy",
|
||||
"advanced/feature_toggle_types",
|
||||
"advanced/toggle_variants",
|
||||
"advanced/archived_toggles",
|
||||
"advanced/audit_log",
|
||||
"advanced/api_access",
|
||||
"advanced/tags",
|
||||
"advanced/enterprise-authentication"
|
||||
]
|
||||
},
|
||||
"api": {
|
||||
"Introduction": ["api/index", "api/internal/internal", "api/internal/health","api/open_api"],
|
||||
"Admin API": [
|
||||
"api/admin/features",
|
||||
"api/admin/features-archive",
|
||||
"api/admin/strategies",
|
||||
"api/admin/metrics",
|
||||
"api/admin/events",
|
||||
"api/admin/state",
|
||||
"api/admin/feature-types",
|
||||
"api/admin/addons",
|
||||
"api/admin/context",
|
||||
"api/admin/projects",
|
||||
"api/admin/user-admin"
|
||||
api: {
|
||||
Introduction: [
|
||||
'api/index',
|
||||
'api/internal/internal',
|
||||
'api/internal/health',
|
||||
'api/open_api',
|
||||
],
|
||||
"Client SDK API": [
|
||||
"api/client/features",
|
||||
"api/client/register",
|
||||
"api/client/metrics"
|
||||
'Admin API': [
|
||||
'api/admin/features',
|
||||
'api/admin/features-archive',
|
||||
'api/admin/strategies',
|
||||
'api/admin/metrics',
|
||||
'api/admin/events',
|
||||
'api/admin/state',
|
||||
'api/admin/feature-types',
|
||||
'api/admin/addons',
|
||||
'api/admin/context',
|
||||
'api/admin/projects',
|
||||
'api/admin/user-admin',
|
||||
],
|
||||
'Client SDK API': [
|
||||
'api/client/features',
|
||||
'api/client/register',
|
||||
'api/client/metrics',
|
||||
],
|
||||
|
||||
},
|
||||
"Deploy and manage": {
|
||||
"Deploy & configure": [
|
||||
"deploy/getting_started",
|
||||
"deploy/configuring_unleash",
|
||||
"deploy/securing_unleash",
|
||||
"deploy/email",
|
||||
"deploy/google_auth",
|
||||
"deploy/database-setup",
|
||||
"deploy/database_backup",
|
||||
"deploy/migration_guide",
|
||||
"deploy/import_export",
|
||||
]
|
||||
'Deploy and manage': {
|
||||
'Deploy & configure': [
|
||||
'deploy/getting_started',
|
||||
'deploy/configuring_unleash',
|
||||
'deploy/securing_unleash',
|
||||
'deploy/email',
|
||||
'deploy/google_auth',
|
||||
'deploy/database-setup',
|
||||
'deploy/database_backup',
|
||||
'deploy/migration_guide',
|
||||
'deploy/import_export',
|
||||
],
|
||||
},
|
||||
Integrations: {
|
||||
Integrations: ['integrations/integrations'],
|
||||
JIRA: [
|
||||
'integrations/jira_plugin_installation',
|
||||
'integrations/jira_plugin_usage',
|
||||
],
|
||||
},
|
||||
"Integrations": {
|
||||
"Integrations": ["integrations/integrations"],
|
||||
"JIRA": ["integrations/jira_plugin_installation", "integrations/jira_plugin_usage"]
|
||||
}
|
||||
};
|
||||
|
||||
Loading…
Reference in New Issue
Block a user