From f2ca6c581bdaf9c9918e17b039897b3c651341a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivar=20Conradi=20=C3=98sthus?= Date: Thu, 18 Jan 2018 08:47:42 +0100 Subject: [PATCH] Update migration-guide.md --- docs/migration-guide.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/migration-guide.md b/docs/migration-guide.md index 5f3c8b4dc7..fa5904d1c0 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -1,11 +1,13 @@ # Migrations guide -Generally the intention is that `unleash-server` should always provide support for clients one lower major version. This should make it easier to upgrade `unleash` gradually. +Generally the intention is that `unleash-server` should always provide support for clients one lower major version. This should make possible to upgrade `unleash` gradually. ## Upgrading from v2.x to v3.x -First your should upgrade the `unleash-server` to v3 (which still supports v2 clients). After this is done you should upgrade all your clients to v3. +The notable change introduced in Unleash v3.x is a strict separation of api paths for client requests and admin requests. This makes it easier to implement different authentication mechanisms for the admin UI and all unleash-clients. You can read more about [securing unleash](https://github.com/Unleash/unleash/blob/master/docs/securing-unleash.md). -After upgrading all your clients you should consider turning off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically) +The recommended approach is to first upgrade the `unleash-server` to v3 (which still supports v2 clients). After this is done you should upgrade all your clients to v3. + +After upgrading all your clients you should consider turning off legacy routes, used by v2 clients. Read more about this option in in the [gettings started guide](https://github.com/Unleash/unleash/blob/master/docs/getting-started.md#2-or-programmatically). ## Upgrading from v1.0 to v2.0