1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

chore: more docs

This commit is contained in:
Ivar Conradi Østhus 2021-02-26 07:49:31 +01:00
parent 24d2aa5dea
commit 620d0f53d0
No known key found for this signature in database
GPG Key ID: 31AC596886B0BD09
9 changed files with 26 additions and 12 deletions

View File

@ -3,9 +3,8 @@ id: api_access
title: API Access title: API Access
--- ---
> **Enterprise feature** > **Enterprise**
> > This guide is only relevant if your are using Unleash-hosted.
> Programmatic access to the Unleash API s only available with the Unleash Enterprise offering and is not part of Unleash Open-Source.
It is possible to integrate directly with the Admin API. In this guide we will explain all the steps to set it up. It is possible to integrate directly with the Admin API. In this guide we will explain all the steps to set it up.

View File

@ -3,4 +3,17 @@ id: archived_toggles
title: Archived toggles title: Archived toggles
--- ---
Archived toggles In unleash you may choose to "archive" a feature toggle when it is not needed anymore. You do this by clicking the "Archive" button on the feature toggle details view. By archiving a feature toggle it will not be available to Client SDKs anymore.
![Archive Toggle](../assets/archive-toggle.png 'Archiving a Feature Toggle').
You will not be able to "fully delete a feature toggle". The reason for this is to avoid old toggles suddenly "waking up again". This could, in worst case, re-activate old functionality in code where the use of the feature toggle has not been cleaned up yet.
## Reviving a feature toggle
If you want to re-use a feature toggle which has been archived you may revive in from the archive. You do that by clicking the "revive icon". Please not that revived toggles will be "disabled" when they are active again.
![Revive Toggle](../assets/archive-toggle-revive.png 'Reviving a Feature Toggle').

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

View File

@ -3,6 +3,8 @@ id: securing_unleash
title: Securing Unleash title: Securing Unleash
--- ---
> This guide is only relevant if you are using Unleash Open-Source. The Enterprise edition does already ship with a secure setup and multiple SSO options.
The Unleash API is split into two different paths: `/api/client` and `/api/admin`. This makes it easy to have different authentication strategy for the admin interface and the client-api used by the applications integrating with Unleash. The Unleash API is split into two different paths: `/api/client` and `/api/admin`. This makes it easy to have different authentication strategy for the admin interface and the client-api used by the applications integrating with Unleash.
## General settings ## General settings

View File

@ -190,13 +190,13 @@
} }
}, },
"links": { "links": {
"Enterprise": "Enterprise",
"Documentation": "Documentation", "Documentation": "Documentation",
"API": "API",
"Deploy and manage": "Deploy and manage", "Deploy and manage": "Deploy and manage",
"Integrations": "Integrations", "Integrations": "Integrations",
"Contribute": "Contribute", "Contribute": "Contribute",
"Help": "Help" "API": "API",
"Help": "Help",
"Enterprise": "Enterprise"
}, },
"categories": { "categories": {
"Getting started": "Getting started", "Getting started": "Getting started",

View File

@ -24,7 +24,7 @@ class Help extends React.Component {
const supportLinks = [ const supportLinks = [
{ {
content: `Learn more using the [documentation on this site.](${docUrl( content: `Learn more using the [documentation on this site.](${docUrl(
'getting_started', 'user_guide/connect_sdk',
language, language,
)})`, )})`,
title: 'Browse Docs', title: 'Browse Docs',

View File

@ -193,9 +193,9 @@ const SASSOffering = () => (
const UnleashClient = () => ( const UnleashClient = () => (
<Container padding={['bottom', 'top']} id="unleash-client" background={'light'}> <Container padding={['bottom', 'top']} id="unleash-client" background={'light'}>
<h2>Client implementations</h2> <h2>Client SDK</h2>
<p> <p>
Unleash has official SDK's for Java, Node.js, Go, Ruby, Python and .Net. And we will be happy to add implementations in other languages written by you! These libraries make it very easy to use Unleash in your application. Unleash has official SDK for Java, Node.js, Go, Ruby, Python and .Net. And we will be happy to add implementations in other languages written by you! These libraries make it very easy to use Unleash in your application.
</p> </p>
<div className="gridBlock"> <div className="gridBlock">

View File

@ -66,12 +66,12 @@ const siteConfig = {
// For no header links in the top nav bar -> headerLinks: [], // For no header links in the top nav bar -> headerLinks: [],
headerLinks: [ headerLinks: [
{ href: 'https://www.unleash-hosted.com/open-source', label: 'Enterprise' },
{ doc: 'user_guide/connect_sdk', label: 'Documentation' }, { doc: 'user_guide/connect_sdk', label: 'Documentation' },
{ doc: 'api/client/features', label: 'API' },
{ doc: 'deploy/getting_started', label: 'Deploy and manage' }, { doc: 'deploy/getting_started', label: 'Deploy and manage' },
{ doc: 'integrations/integrations', label: 'Integrations' }, { doc: 'integrations/integrations', label: 'Integrations' },
{ doc: 'developer_guide', label: 'Contribute' }, { doc: 'developer_guide', label: 'Contribute' },
{ doc: 'api/client/features', label: 'API' },
{ href: 'https://www.unleash-hosted.com/open-source', label: 'Enterprise' },
{ page: 'help', label: 'Help' }, { page: 'help', label: 'Help' },
// {blog: true, label: 'Blog'}, // {blog: true, label: 'Blog'},
], ],