Skip to content

Reorganize and expand quickstart big picture docs on environments #2683

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
wants to merge 4 commits into from

Conversation

jbafford
Copy link
Contributor

@jbafford jbafford commented Jun 3, 2013

Q A
Doc fix? yes
New docs? no
Applies to 2.0+
Fixed tickets #2672
  • Add Environments section under "Understanding the Fundamentals" to introduce environments. This uses the glossary definition as a starting point and expands on it a little.
  • Move the Web Profiler discussion out of Working with Environments into a separate section, and add a paragraph briefly summarizing what the profiler can do.
  • Improve the Working with Environments section.

* Add Environments section under "Understanding the Fundamentals" to introduce environments. This uses the glossary definition as a starting point and expands on it a little.
* Move the Web Profiler discussion out of Working with Environments into a separate section, and add a paragraph briefly summarizing what the profiler can do.
* Improve the Working with Environments section.
is a specific set of configuration and loaded bundles, represented by a string.
Thee same application can be run using different configuration by running the
application in different environments. Symfony2 comes with three environments
defined, `dev`, `test`, and `prod`, but you can create your own as well.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be double backticks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about defined - dev, test and prod -, but you can create your own as well

@jbafford
Copy link
Contributor Author

jbafford commented Jun 3, 2013

Ok, that should fix those points.

application in different environments. Symfony2 comes with three environments
defined — ``dev``, ``test`` and ``prod`` — but you can create your own as well.

Enivonments are useful by allowing a single application to have a dev environment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo environments

jbafford added 2 commits June 3, 2013 11:39
Also remove backticks on AcmeDemoBundle in Bundles section per PR comments.
@jbafford
Copy link
Contributor Author

jbafford commented Jun 3, 2013

Thanks for the comments, guys. These commits should resolve those issues.

@weaverryan
Copy link
Member

Hi John!

You've done some really really nice work here - clearly explaining (probably more clearly than anywhere else in the docs) the purpose of environments, the configuration files, and the front controllers in a very calm way.

Unfortunately, I'm going to have to make your life a bit more difficult, and I hope you'll help me :). The problem is that these "Quick Tour" entries are about teaching of course, but they are even more about getting people excited to use Symfony so that they'll continue trying things and read the book. So it's important to keep these articles short and exciting. We've already made this entry a bit longer than it used to be, and if anything, I'd like to make it shorter.

But as I already mentioned, some of your descriptions here are really nice and I don't want to lose them - I just don't think that this is the correct place to make these changes. I propose:

  1. We remove the new "Environments" section and perhaps move some of those details down into the "Working with Environments" section

  2. Remove the new "The Web Debug Toolbar and Profiler" section and put those details back into the "Working with Environments" section. You've laid things out more logically and explained things in more detail. But now the user needs to read into some pretty technical details about environments before seeing the very-exciting web debug toolbar.

  3. Move the really nice explanation of environments (i.e. the "Environments" section and other things you added to "Working with Environments", like talking about the front controllers) to another location. I think the natural best place is probably the "page_creation" chapter. In fact, it's very important in that chapter that a new user can read and code along from start to finish and understand what's going on (e.g. what is this "app_dev.php" file? etc).

Let me know what you think, and if possible (and even better), if you can make these changes. I definitely don't want to lose your nice descriptions, so if you're unable to make these changes, I'll cherry-pick them into other places.

Thanks!

@jbafford
Copy link
Contributor Author

jbafford commented Jul 1, 2013

Ok, I'll see what I can do about that later this week.

This was originally based off the 2.0 branch. Since it's been awhile, do we want to keep this based on 2.0, or do you want me to rebase this off 2.1 or 2.2 (or even 2.3)?

@wouterj
Copy link
Member

wouterj commented Jul 1, 2013

please base it on 2.2

jbafford added a commit to jbafford/symfony-docs that referenced this pull request Jul 12, 2013
* Add Environments section under "Understanding the Fundamentals" to introduce environments. This uses the glossary definition as a starting point and expands on it a little.
* Move the Web Profiler discussion out of Working with Environments into a separate section, and add a paragraph briefly summarizing what the profiler can do.
* Improve the Working with Environments section.
* Original changes from PR symfony#2683 rebased on 2.2
@weaverryan
Copy link
Member

Closing this - #2823 has already been merged :)

@weaverryan weaverryan closed this Jul 29, 2013
@jbafford jbafford deleted the big-picture-environments branch July 29, 2013 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants