Skip to content

Commit

Permalink
docs: remove the proxy from the sdks overview table (#3060)
Browse files Browse the repository at this point in the history
## What

This change removes the "unleash proxy" column from the SDK compat
table.

## Why

Because the proxy isn't technically an SDK. Having the column there can
be misleading to users.

In the latest case, a user pointed out that the table says the proxy
supports `isEnabled` with fallback values, but that there is no way to
use this via the API (or via client-side sdks) at the moment.

I think we should add a section to the proxy doc about its capabilities
instead.

In fact, I think we should do the same thing with the proxy that we did
with the SDKs: merge the docs.getunleash content with the github readme
and instead source it from there.
  • Loading branch information
thomasheartman authored Feb 22, 2023
1 parent a2c18d7 commit 53c82d7
Showing 1 changed file with 51 additions and 51 deletions.
102 changes: 51 additions & 51 deletions website/docs/reference/sdks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,57 +51,57 @@ If you see an item marked with a ❌ that you would find useful, feel free to re

:::

| Capability | [Java](/docs/generated/sdks/server-side/java.md) | [Node.js](/docs/generated/sdks/server-side/node.md) | [Go](/docs/generated/sdks/server-side/go.md) | [Python](/docs/generated/sdks/server-side/python.md) | [Ruby](/docs/generated/sdks/server-side/ruby.md) | [.NET](/docs/generated/sdks/server-side/dotnet.md) | [PHP](/docs/generated/sdks/server-side/php.md) | [Rust](/docs/generated/sdks/server-side/rust.md) | [Unleash Proxy](../../generated/unleash-proxy.md) |
| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| **Category: Initialization** | | | | | | | | | |
| Async initialization ||||||||| N/A |
| Can block until synchronized ||||||||| N/A |
| Default refresh interval | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 15s | 5s |
| Default metrics interval | 60s | 60s | 60s | 60s | 60s | 60s | 30s | 15s | 30s |
| Context provider || N/A | N/A | N/A | N/A ||| N/A | N/A |
| Global fallback function ||||||||| N/A |
| Toggle Query: `namePrefix` ||||||||||
| Toggle Query: `tags` ||||||||||
| Toggle Query: `project_name` ||||||| N/A |||
| **Category: Custom Headers** | | | | | | | | | |
| static ||||||||| N/A |
| function ||||| ✅ (4.3) |||| N/A |
| **Category: Built-in strategies** | | | | | | | | | |
| [Standard](../reference/activation-strategies#standard) ||||||||||
| [Gradual rollout](../reference/activation-strategies#gradual-rollout) ||||||||||
| [Gradual rollout: custom stickiness](../reference/activation-strategies#customize-stickiness-beta) ||||||||||
| [UserID](../reference/activation-strategies#userids) ||||||||||
| [IP](../reference/activation-strategies#ips) ||||||||||
| [IP](../reference/activation-strategies#ips): CIDR syntax ||||||||||
| [Hostname](../reference/activation-strategies#hostnames) ||||||||||
| **Category: [Custom strategies](../custom-activation-strategies.md)** | | | | | | | | | |
| Basic support ||||||||||
| <span id="strategy-constraints">**Category: [Strategy constraints](../strategy-constraints.md)**</span> | | | | | | | | | |
| Basic support (`IN`, `NOT_IN` operators) ||||||||||
| <span id="strategy-constraints-advanced-support">Advanced support (Semver, date, numeric and extended string operators)</span> (introduced in) | ✅ (5.1) | ✅ (3.12) | ✅ (3.3) | ✅ (5.1) | ✅ (4.2) | ✅ (2.1) | ✅ (1.3.1) || ✅ (0.8) |
| **Category: [Unleash Context](../reference/unleash-context)** | | | | | | | | | |
| Static fields (`environment`, `appName`) ||||||||||
| Defined fields ||||||||||
| Custom properties ||||||||||
| **Category: [`isEnabled`](../client-specification#implementation-of-isenabled)** | | | | | | | | | |
| Can take context ||||||||||
| Override fallback value ||||||||||
| Fallback function ||||||||||
| **Category: [Variants](../feature-toggle-variants.md)** | | | | | | | | | |
| Basic support ||||||||||
| Custom fallback variant ||||||||||
| Custom weight ||||||||||
| [Custom stickiness (beta)](../stickiness.md#custom-stickiness-beta) ||||||||||
| **Category: Local backup** | | | | | | | | | |
| File based backup ||||||||||
| **Category: Usage metrics** | | | | | | | | | |
| Can disable metrics ||||||||||
| Client registration ||||||||||
| Basic usage metrics (yes/no) ||||||||||
| [Impression data](../impression-data.md) ||||||||||
| **Category: Bootstrap (beta)** | | | | | | | | | |
| Bootstrap from file ||||||||||
| Custom Bootstrap implementation ||||||||||
| Capability | [Java](/docs/generated/sdks/server-side/java.md) | [Node.js](/docs/generated/sdks/server-side/node.md) | [Go](/docs/generated/sdks/server-side/go.md) | [Python](/docs/generated/sdks/server-side/python.md) | [Ruby](/docs/generated/sdks/server-side/ruby.md) | [.NET](/docs/generated/sdks/server-side/dotnet.md) | [PHP](/docs/generated/sdks/server-side/php.md) | [Rust](/docs/generated/sdks/server-side/rust.md) |
| --- | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| **Category: Initialization** | | | | | | | | |
| Async initialization |||||||||
| Can block until synchronized |||||||||
| Default refresh interval | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 15s |
| Default metrics interval | 60s | 60s | 60s | 60s | 60s | 60s | 30s | 15s |
| Context provider || N/A | N/A | N/A | N/A ||| N/A |
| Global fallback function |||||||||
| Toggle Query: `namePrefix` |||||||||
| Toggle Query: `tags` |||||||||
| Toggle Query: `project_name` ||||||| N/A ||
| **Category: Custom Headers** | | | | | | | | |
| static |||||||||
| function ||||| ✅ (4.3) ||||
| **Category: Built-in strategies** | | | | | | | | |
| [Standard](../reference/activation-strategies#standard) |||||||||
| [Gradual rollout](../reference/activation-strategies#gradual-rollout) |||||||||
| [Gradual rollout: custom stickiness](../reference/activation-strategies#customize-stickiness-beta) |||||||||
| [UserID](../reference/activation-strategies#userids) |||||||||
| [IP](../reference/activation-strategies#ips) |||||||||
| [IP](../reference/activation-strategies#ips): CIDR syntax |||||||||
| [Hostname](../reference/activation-strategies#hostnames) |||||||||
| **Category: [Custom strategies](../custom-activation-strategies.md)** | | | | | | | | |
| Basic support |||||||||
| <span id="strategy-constraints">**Category: [Strategy constraints](../strategy-constraints.md)**</span> | | | | | | | | |
| Basic support (`IN`, `NOT_IN` operators) |||||||||
| <span id="strategy-constraints-advanced-support">Advanced support (Semver, date, numeric and extended string operators)</span> (introduced in) | ✅ (5.1) | ✅ (3.12) | ✅ (3.3) | ✅ (5.1) | ✅ (4.2) | ✅ (2.1) | ✅ (1.3.1) ||
| **Category: [Unleash Context](../reference/unleash-context)** | | | | | | | | |
| Static fields (`environment`, `appName`) |||||||||
| Defined fields |||||||||
| Custom properties |||||||||
| **Category: [`isEnabled`](../client-specification#implementation-of-isenabled)** | | | | | | | | |
| Can take context |||||||||
| Override fallback value |||||||||
| Fallback function |||||||||
| **Category: [Variants](../feature-toggle-variants.md)** | | | | | | | | |
| Basic support |||||||||
| Custom fallback variant |||||||||
| Custom weight |||||||||
| [Custom stickiness (beta)](../stickiness.md#custom-stickiness-beta) |||||||||
| **Category: Local backup** | | | | | | | | |
| File based backup |||||||||
| **Category: Usage metrics** | | | | | | | | |
| Can disable metrics |||||||||
| Client registration |||||||||
| Basic usage metrics (yes/no) |||||||||
| [Impression data](../impression-data.md) |||||||||
| **Category: Bootstrap (beta)** | | | | | | | | |
| Bootstrap from file |||||||||
| Custom Bootstrap implementation |||||||||

## Community SDKs ❤️ {#community-sdks}

Expand Down

0 comments on commit 53c82d7

Please sign in to comment.