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.

Sign up for GitHub

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

Jump to bottom

Documentation proposal: Be upfront about limitations #1049

Open
jmn opened this issue Jan 21, 2017 · 2 comments
Open

Documentation proposal: Be upfront about limitations #1049

jmn opened this issue Jan 21, 2017 · 2 comments
Labels
area/documentation contributor/wanted Participation from an external contributor is highly requested kind/enhancement a new or improved feature. priority/P3 maybe

Comments

@jmn
Copy link

jmn commented Jan 21, 2017 •
edited
Loading

While Traefik does do a bunch of cool and interesting stuff, I suggest adding a "limitations" section on the Readme.md which states what Traefik currently does not do and/or does in a limited fashion. This would quickly let users see if this the right tool for them and could save people a lot of time I think. Noting if work in that area is out of scope or PR's wanted would also be useful. E.g:

Limitations:

  • Traefik currently does not proxy TCP (see nginx, haproxy), PRs wanted, TCP support #10
@sheerun
Copy link
Contributor

sheerun commented Jan 21, 2017

Yes, I discovered it too late as well :) I use it anyway, but it should be documented

@linuxus
Copy link

linuxus commented Jan 24, 2017

Yup... this became a show stopper for me as well. Great suggestion tho!

@ldez ldez added area/documentation kind/enhancement a new or improved feature. labels Apr 22, 2017
@ldez ldez added the priority/P3 maybe label Jun 8, 2017
@nmengin nmengin added the contributor/wanted Participation from an external contributor is highly requested label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation contributor/wanted Participation from an external contributor is highly requested kind/enhancement a new or improved feature. priority/P3 maybe
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@jmn @sheerun @linuxus @ldez @nmengin