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: Update proxy hosting to point to Frontend API #4191

Merged
merged 5 commits into from
Jul 11, 2023
Merged

Conversation

chriswk
Copy link
Contributor

@chriswk chriswk commented Jul 10, 2023

What

We had a customer wonder why /api/proxy/development wasn't configured for them. After some digging it was found that they'd followed our documentation and assumed that the proxy was configured for them. However, since we no longer host proxies, this was not the case. This PR updates the documentation to point out that "Unleash hosts everything" now means that our clients should use Frontend API keys and the /api/frontend endpoint to get what they used to get from embedded proxies.

Missing

We should make a new illustration in the same vein as the other illustrations on this page to demonstrate what the Frontend API really is. This PR removes the reference to the picture of the topology of having Unleash hosting proxies.

@chriswk chriswk added the docs Documentation label Jul 10, 2023
@chriswk chriswk self-assigned this Jul 10, 2023
@vercel
Copy link

vercel bot commented Jul 10, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2023 8:28am
unleash-monorepo-frontend 🛑 Canceled (Inspect) Jul 11, 2023 8:28am

Comment on lines 51 to 54
:::info Recommendation

We recommend you use [Unleash Edge](../reference/unleash-edge) instead of Unleash Proxy. See our [Edge migration guide](https://github.com/Unleash/unleash-edge/blob/main/migration-guide.md) for a guide on how to migrate

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I couldn't find a better way to make the recommendation to switch to Edge. Definitely open to suggestions here.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nah, I think this works well 😄

Copy link
Contributor

@thomasheartman thomasheartman 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 to me 🧯 Just a few small suggestions on wording, but nothing stopping this from going through!

website/docs/topics/proxy-hosting.mdx Outdated Show resolved Hide resolved
website/docs/topics/proxy-hosting.mdx Outdated Show resolved Hide resolved
website/docs/topics/proxy-hosting.mdx Outdated Show resolved Hide resolved
website/docs/topics/proxy-hosting.mdx Outdated Show resolved Hide resolved
Comment on lines 51 to 54
:::info Recommendation

We recommend you use [Unleash Edge](../reference/unleash-edge) instead of Unleash Proxy. See our [Edge migration guide](https://github.com/Unleash/unleash-edge/blob/main/migration-guide.md) for a guide on how to migrate

Copy link
Contributor

Choose a reason for hiding this comment

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

Nah, I think this works well 😄

Christopher Kolstad and others added 4 commits July 11, 2023 10:23
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants