-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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 installation.rst #6686
Update installation.rst #6686
Conversation
Reminder note to view specific documentation version when installing specific version. Reference to installing LTS means example commands later on down in this same page will not work.
I think this is a good idea. But can you please wrap this in a |
Updated to use tip syntax
Updated with tip syntax. |
.. tip:: | ||
|
||
Note that if you install a specific version, you will want to make sure | ||
you refer to the same version of the documentation. |
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.
Maybe replace this with "[...] make sure to read the corresponding version of the documentation." What do you think?
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.
I don't mind what the wording is, I just got hit with installing LTS (which seemed 'safest' to me) but then nothing else on the 'default' screens working (because LTS is diff enough to current). Whatever wording you think is sufficient is fine.
I put the wording the way that it is precisely to notify people who are explicitly installing a specific version vs whatever the default version happens to be. That's all.
Thanks.
A while ago we updated the http://symfony.com/roadmap page to recommend to install the latest Symfony version and not the LTS: We may need to update the /download page to avoid misunderstandings. |
To be honest ... I'm not that sure that this |
@javie - it's not that obvious to me - it's precisely why i made the PR. Others feel differently, and the suggestions were to do it another way, and now yours is 'not at all'. I won't be gutted either way, but I will say it was confusing. Seeing "hey, there's an LTS" then using it, then 2 paragraphs later on the same page commands not working... it was totally non-obvious as to what the issue was. |
This PR was submitted for the 3.1 branch but it was merged into the 2.7 branch instead (closes #6686). Discussion ---------- Update installation.rst Reminder note to view specific documentation version when installing specific version. Reference to installing LTS means example commands later on down in this same page will not work. Commits ------- c876100 Update installation.rst
Thanks @mgkimsal! I've merged your note into the 2.7 branch with some minor tweaks. The note is short, and probably a good idea to point out that we have multiple versions of the docs. Cheers! |
Reminder note to view specific documentation version when installing specific version. Reference to installing LTS means example commands later on down in this same page will not work.