Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Code Issues Projects Releases Wiki Activity

chore: update anchor toggle titles (#7145)

Browse Source 
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

- update anchor link descriptions
- fix ordered lists across files
- formatting updates

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->
This commit is contained in:
Nnenna Ndukwe 2024-05-24 07:41:04 -04:00 committed by GitHub
parent 4ae65d6d5e
commit 2bbd541f51
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 39 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
website/docs/feature-flag-tutorials/dotnet/implementing-feature-flags-dotnet.md
View File

@ -8,13 +8,11 @@ Hello! In this tutorial we’ll show you how to add feature flags to your .NET a
We’ll keep with the sci-fi theme of our previous tutorials and use the [Rick and Morty API](https://rickandmortyapi.com/documentation/#introduction), with a .NET web API project. We’ll use feature flags to decide whether to call the REST or the GraphQL version of the API.
- [Prerequisites](#prerequisites)
- [1. Install a local feature flag provider](#1-install-a-local-feature-flag-provider)
- [2. Grab a list of characters from the Rick and Morty API](#2-grab-a-list-of-characters-from-the-rick-and-morty-api)
- [4. Add the GraphQL endpoint](#4-add-the-graphql-endpoint)
- [5. Add Unleash to your .NET app](#5-add-unleash-to-your-net-app)
- [6. Verify the toggle experience](#6-verify-the-toggle-experience)
- [Conclusion](#conclusion)
1. [Install a local feature flag provider](#1-install-a-local-feature-flag-provider)
2. [Grab a list of characters from the Rick and Morty API](#2-grab-a-list-of-characters-from-the-rick-and-morty-api)
3. [Add the GraphQL endpoint](#3-add-the-graphql-endpoint)
4. [Add Unleash to your .NET app](#4-add-unleash-to-your-net-app)
5. [Verify the feature flag experience](#5-verify-the-toggle-experience)
## Prerequisites
@ -150,7 +148,7 @@ dotnet watch --hotreload run
You should see `There are 20 characters` in your terminal.
## 4. Add the GraphQL endpoint
## 3. Add the GraphQL endpoint
The point of this tutorial is to mimic a real-world scenario where you would migrate from a REST API to GraphQL and rely on a boolean feature flag to toggle between the versions. There will be no change in functionality between the API versions.
@ -211,7 +209,7 @@ You should see `Hello GraphQL`, followed by `There are 20 characters` in your te
Feel free to change the `isGraphql` variable to try it out.
## 5. Add Unleash to your .NET app
## 4. Add Unleash to your .NET app
Now, let’s connect our project to Unleash so that you can toggle that feature flag at runtime. If you wanted to, you could also do a gradual rollout, use it for A/B testing, etc.
@ -277,7 +275,7 @@ Now, let’s add our client to our project, grab the feature flag from Unleash,
See additional use cases in our [.NET SDK](https://docs.getunleash.io/reference/sdks/dotnet) documentation.
## 6. Verify the toggle experience
## 5. Verify the toggle experience
Now that we’ve connected our project to Unleash and grabbed our feature flag, we can verify that if you disable that flag in your development environment, you stop seeing the `Hello GraphQL` message.

14
website/docs/feature-flag-tutorials/flutter/a-b-testing.md
View File

@ -1,6 +1,6 @@
---
title: A/B Testing in Flutter using Unleash and Mixpanel
slug: '/feature-flag-tutorials/flutter/a-b-testing'
slug: "/feature-flag-tutorials/flutter/a-b-testing"
---
:::note
@ -18,11 +18,11 @@ Here’s a screenshot of the application:
## Setup variants in Unleash
In your Unleash instance, create a new feature flag called `likeOptionExperiment`. Choose the toggle type called `Experiment` and enable the [impression data](https://docs.getunleash.io/reference/impression-data). By default, the flag will be set to false.
In your Unleash instance, create a new feature flag called `likeOptionExperiment`. Choose the flag type called `Experiment` and enable the [impression data](https://docs.getunleash.io/reference/impression-data). By default, the flag will be set to false.
![Set Up Variant in Unleash](/img/variant-setup-1.png)
Now that you have created your feature toggle, let’s create two new [variants](https://docs.getunleash.io/reference/feature-toggle-variants) “gridTile'' and “imageDetails” respectively. These variants will help you position your “like image” button.
Now that you have created your feature flag, let’s create two new [variants](https://docs.getunleash.io/reference/feature-toggle-variants) “gridTile'' and “imageDetails” respectively. These variants will help you position your “like image” button.
![Succesfully setting up variant in Unleash](/img/setup-variant-2.png)
@ -381,9 +381,9 @@ A/B testing is a low-risk, high-returns approach that can help you make data-dri
Some of the best practices for experimentation include:
- You should be open to the results and avoid any hypotheses.
- You should define the metrics for the success of the experimentation before you run the tests. Keep your success metrics simple and narrowed for better results.
- Select a group of adequate size for the test to yield definitive results.
- You should avoid running multiple tests simultaneously, as it may not give reasonable outcomes.
- You should be open to the results and avoid any hypotheses.
- You should define the metrics for the success of the experimentation before you run the tests. Keep your success metrics simple and narrowed for better results.
- Select a group of adequate size for the test to yield definitive results.
- You should avoid running multiple tests simultaneously, as it may not give reasonable outcomes.
That’s it for today. I hope you found this helpful. Want to dive deep into the code used for this article? It’s all on [GitHub](https://github.com/AyushBherwani1998/unsplash_sample/).

4
website/docs/feature-flag-tutorials/java/implementing-feature-flags.md
View File

@ -18,7 +18,7 @@ Here are the steps we will cover in this tutorial:
3. [Configure a feature flag](#3-create-and-configure-the-feature-flag)
4. [Add Unleash to a Java app](#4-add-unleash-to-a-java-app)
5. [Log a feature flag status in your Java app](#5-log-feature-flag-status-in-java-app)
6. [Verify the toggle experience](#6-verify-the-toggle-experience)
6. [Verify the feature flag experience](#6-verify-the-toggle-experience)
Watch the video tutorial and follow along with the code from this documentation.
@ -239,7 +239,7 @@ With the flag on, you should see the corresponding status in this screenshot:
We will use Unleash to turn off the flag and view an updated status in the Terminal.
In Unleash, toggle off the `endpointFlag` in the development environment.
In Unleash, turn off the `endpointFlag` in the development environment.
![Turn off the flag in the development environment.](/img/java-tutorial-disable-flag.png)

2
website/docs/feature-flag-tutorials/java/spring-boot-implementing-feature-flags.md
View File

@ -18,7 +18,7 @@ Here are the steps we will cover in this tutorial:
3. [Configure a feature flag](#3-create-and-configure-the-feature-flag)
4. [Add Unleash to a Spring Boot app](#4-add-unleash-to-a-spring-boot-app)
5. [Configure Spring Beans in your Spring Boot app](#5-configure-spring-beans-in-your-app)
6. [Verify the toggle experience](#5-configure-spring-beans-in-your-app)
6. [Verify the feature flag experience](#6-verify-the-feature-flag-experience)
Watch the video tutorial and follow along with the code from this documentation.

26
website/docs/feature-flag-tutorials/python/examples.md
View File

@ -7,17 +7,17 @@ In our [Python feature flag tutorial](/feature-flag-tutorials/python), we implem
We built multiple features into Unleash, an open-source feature flag platform, to address the complexities of releasing code and managing feature flags along the way. This tutorial will explore the following:
- [Gradual Rollouts for Python Apps](#gradual-rollouts-for-python-apps)
- [Canary Deployments in Python](#canary-deployments-in-python)
- [What is a canary deployment?](#what-is-a-canary-deployment)
- [How to do canary deployments with a Python feature flag?](#how-to-do-canary-deployments-with-a-python-feature-flag)
- [Configure strategy constraints for canary deployments](#configure-strategy-constraints-for-canary-deployments)
- [Server-side A/B Testing in Python](#server-side-ab-testing-in-python)
- [Feature Flag Analytics and Reporting in Python](#feature-flag-analytics-and-reporting-in-python)
- [Enable impression data events in Python](#enable-impression-data-events-in-python)
- [Application Metrics \& Monitoring for Python](#application-metrics--monitoring-for-python)
- [Feature Flag Audit Logs in Python](#feature-flag-audit-logs-in-python)
- [Flag Automation \& Workflow Integration for Python Apps](#flag-automation--workflow-integration-for-python-apps)
- [Gradual Rollouts for Python Apps](#gradual-rollouts-for-python-apps)
- [Canary Deployments in Python](#canary-deployments-in-python)
- [What is a canary deployment?](#what-is-a-canary-deployment)
- [How to do canary deployments with a Python feature flag?](#how-to-do-canary-deployments-with-a-python-feature-flag)
- [Configure strategy constraints for canary deployments](#configure-strategy-constraints-for-canary-deployments)
- [Server-side A/B Testing in Python](#server-side-ab-testing-in-python)
- [Feature Flag Analytics and Reporting in Python](#feature-flag-analytics-and-reporting-in-python)
- [Enable impression data events in Python](#enable-impression-data-events-in-python)
- [Application Metrics \& Monitoring for Python](#application-metrics--monitoring-for-python)
- [Feature Flag Audit Logs in Python](#feature-flag-audit-logs-in-python)
- [Flag Automation \& Workflow Integration for Python Apps](#flag-automation--workflow-integration-for-python-apps)
## Gradual Rollouts for Python Apps
@ -271,11 +271,11 @@ At the flag level in Unleash, navigate to the Settings view.
![From your flag page in Unleash, you go to Settings and edit the settings for your flag called 'feature information'.](/img/python-ex-flag-settings.png)
In the Settings view, there's an edit button with pencil icon. This will take us to the ‘Edit Feature toggle’ form.
In the Settings view, there's an edit button with pencil icon. This will take us to the ‘Edit Feature flag’ form.
Turn on the impression data and then save it. Events will now be emitted every time the feature flag is triggered.
![There is a toggle that turns on the impression data events in your flag form.](/img/python-ex-enable-impression-data.png)
![There is a flag that turns on the impression data events in your flag form.](/img/python-ex-enable-impression-data.png)
You can also use our API command to enable the impression data:

2
website/docs/feature-flag-tutorials/python/implementing-feature-flags.md
View File

@ -24,7 +24,7 @@ Here are the steps we will cover in this tutorial:
3. [Configure a feature flag](#3-create-and-configure-the-feature-flag)
4. [Add Unleash to a Python Flask app](#4-add-unleash-to-a-python-app)
5. [Toggle the database deletion route](#5-use-a-feature-flag-to-roll-out-a-delete-method)
6. [Verify the toggle experience](#6-verify-the-toggle-experience)
6. [Verify the feature flag experience](#6-verify-the-toggle-experience)
7. [Improve feature flag error handling](#7-improve-a-feature-flag-implementation-with-error-handling)
Watch the video tutorial and follow along with the code from this documentation.

2
website/docs/feature-flag-tutorials/react/implementing-feature-flags.md
View File

@ -22,7 +22,7 @@ Along the way, you will:
3. [Configure a feature flag](#3-create-enable-and-configure-a-feature-flag)
4. [Clone an open-source React app](#4-clone-an-open-source-react-app)
5. [Toggle the visibility of a feature component](#5-use-the-feature-flag-to-rollout-a-notifications-badge)
6. [Verify the toggle experience](#6-verify-the-toggle-experience)
6. [Verify the feature flag experience](#6-verify-the-toggle-experience)
Watch the video tutorial and follow along with the code from this documentation.

14
website/docs/feature-flag-tutorials/ruby/implementing-feature-flags-ruby.md
View File

@ -8,14 +8,12 @@ Hello! In this tutorial we’ll show you how to add feature flags to your Ruby a
In a classic tutorial fashion, we’ll get a list of planets from the [Star Wars API](https://swapi.dev/), with just Ruby (i.e., not Ruby on Rails). We’ll use feature flags to decide whether to call the REST or the GraphQL version of the API.
- [Prerequisites](#prerequisites)
- [1. Best practices for backend apps with Unleash](#1-best-practices-for-backend-apps-with-unleash)
- [2. Install a local feature flag provider](#2-install-a-local-feature-flag-provider)
- [3. Grab a list of planets from the Star Wars API](#3-grab-a-list-of-planets-from-the-star-wars-api)
- [4. Add the GraphQL endpoint](#4-add-the-graphql-endpoint)
- [5. Add Unleash to your Ruby app](#5-add-unleash-to-your-ruby-app)
- [6. Verify the toggle experience](#6-verify-the-toggle-experience)
- [Conclusion](#conclusion)
1. [Best practices for backend apps with Unleash](#1-best-practices-for-backend-apps-with-unleash)
2. [Install a local feature flag provider](#2-install-a-local-feature-flag-provider)
3. [Grab a list of planets from the Star Wars API](#3-grab-a-list-of-planets-from-the-star-wars-api)
4. [Add the GraphQL endpoint](#4-add-the-graphql-endpoint)
5. [Add Unleash to your Ruby app](#5-add-unleash-to-your-ruby-app)
6. [Verify the feature flag experience](#6-verify-the-toggle-experience)
## Prerequisites