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

Improve documentation for frontend rules. #1469

Merged
merged 1 commit into from
Apr 20, 2017

Conversation

timoreimann
Copy link
Contributor

Includes guidelines on proper usage of the more complex path matchers.

Fixes #1411.

/cc @chmod666org @bfqrst

@bfqrst
Copy link

bfqrst commented Apr 20, 2017

Hands down, this is way better... For some reason I always thought that if you want to strip the path from a request, you need to include the non-strip part beforehand. Like the strip-directives ONLY strip and the other directives ONLY do the matching... Does that even makes sense? :-)

Anyway, the static content serving I was struggling with is a thing of the past.

Thanks a lot guys! Much appreciated!


Use `Path` if your backend listens on the exact path only. For instance, `Path: /products` would match `/products` but not `/products/shoes`.

Use a `*Prefix*` matcher if your backend listens on a particular base path but also serves requests on sub-paths. For instance, `PathPrefix: /products` would match `/products` but also `/products/shoes` and `/products/shirts`. Since the path is forwarded as-is, your backend is expected to listen on `/products`.

Choose a reason for hiding this comment

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

I want to plus one this as REALLY helpful because it wasn't clear in the prior docs

Copy link
Contributor

@dtomcej dtomcej left a comment

Choose a reason for hiding this comment

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

LGTM

:shipit:

Copy link
Member

@emilevauge emilevauge left a comment

Choose a reason for hiding this comment

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

Thanks @timoreimann for this much better doc ❤️
LGTM

Includes guidelines on proper usage of the more complex path matchers.
@timoreimann timoreimann force-pushed the improve-frontend-rule-documentation branch from 4e004d9 to 051f0c6 Compare April 20, 2017 22:30
@timoreimann timoreimann merged commit 10e22c0 into master Apr 20, 2017
@timoreimann timoreimann deleted the improve-frontend-rule-documentation branch April 20, 2017 23:10
@ldez ldez modified the milestone: 1.3 Apr 23, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants