Skip to content

Commit

Permalink
docs: Add ruby provider in documentation (#2197)
Browse files Browse the repository at this point in the history 
* check ruby repo

Signed-off-by: Thomas Poignant <[email protected]>

* Add ruby to main readme

Signed-off-by: Thomas Poignant <[email protected]>

* fix list sources

Signed-off-by: Thomas Poignant <[email protected]>

* docs: Add support of ruby

Signed-off-by: Thomas Poignant <[email protected]>

---------

Signed-off-by: Thomas Poignant <[email protected]>
  • Loading branch information
@thomaspoignant
thomaspoignant authored Aug 13, 2024
1 parent 1eea77e commit 8bc4845
Show file tree
Hide file tree
Showing 9 changed files with 177 additions and 17 deletions.
23 changes: 12 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,18 +263,19 @@ _(OpenFeature is still at an early stage, so not all languages are supported and

For now, we have providers for:

| Language | Provider | Version |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Language | Provider Source | Version |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Go | [Go Provider](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/go-feature-flag) | [![version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fproxy.golang.org%2Fgithub.com%2Fopen-feature%2Fgo-sdk-contrib%2Fproviders%2Fgo-feature-flag%2F%40latest&query=%24.Version&label=GO&color=blue&style=flat-square&logo=golang)](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/go-feature-flag) |
| Java / Kotlin (server) | [Java Provider](https://github.com/open-feature/java-sdk-contrib/tree/main/providers/go-feature-flag) | [![version](https://img.shields.io/maven-central/v/dev.openfeature.contrib.providers/go-feature-flag?color=blue&style=flat-square&logo=java)](https://central.sonatype.com/artifact/dev.openfeature.contrib.providers/go-feature-flag) |
| Android / Kotlin (client) | [Kotlin Provider](openfeature/providers/kotlin-provider) | [![version](https://img.shields.io/maven-central/v/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider?color=blue&style=flat-square&logo=android)](https://central.sonatype.com/artifact/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider) |
| Javascript/Typescript (server) | [Server provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-provider) |
| Javascript/Typescript (client) | [Client provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag-web) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-web-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-web-provider) |
| Python | [Python provider](openfeature/providers/python-provider) | [![version](https://img.shields.io/pypi/v/gofeatureflag-python-provider?color=blue&style=flat-square&logo=pypi)](https://pypi.org/project/gofeatureflag-python-provider/) |
| .Net | [.Net Provider](https://github.com/open-feature/dotnet-sdk-contrib/tree/main/src/OpenFeature.Contrib.Providers.GOFeatureFlag) | [![version](https://img.shields.io/nuget/v/OpenFeature.Contrib.GOFeatureFlag?color=blue&style=flat-square&logo=nuget)](https://nuget.info/packages/OpenFeature.Contrib.GOFeatureFlag) |
| Swift | [Swift Provider](https://github.com/go-feature-flag/openfeature-swift-provider) | [![version](https://img.shields.io/github/v/release/go-feature-flag/openfeature-swift-provider?label=Swift&amp;display_name=tag&style=flat-square&logo=Swift)](https://github.com/go-feature-flag/openfeature-swift-provider) |
| PHP | Not currently available [help by contributing here](https://github.com/open-feature/php-sdk-contrib/) | |
| Ruby | Not currently available [help by contributing here](https://github.com/open-feature/ruby-sdk-contrib) | |
| Java / Kotlin (server) | [Java Provider](https://github.com/open-feature/java-sdk-contrib/tree/main/providers/go-feature-flag) | [![version](https://img.shields.io/maven-central/v/dev.openfeature.contrib.providers/go-feature-flag?color=blue&style=flat-square&logo=java)](https://central.sonatype.com/artifact/dev.openfeature.contrib.providers/go-feature-flag) |
| Android / Kotlin (client) | [Kotlin Provider](openfeature/providers/kotlin-provider) | [![version](https://img.shields.io/maven-central/v/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider?color=blue&style=flat-square&logo=android)](https://central.sonatype.com/artifact/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider) |
| Javascript/Typescript (server) | [Server Provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-provider) |
| Javascript/Typescript (client) | [Client Provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag-web) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-web-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-web-provider) |
| Python | [Python Provider](openfeature/providers/python-provider) | [![version](https://img.shields.io/pypi/v/gofeatureflag-python-provider?color=blue&style=flat-square&logo=pypi)](https://pypi.org/project/gofeatureflag-python-provider/) |
| .Net | [.Net Provider](https://github.com/open-feature/dotnet-sdk-contrib/tree/main/src/OpenFeature.Contrib.Providers.GOFeatureFlag) | [![version](https://img.shields.io/nuget/v/OpenFeature.Contrib.GOFeatureFlag?color=blue&style=flat-square&logo=nuget)](https://nuget.info/packages/OpenFeature.Contrib.GOFeatureFlag) |
| Ruby | [Ruby Provider](https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-go-feature-flag-provider) | [![version](https://img.shields.io/gem/v/openfeature-go-feature-flag-provider?color=blue&style=flat-square&logo=ruby)](https://rubygems.org/gems/openfeature-go-feature-flag-provider) |
| Swift | [Swift Provider](https://github.com/go-feature-flag/openfeature-swift-provider) | [![version](https://img.shields.io/github/v/release/go-feature-flag/openfeature-swift-provider?label=Swift&amp;display_name=tag&style=flat-square&logo=Swift)](https://github.com/go-feature-flag/openfeature-swift-provider) |
| PHP | Not currently available [help by contributing here](https://github.com/open-feature/php-sdk-contrib/) | |



## Where do I store my flags file?
Expand Down
17 changes: 13 additions & 4 deletions openfeature/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,19 @@ providers compatible with the those SDKs to be able to use the tool in other lan
## Where to find the providers sources?
All the providers are hosted directly in the `contrib` repository of Open Feature.

- [`Java`](https://github.com/open-feature/java-sdk-contrib/tree/main/providers/go-feature-flag)
- [`GO`](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/go-feature-flag)
- [`Typescript` / `Javascript`](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag)
- [`.Net`](https://github.com/open-feature/dotnet-sdk-contrib/tree/main/src/OpenFeature.Contrib.Providers.GOFeatureFlag)

| Language | Provider Source | Version |
|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Go | [Go Provider](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/go-feature-flag) | [![version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fproxy.golang.org%2Fgithub.com%2Fopen-feature%2Fgo-sdk-contrib%2Fproviders%2Fgo-feature-flag%2F%40latest&query=%24.Version&label=GO&color=blue&style=flat-square&logo=golang)](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/go-feature-flag) |
| Java / Kotlin (server) | [Java Provider](https://github.com/open-feature/java-sdk-contrib/tree/main/providers/go-feature-flag) | [![version](https://img.shields.io/maven-central/v/dev.openfeature.contrib.providers/go-feature-flag?color=blue&style=flat-square&logo=java)](https://central.sonatype.com/artifact/dev.openfeature.contrib.providers/go-feature-flag) |
| Android / Kotlin (client) | [Kotlin Provider](providers/kotlin-provider) | [![version](https://img.shields.io/maven-central/v/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider?color=blue&style=flat-square&logo=android)](https://central.sonatype.com/artifact/org.gofeatureflag.openfeature/gofeatureflag-kotlin-provider) |
| Javascript/Typescript (server) | [Server Provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-provider) |
| Javascript/Typescript (client) | [Client Provider](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/providers/go-feature-flag-web) | [![version](https://img.shields.io/npm/v/%40openfeature%2Fgo-feature-flag-web-provider?color=blue&style=flat-square&logo=npm)](https://www.npmjs.com/package/@openfeature/go-feature-flag-web-provider) |
| Python | [Python Provider](providers/python-provider) | [![version](https://img.shields.io/pypi/v/gofeatureflag-python-provider?color=blue&style=flat-square&logo=pypi)](https://pypi.org/project/gofeatureflag-python-provider/) |
| .Net | [.Net Provider](https://github.com/open-feature/dotnet-sdk-contrib/tree/main/src/OpenFeature.Contrib.Providers.GOFeatureFlag) | [![version](https://img.shields.io/nuget/v/OpenFeature.Contrib.GOFeatureFlag?color=blue&style=flat-square&logo=nuget)](https://nuget.info/packages/OpenFeature.Contrib.GOFeatureFlag) |
| Ruby | [Ruby Provider](https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-go-feature-flag-provider) | [![version](https://img.shields.io/gem/v/openfeature-go-feature-flag-provider?color=blue&style=flat-square&logo=ruby)](https://rubygems.org/gems/openfeature-go-feature-flag-provider) |
| Swift | [Swift Provider](https://github.com/go-feature-flag/openfeature-swift-provider) | [![version](https://img.shields.io/github/v/release/go-feature-flag/openfeature-swift-provider?label=Swift&amp;display_name=tag&style=flat-square&logo=Swift)](https://github.com/go-feature-flag/openfeature-swift-provider) |
| PHP | Not currently available [help by contributing here](https://github.com/open-feature/php-sdk-contrib/) | |

## Documentation
You can check the [documentation](https://gofeatureflag.org/docs/category/use-with-openfeature) to see how to use these providers.
5 changes: 5 additions & 0 deletions openfeature/providers/ruby-provider/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Ruby Provider

The Ruby `openfeature-go-feature-flag-provider` is to be used with the OpenFeature `ruby-sdk` to integrate OpenFeature into your ruby applications.

The provider is leaving in the OpenFeature Contrib repository, you can find it [here](https://github.com/open-feature/ruby-sdk-contrib/tree/main/providers/openfeature-go-feature-flag-provider).
9 changes: 9 additions & 0 deletions website/docs/openfeature_sdk/sdk.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,15 @@ Rest assured, working with OpenFeature SDKs alongside GO Feature Flag providers
content: <SdkCardContent
badgeUrl={"https://img.shields.io/pypi/v/gofeatureflag-python-provider?color=blue&style=flat-square&logo=pypi"}
features={["remoteEval", "localCache", "dynamicRefresh"]}/>
},
{
logoCss: "devicon-ruby-plain colored",
title:"Ruby",
badges:["Server"],
docLink: "./server_providers/openfeature_ruby",
content: <SdkCardContent
badgeUrl={"https://img.shields.io/gem/v/openfeature-go-feature-flag-provider?color=blue&style=flat-square&logo=ruby"}
features={["remoteEval"]}/>
}
]}/>

Expand Down
2 changes: 1 addition & 1 deletion website/docs/openfeature_sdk/server_providers/openfeature_dotnet.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 52
sidebar_position: 60
title: .NET
description: How to use the OpenFeature .Net SDK
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/openfeature_sdk/server_providers/openfeature_javascript.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 51
sidebar_position: 41
title: Node.js
description: How to use the OpenFeature Javascript SDK
---
Expand Down
Loading

0 comments on commit 8bc4845

Please sign in to comment.