Skip to content

Commit af4dc7d

Browse files
committed
fix linting issues
Signed-off-by: Michael Beemer <[email protected]>
1 parent e251dda commit af4dc7d

File tree

7 files changed

+51
-31
lines changed

7 files changed

+51
-31
lines changed

docs/reference/concepts/05-events.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,4 +155,4 @@ The context associated with the provider has changed, and the provider has not y
155155

156156
### PROVIDER_CONTEXT_CHANGED (Static-context/Client-side only)
157157

158-
The context associated with the provider has changed, and the provider has [reconciled](/docs/reference/concepts/sdk-paradigms#static-context-paradigms-client-side-sdks) its associated state.
158+
The context associated with the provider has changed, and the provider has [reconciled](/docs/reference/concepts/sdk-paradigms#static-context-paradigms-client-side-sdks) its associated state.

docs/reference/concepts/07-tracking.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,21 @@ Tracking events associated with flag evaluations serves two primary purposes:
1717

1818
### Performance Monitoring
1919

20-
When changes are made to an application via feature flags, tracking helps measure their impact on performance. By associating events with flag evaluation contexts
20+
When changes are made to an application via feature flags, tracking helps measure their impact on performance.
21+
By associating events with flag evaluation contexts
2122
and sending this data to telemetry or analytics platforms, teams can determine whether specific flag configurations improve or degrade measured performance,
2223
whether business metrics or system performance.
2324

2425
### Experimentation
2526

26-
Tracking creates a crucial link between flag evaluations and business outcomes, enabling robust experimentation. Experimentation differs from generalized
27-
Performance Monitoring in its execution. The most common form of Experimentation being A/B testing which is when two variations of an application or feature
28-
are distributed randomly to similar groups and the differences in metrics is evaluated. For example, if a feature flag controls the order
29-
of items in a menu, tracking events can be emitted when users click on menu items. The feature flag provider can typically be set to distribute the different variations
27+
Tracking creates a crucial link between flag evaluations and business outcomes, enabling robust experimentation.
28+
Experimentation differs from generalized
29+
Performance Monitoring in its execution.
30+
The most common form of Experimentation being A/B testing which is when two variations of an application or feature
31+
are distributed randomly to similar groups and the differences in metrics is evaluated.
32+
For example, if a feature flag controls the order
33+
of items in a menu, tracking events can be emitted when users click on menu items.
34+
The feature flag provider can typically be set to distribute the different variations
3035
equally to your audience, making this an A/B test, helping to validate hypotheses about user behavior in a statistically relevant manner.
3136

3237
## Providers, Hooks and Integration
@@ -46,7 +51,8 @@ sequenceDiagram
4651

4752
## Track Event Implementation
4853

49-
The `track` function requires only a label parameter. You don’t need to pass an identifier or flag evaluation context since the OpenFeature provider already maintains this information.
54+
The `track` function requires only a label parameter.
55+
You don’t need to pass an identifier or flag evaluation context since the OpenFeature provider already maintains this information.
5056

5157
Optionally, you can associate additional metadata with each track event if your feature flagging tool supports it.
5258

@@ -102,4 +108,4 @@ client.Track(
102108

103109
</TabItem>
104110

105-
</Tabs>
111+
</Tabs>

docs/tutorials/getting-started/dotnet.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ This walk-through assumes that:
3030

3131
### Step 1: Create a .NET 8 Web application
3232

33-
To get started you can use the .NET SDK to initialise a web application. Open a terminal (**shell**, **Command Prompt**, or **bash**) and paste the following commands:
33+
To get started you can use the .NET SDK to initialise a web application.
34+
Open a terminal (**shell**, **Command Prompt**, or **bash**) and paste the following commands:
3435

3536
```shell
3637
dotnet new webapi -o openfeature-dotnet-sample
@@ -48,7 +49,8 @@ dotnet add package OpenFeature
4849

4950
### Step 3: Add code
5051

51-
The following will initialise an `InMemoryProvider` for use within the web application. Open a code editor and add the C# code below to the Program.cs.
52+
The following will initialise an `InMemoryProvider` for use within the web application.
53+
Open a code editor and add the C# code below to the Program.cs.
5254

5355
```csharp
5456
// diff-add-block-start
@@ -135,9 +137,14 @@ dotnet build
135137
dotnet run
136138
```
137139

138-
In the logs you should see a line with the following `Now listening on: http://localhost:5251`, although the port number may differ. You can visit the following URL in your browser [http://localhost:5251/hello](http://localhost:5251/hello) (adjust port number as necessary) to view the hello world message. You should see the message "Hello!".
140+
In the logs you should see a line with the following `Now listening on: http://localhost:5251`, although the port number may differ.
141+
You can visit the following URL in your browser [http://localhost:5251/hello](http://localhost:5251/hello) (adjust port number as necessary) to view the hello world message.
142+
You should see the message "Hello!".
139143

140-
"Why I'm I seeing that value?", you may ask. Well, it's because a provider hasn't been configured yet. Without a provider to actually evaluate flags, OpenFeature will return the default value. In the next step, you'll learn how to add a provider.
144+
"Why I'm I seeing that value?", you may ask.
145+
Well, it's because a provider hasn't been configured yet.
146+
Without a provider to actually evaluate flags, OpenFeature will return the default value.
147+
In the next step, you'll learn how to add a provider.
141148

142149
### Step 5: Configure a provider (flagd)
143150

@@ -208,7 +215,8 @@ dotnet build
208215
dotnet run
209216
```
210217

211-
You can visit the following URL in your browser [http://localhost:5251/hello](http://localhost:5251/hello) (adjust port number as necessary) to view the hello world message. You should see the message "Hello!".
218+
You can visit the following URL in your browser [http://localhost:5251/hello](http://localhost:5251/hello) (adjust port number as necessary) to view the hello world message.
219+
You should see the message "Hello!".
212220

213221
<FlagdChangeContent/>
214222

docs/tutorials/getting-started/go.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,12 +198,12 @@ The complete `main.go` file is given below:
198198
package main
199199

200200
import (
201-
"context"
202-
"log"
203-
"net/http"
204-
"github.com/gin-gonic/gin"
205-
flagd "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg"
206-
"github.com/open-feature/go-sdk/openfeature"
201+
"context"
202+
"log"
203+
"net/http"
204+
"github.com/gin-gonic/gin"
205+
flagd "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg"
206+
"github.com/open-feature/go-sdk/openfeature"
207207
)
208208

209209
const defaultMessage = "Hello!"

docs/tutorials/getting-started/python.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import FlagdContent from '@site/src/components/custom/tutorial/flagd-content.mdx
77
import FlagdChangeContent from '@site/src/components/custom/tutorial/flagd-change-content.mdx';
88
import WhyDefaultContent from '@site/src/components/custom/tutorial/why-default-content.mdx';
99

10-
1110
# Getting Started with the OpenFeature Python SDK
1211

1312
## Introduction
@@ -67,6 +66,7 @@ pip install openfeature-provider-flagd
6766
```
6867

6968
Update `app.py` to import the SDK.
69+
7070
```python
7171
from openfeature import api
7272
from openfeature.contrib.provider.flagd import FlagdProvider
@@ -94,6 +94,7 @@ def index():
9494
```
9595

9696
### Step 4: Run the application
97+
9798
Let's start the app and see it in action, use the final code below.
9899

99100
```python
@@ -114,6 +115,7 @@ def index():
114115

115116
return "Flask Server"
116117
```
118+
117119
Run the following command to start the server.
118120

119121
```sh
@@ -131,8 +133,9 @@ If all goes as planned, you should see "Flask Server".
131133

132134
<FlagdContent />
133135

134-
Flagd can be run as a [standalone binary](https://flagd.dev/reference/flagd-cli/flagd/) or [Kubernetes Operator](https://openfeature.dev/docs/tutorials/ofo/)
135-
as well. If you don't have docker installed, get and install the [Flagd binary](https://github.com/open-feature/flagd/releases).
136+
Flagd can be run as a [standalone binary](https://flagd.dev/reference/flagd-cli/flagd/) or [Kubernetes Operator](https://openfeature.dev/docs/tutorials/ofo/)
137+
as well.
138+
If you don't have docker installed, get and install the [Flagd binary](https://github.com/open-feature/flagd/releases).
136139
With the flagd configuration in place, start flagd service with the following command.
137140

138141
```sh
@@ -143,7 +146,6 @@ flagd start -f file:flags.flagd.json
143146

144147
Now that everything is in place, let's start the app again.
145148

146-
147149
```sh
148150
flask run
149151
```
@@ -162,6 +164,5 @@ This walk-through introduced you to the OpenFeature Python SDK.
162164
It covered how a provider can be configured to perform the flag evaluation and introduced basic feature flagging concepts.
163165
It also showcased how feature flags can be updated at runtime, without requiring a redeployment.
164166

165-
[learn-flask]: https://flask.palletsprojects.com/en/3.0.x/
166167
[docker-download]: https://docs.docker.com/engine/install/
167168
[flag-key]: /specification/glossary#flag-key

docs/tutorials/getting-started/rust.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ import FlagdChangeContent from '@site/src/components/custom/tutorial/flagd-chang
1010

1111
## Introduction
1212

13-
This tutorial explains how to integrate the OpenFeature Rust SDK into an Axum application using the flagd provider. In this guide you will learn how to:
13+
This tutorial explains how to integrate the OpenFeature Rust SDK into an Axum application using the flagd provider.
14+
In this guide you will learn how to:
1415

1516
- Create a new Rust project with Cargo
1617
- Update dependencies to include Docker-based flagd configuration
@@ -56,7 +57,9 @@ Adjust version numbers according to the latest releases.
5657

5758
### Step 3: Set Up the Application
5859

59-
Create or modify your `src/main.rs` with the following code. Notice the diff markers to indicate new additions:
60+
Create or modify your `src/main.rs` with the following code.
61+
Notice the diff markers to indicate new additions:
62+
6063
```rust
6164
// diff-remove-block-start
6265
fn main() {
@@ -131,8 +134,9 @@ async fn main() {
131134

132135
<FlagdContent />
133136

134-
Flagd can be run as a [standalone binary](https://flagd.dev/reference/flagd-cli/flagd/) or [Kubernetes Operator](https://openfeature.dev/docs/tutorials/ofo/)
135-
as well. If you don't have docker installed, get and install the [Flagd binary](https://github.com/open-feature/flagd/releases).
137+
Flagd can be run as a [standalone binary](https://flagd.dev/reference/flagd-cli/flagd/) or [Kubernetes Operator](https://openfeature.dev/docs/tutorials/ofo/)
138+
as well.
139+
If you don't have docker installed, get and install the [Flagd binary](https://github.com/open-feature/flagd/releases).
136140
With the flagd configuration in place, start flagd service with the following command.
137141

138142
```sh
@@ -157,7 +161,7 @@ You should now be greeted with `Hello, welcome to this OpenFeature-enabled websi
157161

158162
## Conclusion
159163

160-
This tutorial demonstrated how to integrate the OpenFeature Rust SDK with an Axum web server using a custom AppState containing a FlagdProvider. By leveraging flagd service, you can dynamically update feature flags at runtime without needing to redeploy your application.
164+
This tutorial demonstrated how to integrate the OpenFeature Rust SDK with an Axum web server using a custom AppState containing a FlagdProvider.
165+
By leveraging flagd service, you can dynamically update feature flags at runtime without needing to redeploy your application.
161166

162167
For advanced configuration and more details, refer to the [OpenFeature Rust SDK documentation](https://docs.rs/open-feature-flagd/latest/open_feature_flagd/).
163-

docs/tutorials/open-feature-cli.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,8 @@ generate:
349349
350350
## Next Steps
351351
352-
Want to dive deeper? Here are some great next steps:
352+
Want to dive deeper?
353+
Here are some great next steps:
353354
354355
- Explore more generators: Try `openfeature generate` to see all supported languages
355356
- Set up provider integration: Connect your generated code to a real feature flag service using [OpenFeature providers](/ecosystem?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provider)

0 commit comments

Comments
 (0)