Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rm beta warning about client sdks #269

Merged
merged 1 commit into from
Sep 10, 2024
Merged

chore: rm beta warning about client sdks #269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions integration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Once you have the Flipt server up and running within your infrastructure or local development environment, the next step is to integrate the Flipt client(s) with your applications for evaluating your feature flags.

There two main ways to perform evaluation of feature flags with Flipt:
There are two main ways to evaluate feature flags with Flipt:

Check warning on line 13 in integration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.ThereIs] Don't start a sentence with 'There are'

Raw Output:
{"message": "[Openly.ThereIs] Don't start a sentence with 'There are'", "location": {"path": "integration/overview.mdx", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

1. [Server-Side Evaluation](#server-side-evaluation)
1. [Client-Side Evaluation](#client-side-evaluation)
Expand All @@ -30,11 +30,11 @@

Flipt comes equipped with a fully functional REST API. The Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API.

The Flipt REST API can also be used with any language that can make HTTP requests. This means that you don't need have to use one of our official clients to integrate your application with Flipt.
The Flipt REST API can also be used with any language that can make HTTP requests. This means you don't need to use one of our official clients to integrate your application with Flipt.

Check warning on line 33 in integration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "integration/overview.mdx", "range": {"start": {"line": 33, "column": 26}}}, "severity": "WARNING"}

Check warning on line 33 in integration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "integration/overview.mdx", "range": {"start": {"line": 33, "column": 124}}}, "severity": "WARNING"}

The latest version of the REST API is fully documented using the [OpenAPI v3 specification](https://github.com/flipt-io/flipt-openapi) as well as the above [API Reference](/reference/overview).

See all official REST SDKs as well as how to generate your own in the the [REST SDK](/integration/server/rest) section.
See all official REST SDKs as well as how to generate your own in the [REST SDK](/integration/server/rest) section.

### GRPC API

Expand All @@ -45,24 +45,17 @@
An example [Go application](https://github.com/flipt-io/flipt/tree/main/examples/basic) is available, showing how you would
integrate with Flipt using the Go GRPC client.

See all official GRPC SDKs as well as how to generate your own in the the [GRPC SDK](/integration/server/grpc) section.
In the [GRPC SDK](/integration/server/grpc) section, you can find all official GRPC SDKs and instructions for generating your own.

## Client-Side Evaluation

Client-side evaluation is another way Flipt supports evaluating feature flags. This is where your application has a local copy of the feature flag rules and evaluates them locally.

<Warning>
Our client-side SDKs are currently in **beta**.

We're actively working on improving them and adding more languages. If you have any feedback, feature or language requests, please let us know by opening an issue in our [GitHub repository](https://github.com/flipt-io/flipt-client-sdks).

</Warning>

Client-side evaluation is much more performant than server-side evaluation, but it comes with some tradeoffs. The main tradeoff is that you need to keep your feature flag rules in sync with Flipt. This means that you will need to periodically fetch the feature flag rules from Flipt and update your local copy. Our client-side SDKs provide a way to do this automatically.

Reasons for using client-side evaluation include:

- You want to reduce the number of requests your application makes to Flipt for feature flag evaluations
- You want to reduce the latency of feature flag evaluations

See all official client-side SDKs in the the [Client-Side SDKs](/integration/client) section.
See all official client-side SDKs in the [Client-Side SDKs](/integration/client) section.
Loading