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.

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

docs: Add server-side SDK compatibility table to SDK docs #1174

Merged
merged 8 commits into from
Dec 10, 2021

Conversation

thomasheartman
Copy link
Contributor

@thomasheartman thomasheartman commented Dec 9, 2021

This PR adds a compatibility table for server-side SDKs to the SDK docs.

Left to do:

  • Clarify whether the .NET sdk supports gradual rollout with custom stickiness
  • Discuss strategy names: the table mentions flexibleRollout, userWithId, remoteAddress, and applicationHostname, but these names do not exist in the docs. Instead I think they are known as 'gradual rollout', 'user id', 'ips', and 'hostname' respectively. At least in the docs. What they're referred to in the SDKs might be what the table says. This should be clarified.

@vercel
Copy link

vercel bot commented Dec 9, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/unleash-team/unleash-docs/3kLWg5yNFkWHS7Ar4wTjcRA3EMWr
✅ Preview: https://unleash-docs-git-docs-sdk-compatibility-unleash-team.vercel.app

@thomasheartman thomasheartman marked this pull request as draft December 9, 2021 12:47
@thomasheartman
Copy link
Contributor Author

@thomasheartman thomasheartman marked this pull request as ready for review December 9, 2021 12:49
@github-actions
Copy link

github-actions bot commented Dec 9, 2021

Coverage report

Total coverage

Status Category Percentage Covered / Total
🟢 Statements 92.08% 4560/4952
🟢 Branches 81.75% 918/1123
🟢 Functions 87.92% 1077/1225
🟢 Lines 93.86% 5165/5503

Status of coverage: 🟢 - ok, 🟡 - slightly more than threshold, 🔴 - under the threshold

Report generated by 🧪jest coverage report action from 2b0941a

Copy link
Member

@sighphyre sighphyre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@@ -4,11 +4,15 @@ title: Introduction
slug: /sdks
---

In order to connect your application to Unleash you need to use a client SDK (software developer kit) for your programming language. In addition you will need a [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieve feature toggles based upon your configuration. Both open-source and the Unleash enterprise offering utilize the same set of client SDKs.
In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.
In order to connect your application to Unleash you will need a client SDK (software development kit) for your programming language and an [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.

@thomasheartman thomasheartman merged commit c0f7f09 into master Dec 10, 2021
@thomasheartman thomasheartman deleted the docs/sdk-compatibility branch December 15, 2021 09:59
Tymek pushed a commit that referenced this pull request Aug 26, 2022
* chore(deps): update material-ui monorepo

* refactor: update snapshots

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: olav <mail@olav.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants