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
Update to v2.0 readme links #4700
Conversation
forgot to change branch selection before submit. |
Co-Authored-By: karnthis <erin@atomicbear.com>
Done - requested change made |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks but we will not update doc link in the readme, because the readme must always reference the latest stable version (currently v1.7).
Respectfully, these changes are to the v2 branch and its readme. Why should v2 direct to useless documentation? |
Because we keep the readme on |
Ah I see. In that case should I change to offering links to both latest and v2 documentation? Something as simple as "for v2 alpha documentation click here"? Currently you can only find the v2 docs if you know where to look for them. |
in https://docs.traefik.io/ you got a menu with all Traefik version. |
I know about the drop-down, that is part of my point. It is a poor user experience to view a readme, be directed to the documentation resource, see the documentation, and then because you didn't know to select a small option on the side that should have been already been selected since you came there looking for that information, you become frustrated because nothing is working as you are instructed to do. The point I am trying to make is something in that workflow somewhere needs to indicate that the user was not taken to the v2 docs as they might have expected. |
You can add a new sentence in the documentation section: https://github.com/containous/traefik/tree/v2.0#documentation |
…ion warning" This reverts commit 0070ae7.
Rolled back requested changes, added line directing v2 users to v2 docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What does this PR do?
Updated the v2.x readme to use v2.x docs links. Corrected minor typo.
Motivation
I want to help others that are new to Traefik find the info they need to start with getting frustrated with out-of-date docs.
More
Added/updated testsAdditional Notes
Keep the good work going!