docs: remove the proxy from the sdks overview table #3060
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
Yeah I think this is the right thing to do |
|
I see your point, but I think we can cause some confusion on what the frontend SDKs will support. |
Could you elaborate on that? I'm not sure I understand. |
As mentioned in Unleash/unleash#3060
|
As mentioned in the description, the content from this repo's proxy docs have been added to the proxy readme in Unleash/unleash-proxy#116. This commit adds a section about capabilities so that they don't get lost. |
## What This PR merges the content from docs.getunleash.io with the content that already existed in the readme. In doing so, some of the content has been reordered and potentially reworded. It also replaces the old connection diagram with a new and snazzier one. ## Why This is in preparation to do for the proxy what we did for SDKs in [Unleash PR #2858](Unleash/unleash#2858) (and following PRs): reduce two separate information sources into a single document and an updating replica. ## Commits * docs: Update readme intro * docs: add figure * docs: fix badges with links * docs: add image * docs: move configuration higher up * docs: move api section with content * docs: add health endpoint; custom strats * docs: update how to connect and how to run * docs: remove docusaurus admonition * docs: use new image for connection overview * docs: update image caption * docs: add sdk capabilities section As mentioned in Unleash/unleash#3060
I'm happy with merging this if we also creates an issue to create a simoil if we create an issue to establish a similar table for frontend SDKs. Some capabilities will be automatically inherited from the proxy (e.g. constraints, ip range etc). This would also make it easier to highlight differences in frontend SDK capabilites (bootstrap, impression events etc). |
|
Yeah, I think that's fair (and honestly, it's pretty overdue 😅). Issue created in #3179 |
thomasheartman
force-pushed
the
docs/sdks-table-no-proxy
branch
from
982dd4c to
a6326d9
Compare
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
isEnabledwith 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.