-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Quick Tour] Rephrase confusing part of "The Big Picture" #2672
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
Comments
This was handled in #2674, and I think it's handled well enough to close this. It's still a but odd that we talk about a URL that doesn't work, but the only other solution is to not talk about the production environment at all, which would be a shame. |
I thought about it a bit when I made the changes. I don't really much like that section at all, even with the revisions; it's doing too much. It seems to me we've actually got three sections here: one on the theory of environments ("environments represent a set of configuration and bundles to be loaded"), one on the practical aspects (the bit on caches; you don't want the profiler running in prod, etc), and one on the profiler (which probably deserves its own section of the documentation). Possibly, list Environments as one of the "fundamentals" to give it some introduction before more details on the practical aspects of environments in the "Working with Environments" section. If that sounds reasonable, I'll take a stab at rewriting that whole section. |
My opinions: 👍 for seperating webprofiler and environments (please note that the second url is wrong, it should get fixed) |
That PR should substantially improve that part of the quickstart. We can loop back on a profiler cookbook section separately. |
Under the 2 images in the "Working with Environments", we have some confusing part:
It confuses people that we use URLs which actually don't work, because the AcmeDemoBundle is only registered in the dev environment. This is explained in the next block, but a lot of people try it before reading further in the article. We could rephrase the first paragraph into something like: "if the routing were configured for production..."
This issue is created after some messages of roxton and adsc on #symfony, thanks to them!
The text was updated successfully, but these errors were encountered: