diff --git a/.github/Logo_DarkBlue_Transparent_Portrait.png b/.github/Logo_DarkBlue_Transparent_Portrait.png new file mode 100644 index 0000000000..0147b1080b Binary files /dev/null and b/.github/Logo_DarkBlue_Transparent_Portrait.png differ diff --git a/.github/dashboard.png b/.github/dashboard.png new file mode 100644 index 0000000000..dd56b9f9ff Binary files /dev/null and b/.github/dashboard.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a79593f81..fc8d690f13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ Fork with [GitHub Codespaces](https://github.com/features/codespaces): ### Make your update: -Make your changes to the file(s) you'd like to update. You'll need **Node.js v14** and PostgreSQL 10 to run Unleash locally. [See more details](https://github.com/Unleash/unleash/tree/master/docs/contributing/developer-guide.md) +Make your changes to the file(s) you'd like to update. You'll need **Node.js v14** and PostgreSQL 10 to run Unleash locally. [See more details](https://github.com/Unleash/unleash/tree/master/websitev2/docs/contributing/developer-guide.md) ### Open a pull request diff --git a/README.md b/README.md index 05d49dd69c..4c27168780 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,62 @@ +
+ +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash) + +![Build & Tests](https://github.com/Unleash/unleash/workflows/Build%20%26%20Tests/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash?branch=master) + - + +
+Unleash the open-source feature management platform. It provides a great overview over all feature toggles/flags across all your applications and services. Unleash enables software teams all over the world to take full control on how they enabled new functionality to end users. -![Build & Tests](https://github.com/Unleash/unleash/workflows/Build%20%26%20Tests/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash?branch=master) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://www.heroku.com/deploy/?template=https://github.com/Unleash/unleash) +Unleash comes with [official client SDKs](https://docs.getunleash.io/sdks) for all the popular languages. -Unleash is a open source feature flag & toggle system, that gives you a great overview over all feature toggles across all your applications and services. It comes with official client implementations for Java, Node.js, Go, Ruby, Python and .NET Core. +## Features -## Unleash-enterprise [:link:](https://www.unleash-hosted.com/pricing) +- Boolean feature toggles (on/off) +- Canary release (Gradual rollout) +- Targeted release +- Experimentation (A/B testing) +- Kill Switches +- Custom activation strategies +- Privacy first (GDPR) where end-user data never leaves your application +- Audit logs +- Addons integrating with other popular tools (Slack, Teams, Datadog, etc.) +- It is secure (Enable Secure Headers with strict HTTPS only mode) +- High performance with evaluations on the client side [read more in our docs](https://docs.getunleash.io/) +- Dashboard to manage technical debt +- Admin APIs -Unleash is also available in an enterprise edition, which builds on top of the open-source version, with additional features. Go to [unleash-hosted.com](https://www.unleash-hosted.com/pricing) to learn more about the enterprise offering. +In addition we have built [Unleash Enterprise](https://www.getunleash.io/plans) with additional advanced functionality: + +- Project support +- Advanced segmentation +- Support +- SSO (SAML 2.0, OpenID Connect, etc) +- A Hosted offering where the Unleash team host, monitor, scale, upgrades and take full backups for your. + +## Client SDKs + +In order to connect your application to Unleash you need to use a client SDK for your programming language. + +**Official Server SDKs**: + +- [Java SDK](https://docs.getunleash.io/sdks/java_sdk) +- [Node.js SDK](https://docs.getunleash.io/sdks/node_sdk) +- [Go SDK](https://docs.getunleash.io/sdks/go_sdk) +- [Ruby SDK](https://docs.getunleash.io/sdks/ruby_sdk) +- [Python SDK](https://docs.getunleash.io/sdks/python_sdk) +- [.Net SDK](https://docs.getunleash.io/sdks/dot_net_sdk) + +**Official Frontend [Unleash Proxy](https://docs.getunleash.io/sdks/unleash-proxy) SDKs:** + +- [Javascript SDK](https://docs.getunleash.io/sdks/proxy-javascript) +- [Android SDK](https://docs.getunleash.io/sdks/android_proxy_sdk) +- [iOS Proxy SDK](https://docs.getunleash.io/sdks/proxy-ios) + +In addition there exists a good list of [community developed SDKs](https://docs.getunleash.io/sdks/community), so there might already exist an implementation for your favorite programming language (PHP, Elixir, Dart, Rust, Clojure, NestJS, Kotlin and more.) ## What is a feature toggle? @@ -17,11 +64,11 @@ The main motivation for doing feature toggling is to decouple the process for de > Feature toggles decouple **deployment** of code from **release** of new features -This repo contains the unleash-server, which contains the admin UI and a place to ask for the status of features. In order to make use of unleash you will also need a client implementation. +This repo contains the unleash-server, which contains the Unleash Admin UI and the Unleash API. In order to make use of unleash you will also need a client SDK. -Unleash UI +Unleash Admin UI -[Online demo version available on heroku](https://unleash.herokuapp.com/#/features). +[Online demo](https://app.unleash-hosted/demo) ## Activation strategies @@ -36,37 +83,9 @@ Common activation strategies includes: Read more about [activation strategies in our docs](https://docs.getunleash.io/docs/user_guide/activation_strategy). -## Variants +## The Client API -Sometimes you need more control than just a boolean flag. Variants provides this and can be used in combination of feature toggles and allow you to return multiple variants from a feature toggle, if it is enabled. - -## Client implementations - -We have official SDK's for Java, Node.js, Go, Ruby and Python. And we will be happy to add implementations in other languages written by you! These libraries makes it very easy to use Unleash in you application. - -Official client SDK's: - -- [unleash/unleash-client-java](https://github.com/unleash/unleash-client-java) -- [unleash/unleash-client-node](https://github.com/unleash/unleash-client-node) -- [unleash/unleash-client-go](https://github.com/unleash/unleash-client-go) -- [unleash/unleash-client-ruby](https://github.com/unleash/unleash-client-ruby) -- [unleash/unleash-client-python](https://github.com/Unleash/unleash-client-python) -- [unleash/unleash-client-dotnet](https://github.com/Unleash/unleash-client-dotnet) - -Clients written by awesome enthusiasts: :fire: - -- [cognitedata/unleash-client-rust](https://github.com/cognitedata/unleash-client-rust) (Rust) -- [silvercar/unleash-client-kotlin](https://github.com/silvercar/unleash-client-kotlin) (Kotlin) -- [uekoetter.dev/unleash-client-dart](https://pub.dev/packages/unleash) (Dart) -- [minds/unleash-client-php](https://gitlab.com/minds/unleash-client-php) (PHP) -- [afontaine/unleash_ex](https://gitlab.com/afontaine/unleash_ex) (Elixir) -- [mikefrancis/laravel-unleash](https://github.com/mikefrancis/laravel-unleash) (Laravel - PHP) -- [AppsFlyer/clojure-unleash](https://github.com/AppsFlyer/unleash-client-clojure) (Clojure) -- [pmb0/nestjs-unleash](https://github.com/pmb0/nestjs-unleash) (NestJS - Node.js) - -### The Client API - -The client SDKs provides a simple abstraction making it easy to check feature toggles in your application. The code snippet below shows how you would use `Unleash` in Java. +The [client SDKs](https://docs.getunleash.io/sdks) provides a simple abstraction making it easy to check feature toggles in your application. The code snippet below shows how you would use `Unleash` in Java. ```java if (unleash.isEnabled("AwesomeFeature")) { @@ -82,17 +101,15 @@ if (unleash.isEnabled("AwesomeFeature")) { Unleash is open source and you are free to run your own instance. Please refer to the [getting-started-guide](https://docs.getunleash.io/docs/deploy/getting_started) to learn how to run the Unleash Service. -We have made a separate project which runs Unleash inside docker. Please see [unleash-docker](https://github.com/Unleash/unleash-docker) for details - ## Unleash as a Service (SaaS) After numerous request we have created a separate company, Unleash-hosted, which offer Unleash as a Service. Unleash-hosted allows you to focus on you core business and have someone else taking care of hosting and maintaining Unleash. -Go to [unleash-hosted.com](https://www.unleash-hosted.com/pricing) to learn more about this offering and start using Unleash today. This service also includes official support. +Go to [getunleash.io](https://www.getunleash.io/plans) to learn more about this offering and start using Unleash today. This service also includes official support. # Developer Guide -If you want to contribute to this project you are encouraged to send issue request, or provide pull-requests. Please read the [unleash developer guide](./docs/contributing/developer-guide.md) to learn more on how you can contribute. +If you want to contribute to this project you are encouraged to send issue request, or provide pull-requests. Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) to learn more on how you can contribute. # I Need help @@ -103,11 +120,10 @@ If you want to contribute to this project you are encouraged to send issue reque - [Utviklerpodden, 1 - Feature Flags og Unleash med Fredrik Oseberg](https://pod.space/utviklerpodden/feature-flags-og-unleash-med-fredrik-oseberg) (Norwegian) - [Node Weekly issue 380](https://nodeweekly.com/issues/380) -- [Console 42 - The open-source newsletter](https://console.substack.com/p/console-42) +- [Console 42 - The open-source newsletter](https://console.substack.com/p/console-42) - [This Week in Rust 340](https://this-week-in-rust.org/blog/2020/05/27/this-week-in-rust-340/) - [Unleash-hosted - Unleash as a Service](https://www.unleash-hosted.com) - [Medium blog](https://medium.com/unleash-hosted) - [Blog: Unleash your features gradually!](http://bytes.schibsted.com/unleash-features-gradually/) - [Presentation: Unleash your features gradually!](http://ivarconr.github.io/feature-toggles-presentation/sch-dev-lunch-2017/#1) - http://martinfowler.com/bliki/FeatureToggle.html - diff --git a/websitev2/docs/addons/addons.md b/websitev2/docs/addons/addons.md index fa8fc37aeb..f39079fac6 100644 --- a/websitev2/docs/addons/addons.md +++ b/websitev2/docs/addons/addons.md @@ -1,6 +1,6 @@ --- id: index -title: Addons Introduction +title: Introduction --- > This feature was introduced in _Unleash v3.11.0_. diff --git a/websitev2/docs/advanced/strategy-constraints.md b/websitev2/docs/advanced/strategy-constraints.md index 194719f67b..ae6c18c198 100644 --- a/websitev2/docs/advanced/strategy-constraints.md +++ b/websitev2/docs/advanced/strategy-constraints.md @@ -3,9 +3,7 @@ id: strategy_constraints title: Strategy Constraints --- -> **Enterprise feature** -> -> Strategy constraints is only available with the Unleash-hosted offering and is not part of Unleash Open-Source. +> Strategy constraints is part of Unleash Enterprise. Strategy constraints allow you to set pre-conditions on activation strategies that needs to be satisfied for the activation strategies to take effect. diff --git a/websitev2/docs/sdks/community.md b/websitev2/docs/sdks/community.md index 6b040028a4..7800e449bc 100644 --- a/websitev2/docs/sdks/community.md +++ b/websitev2/docs/sdks/community.md @@ -1,6 +1,6 @@ --- id: community -title: Community SDKs... +title: Community SDKs ♥ --- We from the Unleash teams take care of a handful of official SDKs for all the major programming languages. diff --git a/websitev2/docs/sdks/index.md b/websitev2/docs/sdks/index.md index 20887b63da..f06dd7af04 100644 --- a/websitev2/docs/sdks/index.md +++ b/websitev2/docs/sdks/index.md @@ -17,7 +17,7 @@ On this page you will find examples for connecting your application to the demo - [Python SDK](/sdks/python_sdk) - [.Net SDK](/sdks/dot_net_sdk) -**Official Frontend Proxy SDKs:** +**Official Frontend Unleash Proxy SDKs:** - [Javascript SDK](/sdks/proxy-javascript) - [Android SDK](/sdks/android_proxy_sdk) diff --git a/websitev2/docs/user_guide/index.md b/websitev2/docs/user_guide/index.md index f61359b09c..086bcb4cf8 100644 --- a/websitev2/docs/user_guide/index.md +++ b/websitev2/docs/user_guide/index.md @@ -5,18 +5,18 @@ slug: / sidebar_position: 1 --- -Welcome to the Unleash getting started guides. We know that getting to know a new solution might be tedious. Our goal with this documentation is to guide you through the most essential concepts of Unleash. +Welcome to the Unleash documentation. We know that getting to know a new solution might be tedious. Our goal with our documentation is to guide you through the most essential concepts of Unleash. -One of the most important aspects of the architecture to understand is that feature toggles are evaluated in a client SDKs which runs as part of your application. This makes toggle evaluations super-fast, but of course it compromises a small update-delay when you change your toggle configurations (in terms of seconds and is configurable). +One of the most important aspects of the architecture to understand is that feature toggles _are evaluated in a client SDKs_ which runs as part of your application. This makes toggle evaluations super-fast, but of course it compromises a small update-delay when you change your toggle configurations (in terms of seconds and is configurable). -We recommend that you read about [our unique architecture](https://www.unleash-hosted.com/articles/our-unique-architecture) to understand some of the basics of the architecture. +If you want more details you cam read about [our unique architecture](https://www.unleash-hosted.com/articles/our-unique-architecture). ## Unleash Server {#unleash-server} -Before you can connect your application to Unleash you need a Unleash server. You have a few options available. +Before you can connect your application to Unleash you need a Unleash server. You have a few options available: 1. [Unleash Open-source - Self-managed](deploy/getting_started) -2. [Unleash Enterprise - Cloud-hosted](https://www.getunleash.io) +2. [Unleash Enterprise - Cloud-hosted](https://www.getunleash.io/plans) 3. [Unleash Enterprise - Self-hosted](https://www.getunleash.io) ## System Overview {#system-overview} diff --git a/websitev2/docusaurus.config.js b/websitev2/docusaurus.config.js index aecba19b49..de9f9abd87 100644 --- a/websitev2/docusaurus.config.js +++ b/websitev2/docusaurus.config.js @@ -24,7 +24,7 @@ module.exports = { { to: "deploy/getting_started", label: "Deploy and manage" }, { to: "integrations/integrations", label: "Integrations" }, { to: "/api", label: "API" }, - { href: "https://www.getunleash.io/plans", label: "Enterprise", position: 'right' }, + { href: "https://www.getunleash.io/plans", label: "Unleash Enterprise", position: 'right' }, { href: 'https://github.com/Unleash/unleash', position: 'right', diff --git a/websitev2/sidebars.js b/websitev2/sidebars.js index 163401e6e2..faf4d44d02 100644 --- a/websitev2/sidebars.js +++ b/websitev2/sidebars.js @@ -38,7 +38,7 @@ module.exports = { "sdks/proxy-ios", "sdks/community" ], - "Addons framework": [ + "Addons": [ "addons/index", "addons/webhook", "addons/slack", @@ -89,7 +89,7 @@ module.exports = { "deploy/database-setup", "deploy/database_backup", "deploy/migration_guide", - "deploy/import_export" + "deploy/import_export", ] }, "Integrations": { diff --git a/websitev2/src/css/custom.css b/websitev2/src/css/custom.css index ac5509db36..10c5d02c59 100644 --- a/websitev2/src/css/custom.css +++ b/websitev2/src/css/custom.css @@ -16,6 +16,7 @@ --ifm-color-primary-lightest: #4a6c76; --ifm-code-font-size: 95%; --ifm-font-size-base: 16px; + --ifm-link-color: blue; } .docusaurus-highlight-code-line { background-color: rgb(72, 77, 91); diff --git a/websitev2/static/img/Symbol_DarkBlue_Transparent.svg b/websitev2/static/img/Symbol_DarkBlue_Transparent.svg new file mode 100644 index 0000000000..b79f917031 --- /dev/null +++ b/websitev2/static/img/Symbol_DarkBlue_Transparent.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/websitev2/static/img/Symbol_White_Transparent.svg b/websitev2/static/img/Symbol_White_Transparent.svg new file mode 100644 index 0000000000..86084db7fa --- /dev/null +++ b/websitev2/static/img/Symbol_White_Transparent.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/websitev2/static/img/logo.png b/websitev2/static/img/logo.png index fa390f9ae4..6ca67a49dd 100644 Binary files a/websitev2/static/img/logo.png and b/websitev2/static/img/logo.png differ diff --git a/websitev2/static/img/logo.svg b/websitev2/static/img/logo.svg index 86084db7fa..b79f917031 100644 --- a/websitev2/static/img/logo.svg +++ b/websitev2/static/img/logo.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/websitev2/static/img/unleash_logo.png b/websitev2/static/img/unleash_logo.png index fa390f9ae4..6ca67a49dd 100644 Binary files a/websitev2/static/img/unleash_logo.png and b/websitev2/static/img/unleash_logo.png differ