fix: resolve #287 — [Doc] Provide simple examples with doc hints#898
Open
chinhkrb113 wants to merge 2 commits into
Open
fix: resolve #287 — [Doc] Provide simple examples with doc hints#898chinhkrb113 wants to merge 2 commits into
chinhkrb113 wants to merge 2 commits into
Conversation
…hints Fixes cloudflare#287 Signed-off-by: ChinhLee <76194645+chinhkrb113@users.noreply.github.com>
…hints Fixes cloudflare#287 Signed-off-by: ChinhLee <76194645+chinhkrb113@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Combined multi-file contribution:
Changes
docs/quick_start.mdpingora-core/examples/service_dependencies.rsWhy
docs/quick_start.md: The quick start presents a working load balancer but offers no commentary on what each line does or how to change it for a different deployment. The reporter's concrete failure (a 502 when swapping the upstreams for local127.0.0.1:9000/9001addresses) is caused by theHttpPeerbeing constructed with TLS enabled and an SNI ofone.one.one.one, which is correct for the Cloudflare demo upstream but wrong for a plain-HTTP local server. Without comments explaining thetlsboolean and the SNI argument, users cannot diagnose this. The fix is to annotate every meaningful line of the example and add an explicit section that walks through adapting it.