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 /reverse_proxy/upstreams API docs #157

Merged
merged 4 commits into from
May 2, 2021
Merged

docs: Add /reverse_proxy/upstreams API docs #157

merged 4 commits into from
May 2, 2021

Conversation

francislavoie
Copy link
Member

@francislavoie francislavoie added the documentation Improvements or additions to documentation label Apr 24, 2021
@francislavoie francislavoie requested a review from mholt April 24, 2021 21:20
Copy link
Member

@mholt mholt left a comment

Choose a reason for hiding this comment

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

LGTM, just a nit on some awkward phrasing.

It might be worth making a more concise distinction between "healthy" and "available" -- the last paragraph kind of tries to explain this, but instead does so from the angle of active and passive health checks. As we discussed, whether a host is "available" is a property of the actual RP handler, not the host itself, and that's what the paragraph rightly explains, but I think it could be clearer. I will try to write up a suggestion if I have time...

Thanks for completing this!

src/docs/markdown/api.md Outdated Show resolved Hide resolved
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
@francislavoie
Copy link
Member Author

Sure 👍 I'll let you re-review this when you can. You often find better wording, but at least this gives you the basis for this content 😄

Copy link
Member

@mholt mholt left a comment

Choose a reason for hiding this comment

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

How's this sound...

src/docs/markdown/api.md Outdated Show resolved Hide resolved
src/docs/markdown/api.md Outdated Show resolved Hide resolved
src/docs/markdown/api.md Outdated Show resolved Hide resolved
src/docs/markdown/api.md Outdated Show resolved Hide resolved
francislavoie and others added 2 commits April 29, 2021 17:47
Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
@francislavoie
Copy link
Member Author

Sounds good to me 👍 😁

@mholt mholt merged commit fb2a712 into caddyserver:master May 2, 2021
@francislavoie francislavoie deleted the admin-api-proxy-upstreams branch May 2, 2021 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants