From c5493b3c310a5b0c4dd21243d70da403ae08a6fc Mon Sep 17 00:00:00 2001 From: melindafekete Date: Mon, 12 May 2025 18:19:40 +0200 Subject: [PATCH] fix more broken links and redirects --- website/docs/api-overview.mdx | 6 +-- .../implementing-feature-flags-django.md | 2 +- .../implementing-feature-flags-dotnet.md | 2 +- .../implementing-feature-flags-golang.md | 2 +- .../java/implementing-feature-flags.mdx | 2 +- ...spring-boot-implementing-feature-flags.mdx | 2 +- .../python/implementing-feature-flags.mdx | 2 +- .../rails/implementing-feature-flags-rails.md | 2 +- .../ruby/implementing-feature-flags-ruby.mdx | 2 +- .../rust/implementing-feature-flags-rust.md | 2 +- .../use-cases/a-b-testing.md | 2 +- .../use-cases/security-compliance.md | 2 +- website/docs/quickstart.mdx | 4 +- .../reference/api/legacy/unleash/index.md | 2 +- .../docs/topics/what-is-a-feature-flag.mdx | 2 +- .../understanding-unleash/unleash-overview.md | 6 +-- website/src/components/Homepage/APICards.tsx | 53 ------------------- .../src/components/Homepage/APIContent.tsx | 14 ----- website/src/components/Homepage/index.ts | 4 +- website/vercel.json | 9 +++- 20 files changed, 29 insertions(+), 93 deletions(-) delete mode 100644 website/src/components/Homepage/APICards.tsx delete mode 100644 website/src/components/Homepage/APIContent.tsx diff --git a/website/docs/api-overview.mdx b/website/docs/api-overview.mdx index 4ab86a5af2..7a84ea822c 100644 --- a/website/docs/api-overview.mdx +++ b/website/docs/api-overview.mdx @@ -4,8 +4,8 @@ description: "Unleash is the largest open-source feature management platform. In displayed_sidebar: documentation --- -import { APIContent, APICards } from "@site/src/components/Homepage/"; +## Frontend API - +## Client API - +## Admin API diff --git a/website/docs/feature-flag-tutorials/django/implementing-feature-flags-django.md b/website/docs/feature-flag-tutorials/django/implementing-feature-flags-django.md index 6825b5fe42..45fc322cda 100644 --- a/website/docs/feature-flag-tutorials/django/implementing-feature-flags-django.md +++ b/website/docs/feature-flag-tutorials/django/implementing-feature-flags-django.md @@ -18,7 +18,7 @@ For this tutorial, you'll need the following: ![architecture diagram for our implementation](../rails/diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. For server-side applications or automated scripts, Unleash exposes an [API](/reference/api/unleash) defined by an OpenAPI specification, allowing you to perform these actions programmatically. +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. For server-side applications or automated scripts, Unleash exposes an [API](/api-overview) defined by an OpenAPI specification, allowing you to perform these actions programmatically. ## 1. Install a local feature flag provider diff --git a/website/docs/feature-flag-tutorials/dotnet/implementing-feature-flags-dotnet.md b/website/docs/feature-flag-tutorials/dotnet/implementing-feature-flags-dotnet.md index 91c4142279..46daba54c0 100644 --- a/website/docs/feature-flag-tutorials/dotnet/implementing-feature-flags-dotnet.md +++ b/website/docs/feature-flag-tutorials/dotnet/implementing-feature-flags-dotnet.md @@ -24,7 +24,7 @@ For this tutorial, you’ll need the following: ![architecture diagram for our implementation](./diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](https://docs.getunleash.io/reference/api/unleash) to perform the same actions straight from your CLI or app. +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or app. ## 1. Install a local feature flag provider diff --git a/website/docs/feature-flag-tutorials/golang/implementing-feature-flags-golang.md b/website/docs/feature-flag-tutorials/golang/implementing-feature-flags-golang.md index 63d8dd6ff4..bfdd20c634 100644 --- a/website/docs/feature-flag-tutorials/golang/implementing-feature-flags-golang.md +++ b/website/docs/feature-flag-tutorials/golang/implementing-feature-flags-golang.md @@ -21,7 +21,7 @@ For this tutorial, you'll need the following: ![architecture diagram for our implementation](./diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. You can perform the same actions straight from your CLI or server-side app using the [Unleash API](/reference/api/unleash). +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. You can perform the same actions straight from your CLI or server-side app using the [Unleash API](/api-overview). ## Best practices for back-end apps with Unleash diff --git a/website/docs/feature-flag-tutorials/java/implementing-feature-flags.mdx b/website/docs/feature-flag-tutorials/java/implementing-feature-flags.mdx index 900bfbcceb..69f307b97d 100644 --- a/website/docs/feature-flag-tutorials/java/implementing-feature-flags.mdx +++ b/website/docs/feature-flag-tutorials/java/implementing-feature-flags.mdx @@ -37,7 +37,7 @@ In this tutorial, you will need the following: This architecture diagram breaks down how the Java app works with Unleash to control feature flags. We connect the Unleash service to your Java app using the Java SDK. -The Unleash Server acts as a Feature Flag Control Service, managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports the sending of data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. There are also [API commands available](https://docs.getunleash.io/reference/api/unleash) to perform the same actions straight from your CLI or server-side app. +The Unleash Server acts as a Feature Flag Control Service, managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports the sending of data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app. ## 1. Feature Flag best practices for backend apps diff --git a/website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.mdx b/website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.mdx index 2108f851f5..1149fb6dcb 100644 --- a/website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.mdx +++ b/website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.mdx @@ -38,7 +38,7 @@ In this tutorial, you will need the following: This architecture diagram breaks down how the Java Spring Boot app works with Unleash to use feature flags. -The Unleash Server is a Feature Flag Control Service for managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports sending data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. API commands are also [available](/reference/api/unleash) to perform the same actions from your CLI or server-side app. +The Unleash Server is a Feature Flag Control Service for managing and storing your feature flags. It enables the retrieval of flag data and, particularly when not utilizing a user interface, supports sending data to and from the service. The Unleash Server has a UI for creating and managing projects and feature flags. API commands are also [available](/api-overview) to perform the same actions from your CLI or server-side app. The Spring Boot SDK is an extension of the Java SDK, configured for Spring Boot-specific architecture and conventions. diff --git a/website/docs/feature-flag-tutorials/python/implementing-feature-flags.mdx b/website/docs/feature-flag-tutorials/python/implementing-feature-flags.mdx index 9a96c2b84f..20b9c7c7f4 100644 --- a/website/docs/feature-flag-tutorials/python/implementing-feature-flags.mdx +++ b/website/docs/feature-flag-tutorials/python/implementing-feature-flags.mdx @@ -43,7 +43,7 @@ In this tutorial, you will need the following: This architecture diagram breaks down how the Python app works with Unleash to control feature flags. We connect the Unleash service to your Python app using the Python SDK. -The Unleash Server is a **Feature Flag Control Service**, which is a service that manages your feature flags and is used to retrieve flag data from (and send data to, especially when not using a UI). The Unleash server has a UI for creating and managing projects and feature flags. There are also [API commands available](https://docs.getunleash.io/reference/api/unleash) to perform the same actions straight from your CLI or server-side app. +The Unleash Server is a **Feature Flag Control Service**, which is a service that manages your feature flags and is used to retrieve flag data from (and send data to, especially when not using a UI). The Unleash server has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app. ## 1. Unleash best practice for backend apps diff --git a/website/docs/feature-flag-tutorials/rails/implementing-feature-flags-rails.md b/website/docs/feature-flag-tutorials/rails/implementing-feature-flags-rails.md index 9b983f0dd8..0b58481e88 100644 --- a/website/docs/feature-flag-tutorials/rails/implementing-feature-flags-rails.md +++ b/website/docs/feature-flag-tutorials/rails/implementing-feature-flags-rails.md @@ -30,7 +30,7 @@ For this tutorial, you’ll need the following: ![architecture diagram for our implementation](./diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/reference/api/unleash) to perform the same actions straight from your CLI or server-side app. +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app. ## 1. Best practices for back-end apps with Unleash diff --git a/website/docs/feature-flag-tutorials/ruby/implementing-feature-flags-ruby.mdx b/website/docs/feature-flag-tutorials/ruby/implementing-feature-flags-ruby.mdx index 3d4a941136..1b8a30a5cd 100644 --- a/website/docs/feature-flag-tutorials/ruby/implementing-feature-flags-ruby.mdx +++ b/website/docs/feature-flag-tutorials/ruby/implementing-feature-flags-ruby.mdx @@ -35,7 +35,7 @@ For this tutorial, you’ll need the following: ![architecture diagram for our implementation](./diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](https://docs.getunleash.io/reference/api/unleash) to perform the same actions straight from your CLI or server-side app. +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or server-side app. ## 1. Best practices for back-end apps with Unleash diff --git a/website/docs/feature-flag-tutorials/rust/implementing-feature-flags-rust.md b/website/docs/feature-flag-tutorials/rust/implementing-feature-flags-rust.md index 477c4d62ba..5761fff328 100644 --- a/website/docs/feature-flag-tutorials/rust/implementing-feature-flags-rust.md +++ b/website/docs/feature-flag-tutorials/rust/implementing-feature-flags-rust.md @@ -26,7 +26,7 @@ For this tutorial, you’ll need the following: ![architecture diagram for our implementation](./diagram.png) -The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](https://docs.getunleash.io/reference/api/unleash) to perform the same actions straight from your CLI or app. +The Unleash Server is a **Feature Flag Control Service**, which manages your feature flags and lets you retrieve flag data. Unleash has a UI for creating and managing projects and feature flags. There are also [API commands available](/api-overview) to perform the same actions straight from your CLI or app. ## 1. Install a local feature flag provider diff --git a/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md b/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md index 9839e4b8f5..91b2a29e7f 100644 --- a/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md +++ b/website/docs/feature-flag-tutorials/use-cases/a-b-testing.md @@ -130,7 +130,7 @@ The output from the impression data in your app may look like this code snippet: } ``` -In order to capture impression events in your app, follow our [language and framework-specific tutorials](/languages-and-frameworks). +In order to capture impression events in your app, follow our [language and framework-specific tutorials](/feature-flag-tutorials/react). Now that your application is capturing impression events, you can configure the correct data fields and formatting to send to any analytics tool or data warehouse you use. diff --git a/website/docs/feature-flag-tutorials/use-cases/security-compliance.md b/website/docs/feature-flag-tutorials/use-cases/security-compliance.md index d03728d629..0461cf53a0 100644 --- a/website/docs/feature-flag-tutorials/use-cases/security-compliance.md +++ b/website/docs/feature-flag-tutorials/use-cases/security-compliance.md @@ -171,7 +171,7 @@ For more advanced implementations, integrate Unleash event logs directly into br ### Leverage access logs for broader auditing -Let’s think back to the importance of user management that we covered earlier. Developers and other stakeholders go through onboarding to use the platform. Authentication protocols and user provisioning ensure these processes are secure, unified, and automated. During this process, access logs keep track of what users and systems accessed Unleash and what actions they performed, including [Unleash API interactions](/reference/api/unleash) from your services and applications. You can export these logs to S3 buckets for long-term data storage. This is valuable if you need to preserve data for complying with legal or regulatory compliance, storing critical backups for disaster recovery, and archiving. +Let’s think back to the importance of user management that we covered earlier. Developers and other stakeholders go through onboarding to use the platform. Authentication protocols and user provisioning ensure these processes are secure, unified, and automated. During this process, access logs keep track of what users and systems accessed Unleash and what actions they performed, including [Unleash API interactions](/api-overview) from your services and applications. You can export these logs to S3 buckets for long-term data storage. This is valuable if you need to preserve data for complying with legal or regulatory compliance, storing critical backups for disaster recovery, and archiving. Auditing your feature flag system is made simple for traceability and reportability with Unleash’s event logs and access logs. We recommend leveraging these features as data sources for third-party services that make your data a valuable asset for security reviews, meeting compliance standards, and overall risk mitigation. diff --git a/website/docs/quickstart.mdx b/website/docs/quickstart.mdx index cc9a93e4cb..8d1a8d2201 100644 --- a/website/docs/quickstart.mdx +++ b/website/docs/quickstart.mdx @@ -121,6 +121,6 @@ unleash.on("synchronized", () => { ## Next steps -Check out our reference documentation that explains the [Unleash architecture](/understanding-unleash/unleash-overview), the different [hosting options](/understanding-unleash/hosting-options) available, and other [core concepts](/reference) you need to get the most out of Unleash. +Check out our reference documentation that explains the [Unleash architecture](/understanding-unleash/unleash-overview), the different [hosting options](/understanding-unleash/hosting-options) available, and other [core concepts](/reference/projects) you need to get the most out of Unleash. -Explore feature flag best practices and language-specific tutorials in our [developer guides](/topics). \ No newline at end of file +Explore feature flag best practices and language-specific tutorials in our [developer guides](/topics/feature-flags/feature-flag-best-practices). \ No newline at end of file diff --git a/website/docs/reference/api/legacy/unleash/index.md b/website/docs/reference/api/legacy/unleash/index.md index 939f7cd58f..c8c86c13db 100644 --- a/website/docs/reference/api/legacy/unleash/index.md +++ b/website/docs/reference/api/legacy/unleash/index.md @@ -5,7 +5,7 @@ title: Legacy API Documentation :::caution -The docs in this category are legacy documentation. You should prefer to use the [Unleash OpenAPI docs](/reference/api/unleash) instead whenever possible. +These APIs have been deprecared. Wse the [Unleash OpenAPI docs](/api-overview) reference instead. ::: diff --git a/website/docs/topics/what-is-a-feature-flag.mdx b/website/docs/topics/what-is-a-feature-flag.mdx index 0d7f17e653..aed8d711ab 100644 --- a/website/docs/topics/what-is-a-feature-flag.mdx +++ b/website/docs/topics/what-is-a-feature-flag.mdx @@ -211,7 +211,7 @@ The risk and cost of building software the old way are too high. When developers Unleash is on a mission to make developers’ lives easier. Individual developers love Unleash because it removes the pain of testing and deploying new features so they have more time and energy to innovate. Unleash is trusted by thousands of companies in production including Visa, Wayfair, Lloyd’s Banking Group, and Samsung. While we serve the needs of some of the world’s largest and most security-conscious organizations, we are also rated the *Easiest to Use in Feature Management software* by G2. If you want to learn more about how to implement feature flags at scale, check out the following resources: -- [Feature Flag Tutorials](/feature-flag-tutorials) +- [Feature Flag Tutorials](/feature-flag-tutorials/use-cases/gradual-rollout) - [Best practices for using feature flags at scale](./topics/feature-flags/best-practices-using-feature-flags-at-scale) - [Best practices for building and scaling feature flags](./topics/feature-flags/feature-flag-best-practices) - [Try Unleash for Free](https://www.getunleash.io/pricing) \ No newline at end of file diff --git a/website/docs/understanding-unleash/unleash-overview.md b/website/docs/understanding-unleash/unleash-overview.md index 9cceae135a..2bcea55f2a 100644 --- a/website/docs/understanding-unleash/unleash-overview.md +++ b/website/docs/understanding-unleash/unleash-overview.md @@ -69,13 +69,13 @@ Beyond scalability, Unleash Edge also offers privacy and security benefits for c #### Client API -The [Client API](/reference/api/unleash/client) is the API used by server-side SDKs to fetch feature flag configurations and send SDK usage metrics to Unleash. +The [Client API](/api-overview#client-api) is the API used by server-side SDKs to fetch feature flag configurations and send SDK usage metrics to Unleash. #### Frontend API -The [Frontend API](/reference/api/unleash/frontend-api) is the API used by client-side SDKs to retrieve all enabled feature flags for a given [Unleash Context](/reference/unleash-context) and send SDK usage metrics to Unleash. +The [Frontend API](/api-overview#frontend-api) is the API used by client-side SDKs to retrieve all enabled feature flags for a given [Unleash Context](/reference/unleash-context) and send SDK usage metrics to Unleash. #### Admin API -The [Admin API](/reference/api/unleash) is an API layer for managing all aspects of your Unleash instance, including creating, updating, and deleting resources, such as feature flags, activation strategies, and environments. This API is used by the [Unleash Admin UI](#the-unleash-admin-ui) and other tools and [integrations](/reference/integrations). +The [Admin API](/api-overview#admin-api) is an API layer for managing all aspects of your Unleash instance, including creating, updating, and deleting resources, such as feature flags, activation strategies, and environments. This API is used by the [Unleash Admin UI](#the-unleash-admin-ui) and other tools and [integrations](/reference/integrations). | API | Used by | Available endpoints | |---------------|---------|---| diff --git a/website/src/components/Homepage/APICards.tsx b/website/src/components/Homepage/APICards.tsx deleted file mode 100644 index 11faf1c7cc..0000000000 --- a/website/src/components/Homepage/APICards.tsx +++ /dev/null @@ -1,53 +0,0 @@ -import styles from './cards.module.css'; -import QuickstartIcon from './icons/quickstart.svg'; -import TutorialsIcon from './icons/tutorials.svg'; -import SdksIcon from './icons/sdks.svg'; -import AcademyIcon from './icons/academy.svg'; -import IntegrationsIcon from './icons/integrations.svg'; -import GetInTouchIcon from './icons/get-in-touch.svg'; - -const cardsData = [ - { - title: 'Frontend API', - description: 'Get up and running with Unleash in less than 5 minutes.', - icon: , - href: '/quickstart', - }, - { - title: 'Client API', - description: - 'Explore best practices and step-by-step tutorials to help you integrate Unleash into your stack.', - icon: , - href: '/feature-flag-tutorials/use-cases/gradual-rollout', - }, - { - title: 'Admin API', - description: - 'With over 30 SDKs, we enable fast and secure feature flagging across all major programming languages.', - icon: , - href: '/reference/sdks', - }, -]; - -const APICards = () => { - return ( -
- {cardsData.map((card, index) => ( - -
-
-
- {card.icon} -

{card.title}

-
- -

{card.description}

-
-
-
- ))} -
- ); -}; - -export default APICards; diff --git a/website/src/components/Homepage/APIContent.tsx b/website/src/components/Homepage/APIContent.tsx deleted file mode 100644 index 31a2d92b44..0000000000 --- a/website/src/components/Homepage/APIContent.tsx +++ /dev/null @@ -1,14 +0,0 @@ -import styles from './content.module.css'; -import VideoContent from '@site/src/components/VideoContent.jsx'; - -const APIContent = () => { - return ( -
-

- We have APIs. -

-
- ); -}; - -export default APIContent; diff --git a/website/src/components/Homepage/index.ts b/website/src/components/Homepage/index.ts index f88d0fea7c..c13f84423f 100644 --- a/website/src/components/Homepage/index.ts +++ b/website/src/components/Homepage/index.ts @@ -1,4 +1,2 @@ export { default as Cards } from './HomepageCards'; -export { default as Content } from './HomepageContent'; -export { default as APICards } from './APICards'; -export { default as APIContent } from './APIContent'; \ No newline at end of file +export { default as Content } from './HomepageContent'; \ No newline at end of file diff --git a/website/vercel.json b/website/vercel.json index 196b3eae14..bdd14d2d73 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -81,9 +81,14 @@ "destination": "/reference/events#event-types", "permanent": true }, + { + "source": "/reference/api/unleash", + "destination": "/api-overview", + "permanent": true + }, { "source": "/api/open_api", - "destination": "/reference/api/unleash", + "destination": "/api-overview", "permanent": true }, { @@ -858,7 +863,7 @@ }, { "source": "/languages-and-frameworks", - "destination": "/feature-flag-tutorials/use-cases/gradual-rollout", + "destination": "/feature-flag-tutorials/react", "permanent": true }, {