From 9a99e2e445b159b965749ae83d46329b585f9291 Mon Sep 17 00:00:00 2001 From: melindafekete Date: Wed, 19 Nov 2025 16:09:53 +0100 Subject: [PATCH] Move how-to guides to guides --- src/lib/openapi/util/openapi-tags.ts | 2 +- .../how-to-create-feature-toggles.md | 2 +- .../use-cases/organize-feature-flags.mdx | 2 +- website/docs/guides-overview.mdx | 4 +-- .../how-to-create-api-tokens.mdx | 0 .../how-to-run-the-unleash-proxy.mdx | 0 .../how-to-schedule-feature-releases.mdx | 0 .../how-to-synchronize-unleash-instances.md | 0 .../unleash-edge-quickstart.md | 2 +- website/docs/oss-comparison.mdx | 2 +- .../api/legacy/unleash/admin/addons.md | 2 -- .../api/legacy/unleash/admin/archive.md | 3 --- .../api/legacy/unleash/admin/context.md | 2 -- .../api/legacy/unleash/admin/events.mdx | 6 ----- .../api/legacy/unleash/admin/feature-types.md | 2 -- .../api/legacy/unleash/admin/features-v2.mdx | 6 ----- .../api/legacy/unleash/admin/features.md | 5 ---- .../api/legacy/unleash/admin/metrics.md | 2 -- .../api/legacy/unleash/admin/projects.md | 2 -- .../api/legacy/unleash/admin/segments.mdx | 5 ---- .../api/legacy/unleash/admin/state.md | 3 +-- .../api/legacy/unleash/admin/strategies.md | 1 - .../api/legacy/unleash/admin/tags.md | 2 -- .../api/legacy/unleash/admin/user-admin.md | 2 -- .../api/legacy/unleash/client/features.md | 2 +- .../api/legacy/unleash/client/metrics.md | 1 - .../api/legacy/unleash/client/register.md | 2 -- .../reference/environment-import-export.mdx | 2 +- .../import-export.mdx} | 0 .../docs/using-unleash/compliance/fedramp.mdx | 2 +- .../deploy/upgrading-unleash.mdx | 4 +-- website/remote-content/sdks.js | 4 +-- website/sidebars.ts | 8 +++--- website/vercel.json | 26 ++++++++++++++++--- 34 files changed, 42 insertions(+), 66 deletions(-) rename website/docs/{how-to => guides}/how-to-create-api-tokens.mdx (100%) rename website/docs/{how-to => guides}/how-to-run-the-unleash-proxy.mdx (100%) rename website/docs/{how-to => guides}/how-to-schedule-feature-releases.mdx (100%) rename website/docs/{how-to => guides}/how-to-synchronize-unleash-instances.md (100%) rename website/docs/{how-to => guides}/unleash-edge-quickstart.md (99%) rename website/docs/{how-to/how-to-environment-import-export.mdx => reference/import-export.mdx} (100%) diff --git a/src/lib/openapi/util/openapi-tags.ts b/src/lib/openapi/util/openapi-tags.ts index c32f93e758..f1c5211da5 100644 --- a/src/lib/openapi/util/openapi-tags.ts +++ b/src/lib/openapi/util/openapi-tags.ts @@ -72,7 +72,7 @@ const OPENAPI_TAGS = [ { name: 'Import/Export', description: - '[Import and export](https://docs.getunleash.io/how-to/how-to-environment-import-export) the state of your Unleash instance.', + '[Import and export](https://docs.getunleash.io/reference/import-export) the state of your Unleash instance.', }, { name: 'Instance Admin', diff --git a/website/docs/feature-flag-tutorials/use-cases/how-to-create-feature-toggles.md b/website/docs/feature-flag-tutorials/use-cases/how-to-create-feature-toggles.md index 0759dec8a8..a2ddee2ef6 100644 --- a/website/docs/feature-flag-tutorials/use-cases/how-to-create-feature-toggles.md +++ b/website/docs/feature-flag-tutorials/use-cases/how-to-create-feature-toggles.md @@ -2,7 +2,7 @@ title: Create and configure a feature flag description: 'This guide shows you how to create feature flags in Unleash and how to add constraints, segments, variants, and more.' slug: /how-to-create-feature-flag -pagination_next: how-to/how-to-schedule-feature-releases +pagination_next: guides/how-to-schedule-feature-releases --- [Feature flags](../reference/feature-toggles) are a foundational component of Unleash, enabling you to manage features dynamically. This guide details the process of creating and configuring feature flags within Unleash. You'll learn how to create flags, define activation strategies, enable them, and optionally refine their behavior with constraints, segments, and variants. diff --git a/website/docs/feature-flag-tutorials/use-cases/organize-feature-flags.mdx b/website/docs/feature-flag-tutorials/use-cases/organize-feature-flags.mdx index e4dea263c0..0c7195ed03 100644 --- a/website/docs/feature-flag-tutorials/use-cases/organize-feature-flags.mdx +++ b/website/docs/feature-flag-tutorials/use-cases/organize-feature-flags.mdx @@ -135,7 +135,7 @@ A common challenge is managing a single feature that spans multiple services (fo - **Use separate, coordinated flags**: If the services are owned by different teams and have different release cadences, it's better to create separate flags in their respective projects. This prevents one team from impacting another's release. The rollout can then be coordinated across teams using release templates. ## Evolve your structure -Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/how-to/how-to-environment-import-export) functionality or the [Admin API](/api-overview). +Remember that your initial project and environment structure is not set in stone. Unleash is flexible. You can add new environments, create new projects, and even move flags between them later. For larger migrations, you can use the [Import/Export](/reference/import-export) functionality or the [Admin API](/api-overview). The system is designed to evolve with your organization, so don't be afraid to start with a simple setup and refactor as your needs change. diff --git a/website/docs/guides-overview.mdx b/website/docs/guides-overview.mdx index 9115bfbd97..af0bc7f3c4 100644 --- a/website/docs/guides-overview.mdx +++ b/website/docs/guides-overview.mdx @@ -29,10 +29,10 @@ From trunk-based development to gradual rollouts, these tutorials show how to re Learn more: - [Create a feature flag](/how-to-create-feature-flag) -- [Schedule a feature release](/how-to/how-to-schedule-feature-releases) +- [Schedule a feature release](/guides/how-to-schedule-feature-releases) - [Trunk-based development](/feature-flag-tutorials/use-cases/trunk-based-development) - [Gradual rollout](/feature-flag-tutorials/use-cases/gradual-rollout) -- [Unleash Edge quickstart](/how-to/unleash-edge-quickstart) +- [Unleash Edge quickstart](/guides/unleash-edge-quickstart) --- ## Enterprise-grade security and scale diff --git a/website/docs/how-to/how-to-create-api-tokens.mdx b/website/docs/guides/how-to-create-api-tokens.mdx similarity index 100% rename from website/docs/how-to/how-to-create-api-tokens.mdx rename to website/docs/guides/how-to-create-api-tokens.mdx diff --git a/website/docs/how-to/how-to-run-the-unleash-proxy.mdx b/website/docs/guides/how-to-run-the-unleash-proxy.mdx similarity index 100% rename from website/docs/how-to/how-to-run-the-unleash-proxy.mdx rename to website/docs/guides/how-to-run-the-unleash-proxy.mdx diff --git a/website/docs/how-to/how-to-schedule-feature-releases.mdx b/website/docs/guides/how-to-schedule-feature-releases.mdx similarity index 100% rename from website/docs/how-to/how-to-schedule-feature-releases.mdx rename to website/docs/guides/how-to-schedule-feature-releases.mdx diff --git a/website/docs/how-to/how-to-synchronize-unleash-instances.md b/website/docs/guides/how-to-synchronize-unleash-instances.md similarity index 100% rename from website/docs/how-to/how-to-synchronize-unleash-instances.md rename to website/docs/guides/how-to-synchronize-unleash-instances.md diff --git a/website/docs/how-to/unleash-edge-quickstart.md b/website/docs/guides/unleash-edge-quickstart.md similarity index 99% rename from website/docs/how-to/unleash-edge-quickstart.md rename to website/docs/guides/unleash-edge-quickstart.md index e6af089854..0da5ae32ef 100644 --- a/website/docs/how-to/unleash-edge-quickstart.md +++ b/website/docs/guides/unleash-edge-quickstart.md @@ -1,6 +1,6 @@ --- title: Unleash Edge quickstart -slug: /how-to/unleash-edge-quickstart + --- import Tabs from '@theme/Tabs'; diff --git a/website/docs/oss-comparison.mdx b/website/docs/oss-comparison.mdx index c2b0a82d1f..2383dfd01e 100644 --- a/website/docs/oss-comparison.mdx +++ b/website/docs/oss-comparison.mdx @@ -59,7 +59,7 @@ This page highlights the key differences between Unleash OSS and Unleash Enterpr | Capability | OSS | Enterprise | |-------------|-----|-------------| -| [Export / import](/how-to/how-to-environment-import-export) | ✅ | ✅ | +| [Export / import](/reference/import-export) | ✅ | ✅ | | [Terraform provider](/reference/terraform) | ✅ | ✅ | | Multi-region [Enterprise Edge](/understanding-unleash/hosting-options#unleash-edge-options) | ❌ | Available as an add-on | | [Webhooks and integrations](/reference/integrations) | ✅ | ✅ | diff --git a/website/docs/reference/api/legacy/unleash/admin/addons.md b/website/docs/reference/api/legacy/unleash/admin/addons.md index 2e7a4c8bfc..0fd0ac8bd5 100644 --- a/website/docs/reference/api/legacy/unleash/admin/addons.md +++ b/website/docs/reference/api/legacy/unleash/admin/addons.md @@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - ### List integrations and providers {#list-integrations-and-providers} `GET https://unleash.host.com/api/admin/addons` diff --git a/website/docs/reference/api/legacy/unleash/admin/archive.md b/website/docs/reference/api/legacy/unleash/admin/archive.md index 2c4c140a98..e034f24f3a 100644 --- a/website/docs/reference/api/legacy/unleash/admin/archive.md +++ b/website/docs/reference/api/legacy/unleash/admin/archive.md @@ -6,9 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - - ### Revive feature flag {#revive-feature-toggle} `POST http://unleash.host.com/api/admin/archive/revive/:featureName` diff --git a/website/docs/reference/api/legacy/unleash/admin/context.md b/website/docs/reference/api/legacy/unleash/admin/context.md index cd9669dfed..a42d0b29a6 100644 --- a/website/docs/reference/api/legacy/unleash/admin/context.md +++ b/website/docs/reference/api/legacy/unleash/admin/context.md @@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain a API token](/how-to/how-to-create-api-tokens) with admin permissions. - ### List context fields defined in Unleash {#list-context-fields-defined-in-unleash} `GET https://unleash.host.com/api/admin/context` diff --git a/website/docs/reference/api/legacy/unleash/admin/events.mdx b/website/docs/reference/api/legacy/unleash/admin/events.mdx index 791e923ebd..9d28650c16 100644 --- a/website/docs/reference/api/legacy/unleash/admin/events.mdx +++ b/website/docs/reference/api/legacy/unleash/admin/events.mdx @@ -8,12 +8,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -:::note - -In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - -::: - The Events API lets you retrieve [events](/reference/events.mdx) from your Unleash instance. ## Event endpoints diff --git a/website/docs/reference/api/legacy/unleash/admin/feature-types.md b/website/docs/reference/api/legacy/unleash/admin/feature-types.md index 8478e34aab..357fd758f5 100644 --- a/website/docs/reference/api/legacy/unleash/admin/feature-types.md +++ b/website/docs/reference/api/legacy/unleash/admin/feature-types.md @@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - # Feature Types API `GET: http://unleash.host.com/api/admin/feature-types` diff --git a/website/docs/reference/api/legacy/unleash/admin/features-v2.mdx b/website/docs/reference/api/legacy/unleash/admin/features-v2.mdx index 57a7fdf545..c798af7826 100644 --- a/website/docs/reference/api/legacy/unleash/admin/features-v2.mdx +++ b/website/docs/reference/api/legacy/unleash/admin/features-v2.mdx @@ -6,12 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; - -:::info -In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an **admin** token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. -::: - - ## Fetching Feature Flags {#fetching-feature-toggles} diff --git a/website/docs/reference/api/legacy/unleash/admin/features.md b/website/docs/reference/api/legacy/unleash/admin/features.md index 09b9c1268b..b7276cd77f 100644 --- a/website/docs/reference/api/legacy/unleash/admin/features.md +++ b/website/docs/reference/api/legacy/unleash/admin/features.md @@ -13,11 +13,6 @@ Most of this API was removed in Unleash v5 (after being deprecated since Unleash ::: -:::info -In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an **admin** token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. -::: - - ## Fetching Feature Flags {#fetching-feature-toggles} :::caution Deprecation notice diff --git a/website/docs/reference/api/legacy/unleash/admin/metrics.md b/website/docs/reference/api/legacy/unleash/admin/metrics.md index 53244803ef..df07f7f057 100644 --- a/website/docs/reference/api/legacy/unleash/admin/metrics.md +++ b/website/docs/reference/api/legacy/unleash/admin/metrics.md @@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - # This document describes the metrics endpoint for admin ui ### Seen-toggles {#seen-toggles} diff --git a/website/docs/reference/api/legacy/unleash/admin/projects.md b/website/docs/reference/api/legacy/unleash/admin/projects.md index c62ac5ff59..340b5dfe28 100644 --- a/website/docs/reference/api/legacy/unleash/admin/projects.md +++ b/website/docs/reference/api/legacy/unleash/admin/projects.md @@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you [obtain an API token](/how-to/how-to-create-api-tokens) with admin permissions. - ### List projects in Unleash {#list-projects-in-unleash} `GET https://unleash.host.com/api/admin/projects` diff --git a/website/docs/reference/api/legacy/unleash/admin/segments.mdx b/website/docs/reference/api/legacy/unleash/admin/segments.mdx index 2ac382c0a6..e943035e66 100644 --- a/website/docs/reference/api/legacy/unleash/admin/segments.mdx +++ b/website/docs/reference/api/legacy/unleash/admin/segments.mdx @@ -14,11 +14,6 @@ import ApiRequest from '@site/src/components/ApiRequest'; export const basePath ::: -:::note - -To use the admin API, you'll need to [create and use an admin API token](/how-to/how-to-create-api-tokens). - -::: The segments API lets you create, read, update, and delete [segments](/reference/segments). diff --git a/website/docs/reference/api/legacy/unleash/admin/state.md b/website/docs/reference/api/legacy/unleash/admin/state.md index 25600f3f02..1a87325688 100644 --- a/website/docs/reference/api/legacy/unleash/admin/state.md +++ b/website/docs/reference/api/legacy/unleash/admin/state.md @@ -9,11 +9,10 @@ import SearchPriority from '@site/src/components/SearchPriority'; :::caution Removal notice -Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](/how-to/how-to-environment-import-export). +Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](/reference/import-export). ::: -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. ### Export Feature Flags & Strategies {#export-feature-toggles--strategies} diff --git a/website/docs/reference/api/legacy/unleash/admin/strategies.md b/website/docs/reference/api/legacy/unleash/admin/strategies.md index fe44997dae..77691bf43e 100644 --- a/website/docs/reference/api/legacy/unleash/admin/strategies.md +++ b/website/docs/reference/api/legacy/unleash/admin/strategies.md @@ -6,7 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. ### Fetch Strategies {#fetch-strategies} diff --git a/website/docs/reference/api/legacy/unleash/admin/tags.md b/website/docs/reference/api/legacy/unleash/admin/tags.md index 755da9d96b..2671f33c45 100644 --- a/website/docs/reference/api/legacy/unleash/admin/tags.md +++ b/website/docs/reference/api/legacy/unleash/admin/tags.md @@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - ### Create a new tag {#create-a-new-tag} `POST https://unleash.host.com/api/admin/tags` diff --git a/website/docs/reference/api/legacy/unleash/admin/user-admin.md b/website/docs/reference/api/legacy/unleash/admin/user-admin.md index a1bc915dee..8d303d4be8 100644 --- a/website/docs/reference/api/legacy/unleash/admin/user-admin.md +++ b/website/docs/reference/api/legacy/unleash/admin/user-admin.md @@ -6,8 +6,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - ### List all users {#list-all-users} `GET https://unleash.host.com/api/admin/user-admin` diff --git a/website/docs/reference/api/legacy/unleash/client/features.md b/website/docs/reference/api/legacy/unleash/client/features.md index 79ac544f13..4bff15020c 100644 --- a/website/docs/reference/api/legacy/unleash/client/features.md +++ b/website/docs/reference/api/legacy/unleash/client/features.md @@ -6,7 +6,7 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens.mdx) and add an Authorization header using the token. +> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/guides/how-to-create-api-tokens.mdx) and add an Authorization header using the token. ### Fetching Feature Flags {#fetching-feature-toggles} diff --git a/website/docs/reference/api/legacy/unleash/client/metrics.md b/website/docs/reference/api/legacy/unleash/client/metrics.md index c85c2b5191..67878f751f 100644 --- a/website/docs/reference/api/legacy/unleash/client/metrics.md +++ b/website/docs/reference/api/legacy/unleash/client/metrics.md @@ -7,7 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. ### Send metrics {#send-metrics} diff --git a/website/docs/reference/api/legacy/unleash/client/register.md b/website/docs/reference/api/legacy/unleash/client/register.md index b36643d768..c11de62d13 100644 --- a/website/docs/reference/api/legacy/unleash/client/register.md +++ b/website/docs/reference/api/legacy/unleash/client/register.md @@ -7,8 +7,6 @@ import SearchPriority from '@site/src/components/SearchPriority'; -> In order to access the client API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create a Backend token](/how-to/how-to-create-api-tokens) and add an Authorization header using the token. - ### Client registration {#client-registration} `POST: http://unleash.host.com/api/client/register` diff --git a/website/docs/reference/environment-import-export.mdx b/website/docs/reference/environment-import-export.mdx index d6ce64e85b..65eb64b4e0 100644 --- a/website/docs/reference/environment-import-export.mdx +++ b/website/docs/reference/environment-import-export.mdx @@ -14,7 +14,7 @@ import SearchPriority from '@site/src/components/SearchPriority'; :::caution Removal notice -Api admin state is deprecated from version 5 and removed from version 6. We recommend using the new [Environment Import & Export](/how-to/how-to-environment-import-export). +Api admin state is deprecated from version 5 and removed from version 6. We recommend using the new [Environment Import & Export](/reference/import-export). ::: diff --git a/website/docs/how-to/how-to-environment-import-export.mdx b/website/docs/reference/import-export.mdx similarity index 100% rename from website/docs/how-to/how-to-environment-import-export.mdx rename to website/docs/reference/import-export.mdx diff --git a/website/docs/using-unleash/compliance/fedramp.mdx b/website/docs/using-unleash/compliance/fedramp.mdx index 5ac31b4454..30ae72dbe3 100644 --- a/website/docs/using-unleash/compliance/fedramp.mdx +++ b/website/docs/using-unleash/compliance/fedramp.mdx @@ -36,7 +36,7 @@ This guide provides an overview of how [Unleash Enterprise](https://www.getunlea | **FedRAMP Control** | **Unleash Feature** | |--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [CM-02 Baseline Configuration](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-2) | Unleash provides [Export](/how-to/how-to-environment-import-export) functionality that facilitates keeping a configuration snapshot of feature flags and related entities in the audit records. Instance-wide configurations, such as projects, users, and roles, can be managed and restored using the [Unleash Terraform provider](/reference/terraform). | +| [CM-02 Baseline Configuration](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-2) | Unleash provides [Export](/reference/import-export) functionality that facilitates keeping a configuration snapshot of feature flags and related entities in the audit records. Instance-wide configurations, such as projects, users, and roles, can be managed and restored using the [Unleash Terraform provider](/reference/terraform). | | [CM-05 Access Restrictions for Change](https://csrc.nist.gov/projects/cprt/catalog#/cprt/framework/version/SP_800_53_5_1_0/home?element=CM-5) | Unleash provides advanced [role-based access control](/reference/rbac) (RBAC) controls to implement logical access restrictions. [Change Requests](/reference/change-requests) help you define and track approval flows. | ## Identification and Authentication diff --git a/website/docs/using-unleash/deploy/upgrading-unleash.mdx b/website/docs/using-unleash/deploy/upgrading-unleash.mdx index cae850b96f..3f9fae19c9 100644 --- a/website/docs/using-unleash/deploy/upgrading-unleash.mdx +++ b/website/docs/using-unleash/deploy/upgrading-unleash.mdx @@ -171,7 +171,7 @@ Consider migrating to [Unleash Enterprise](https://www.getunleash.io/pricing) to - The Unleash Edge metrics endpoint `/edge/metrics` has been removed. If you use Unleash Edge, ensure your Edge instances are upgraded to **version 19.1.3 or later** before upgrading the Unleash server to v6 to maintain metrics collection. Core flag evaluation will still work with older Edge versions. - The legacy feature endpoint `/api/feature`, [deprecated in v4](#legacy-v2-routes-removed), has been removed. Update any integrations still using this endpoint. -- Deprecated import service: The older file-based import functionality at startup has been removed. Use the current [environment import/export features](/how-to/how-to-environment-import-export) or associated APIs. +- Deprecated import service: The older file-based import functionality at startup has been removed. Use the current [environment import/export features](/reference/import-export) or associated APIs. ### Dropped Internet Explorer support @@ -275,7 +275,7 @@ Follow along with our video demonstration on upgrading from v3 to v5 with no dow In Unleash Open Source v3, client SDKs did not require an API token to connect to the Unleash server. Starting with v4, API token handling, previously an Enterprise feature, was added to the Open Source version. This means that all client SDKs now need to use a client token to connect to Unleash. -Read more in the [API token documentation](../../how-to/how-to-create-api-tokens). +Read more in the [API token documentation](/guides/how-to-create-api-tokens). ### Configuring Unleash diff --git a/website/remote-content/sdks.js b/website/remote-content/sdks.js index 9b31ae9c20..55cd7d053c 100644 --- a/website/remote-content/sdks.js +++ b/website/remote-content/sdks.js @@ -101,8 +101,8 @@ const SDKS = (() => { const getAdmonitions = (sdk) => { const admonitions = { - [FRONTEND_SDKS]: `To connect to Unleash from a frontend application, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`, - [BACKEND_SDKS]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https:///api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#backend-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`, + [FRONTEND_SDKS]: `To connect to Unleash from a frontend application, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/guides/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`, + [BACKEND_SDKS]: `To connect to Unleash, you'll need your Unleash API url (e.g. \`https:///api\`) and a [backend API token](/reference/api-tokens-and-client-keys.mdx#backend-tokens) ([how do I create an API token?](/guides/how-to-create-api-tokens.mdx)).`, }; const wrap = (text) => `:::tip\n${text}\n:::`; diff --git a/website/sidebars.ts b/website/sidebars.ts index f94eddb002..011c328b84 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -181,7 +181,7 @@ const sidebars: SidebarsConfig = { { type: 'doc', label: 'Import and export', - id: 'how-to/how-to-environment-import-export', + id: 'reference/import-export', }, ], }, @@ -235,7 +235,7 @@ const sidebars: SidebarsConfig = { { type: 'doc', label: 'Schedule a feature release', - id: 'how-to/how-to-schedule-feature-releases', + id: 'guides/how-to-schedule-feature-releases', }, { type: 'doc', @@ -250,7 +250,7 @@ const sidebars: SidebarsConfig = { { type: 'doc', label: 'Unleash Edge quickstart', - id: 'how-to/unleash-edge-quickstart', + id: 'guides/unleash-edge-quickstart', }, ], }, @@ -611,7 +611,7 @@ const sidebars: SidebarsConfig = { { type: 'doc', label: 'Synchronize Unleash instances', - id: 'how-to/how-to-synchronize-unleash-instances', + id: 'guides/how-to-synchronize-unleash-instances', }, ], }, diff --git a/website/vercel.json b/website/vercel.json index 9ef73db82a..9e9fd1fffe 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -48,7 +48,27 @@ }, { "source": "/how-to/how-to-create-api-tokens", - "destination": "/reference/api-tokens-and-client-keys#create-an-api-token", + "destination": "/guides/how-to-create-api-tokens", + "permanent": true + }, + { + "source": "/how-to/how-to-run-the-unleash-proxy", + "destination": "/guides/how-to-run-the-unleash-proxy", + "permanent": true + }, + { + "source": "/how-to/how-to-schedule-feature-releases", + "destination": "/guides/how-to-schedule-feature-releases", + "permanent": true + }, + { + "source": "/how-to/how-to-synchronize-unleash-instances", + "destination": "/guides/how-to-synchronize-unleash-instances", + "permanent": true + }, + { + "source": "/how-to/unleash-edge-quickstart", + "destination": "/guides/unleash-edge-quickstart", "permanent": true }, { @@ -1093,12 +1113,12 @@ }, { "source": "/reference/deploy/environment-import-export", - "destination": "/how-to/how-to-environment-import-export", + "destination": "/reference/import-export", "permanent": true }, { "source": "/deploy/environment-import-export", - "destination": "/how-to/how-to-environment-import-export", + "destination": "/reference/import-export", "permanent": true }, {