docs: troubleshooting guides #4592
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gastonfournier
requested review from
thomasheartman and
dgorton
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
vercel
bot
temporarily deployed
to
Preview – unleash-monorepo-frontend
thomasheartman
approved these changes
Sep 1, 2023
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
gastonfournier
commented
Sep 1, 2023
gastonfournier
commented
Sep 1, 2023
| To confirm how users will have flags resolved, follow these steps: | ||
| 1. The [Unleash Playground](../reference/playground.mdx Playground reference documentation) was developed with this particular use case in mind. An access token can be used along with context values (passed in via the UI) to see how a flag will be resolved. | ||
| 2. When using a **gradual rollout** strategy, be mindful of the **[stickiness](../reference/stickiness)** value. When evaluating a flag, if the provided context does not include the field used in the stickiness configuration, the gradual rollout strategy will be evaluated to false.``` | ||
| 3. If using [Unleash Edge](../reference/unleash-edge) or the [Proxy](../reference/unleash-proxy), consider changing the API endpoint being used by the SDK instance. The SDK and platform may be configured correctly while the intermediary (Edge or Proxy) is somehow malfunctioning. |
There was a problem hiding this comment.
@mvittiglio I was reviewing this and I'm not sure I understand:
- Changing the API Endpoint to what value?
- Saying that the intermediate is somehow malfunctioning doesn't help troubleshoot, and most likely it can be a misconfiguration more than a malfunction.
So, maybe you're trying to say to use the Frontend API from the SDK, to be able to tell if the problem is on the SDK or on the configuration of Edge/proxy, can that be?
For now, I'll remove this sentence, and we can add it back in another PR once clarified
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About the changes
Adds troubleshooting guides for some common problems under the how-to area (following the diataxis framework).
This is part of Unleash 2023 offsite challenge