Skip to content

[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

Closed
wouterj opened this issue May 28, 2013 · 5 comments
Closed

[Quick Tour] Rephrase confusing part of "The Big Picture" #2672

wouterj opened this issue May 28, 2013 · 5 comments
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)

Comments

@wouterj
Copy link
Member

wouterj commented May 28, 2013

Under the 2 images in the "Working with Environments", we have some confusing part:

Of course, you won't want to show these tools when you deploy your application to
production. That's why you will find another front controller in the web/ directory
(app.php), which is optimized for the production environment:

http://localhost/app.php/demo/hello/Fabien

And if you use Apache with mod_rewrite enabled, you can even omit the app.php part
of the URL:

http://localhost/demo/hello/Fabien

Last but not least, on the production servers, you should point your web root directory
to the web/ directory to secure your installation and have an even better looking URL:

http://localhost/demo/hello/Fabien

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!

@weaverryan
Copy link
Member

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.

@jbafford
Copy link
Contributor

jbafford commented Jun 2, 2013

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.

@wouterj
Copy link
Member Author

wouterj commented Jun 2, 2013

My opinions:

👍 for seperating webprofiler and environments (please note that the second url is wrong, it should get fixed)
👍 for talking about production environment in quick tour
👍 for creating less-advanced profiler articles in cookbook/profiler
👎 for removing profiler stuff from the quick tour

@jbafford
Copy link
Contributor

jbafford commented Jun 3, 2013

That PR should substantially improve that part of the quickstart. We can loop back on a profiler cookbook section separately.

@weaverryan
Copy link
Member

This has been completed in #2823. I've also made big changes to the document in sha: 72072e9

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them. good first issue Ideal for your first contribution! (some Symfony experience may be required)
Projects
None yet
Development

No branches or pull requests

3 participants