Skip to content
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.

Sign up for GitHub

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

Updated the installation instructions for Symfony 2.5+ #3874

Merged
merged 1 commit into from
Jun 4, 2014
Merged

Updated the installation instructions for Symfony 2.5+ #3874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions quick_tour/the_big_picture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ directory:

.. code-block:: bash

$ composer create-project symfony/framework-standard-edition myproject/ ~2.4
$ composer create-project symfony/framework-standard-edition myproject/ ~2.5

.. note::

Expand All @@ -35,9 +35,25 @@ directory:

Beware that the first time you install Symfony2, it may take a few minutes to
download all its components. At the end of the installation process, the
installer will ask you to provide some configuration options for the Symfony2
project. For this first project you can safely ignore this configuration by
pressing the ``<Enter>`` key repeatedly.
installer will ask you four questions:

1. **Would you like to use Symfony 3 directory structure? [y/N]** The upcoming
Symfony 3 version will modify the default directory structure for Symfony
applications. If you want to test drive this new structure, type ``y``.
In order to follow this tutorial, press the ``<Enter>`` key to accept the
default ``N`` value and to keep using the default Symfony2 structure.
2. **Would you like to install Acme demo bundle? [y/N]** Symfony versions prior
to 2.5 included a demo application to test drive some features of the
framework. However, as this demo application is only useful for newcomers,
installing it is now optional. In order to follow this tutorial, type the
``y`` key to install the demo application.
3. **Some parameters are missing. Please provide them.** Symfony2 asks you for
the value of all the configuration parameters. For this first project,
you can safely ignore this configuration by pressing the ``<Enter>`` key
repeatedly.
4. **Do you want to remove the existing VCS (.git, .svn..) history? [Y,n]?**
The development history of large projects such as Symfony can take a lot of
disk space. Press the ``<Enter>`` key to safely remove all this history data.
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, thanks for doing this - now I have several comments/questions that I think you'll appreciate @javiereguiluz :)

  1. This is way too long - especially for the quick tour. I think we should just list the questions and the answers that they should answer.

  2. The Would you like to use Symfony 3 directory structure? is not good enough. I know that's not a docs issue - it's just the first time I've seen it. As a new user, I'm stuck at this question - what does this mean? How should I answer? How would I know? Someone (me included if I can get to it) needs to make this more clear!

  3. Again, not a docs issue, but I think that the AcmeDemoBundle should default to "Y". All the existing demos and docs talk about the demo bundle, so we should put it there by default. If you're an advanced user, you'll know to say "N" to this. Also, this is another one where the wording is not as good as it needs to be. Better might be:

Would you like to install a demo bundle (AcmeDemoBundle) that includes some demo
routes, controllers and other features that you can use to tour some functionality?

@javiereguiluz Let me know what you think - most of this isn't related to the docs, just the first time I've seen this stuff and I don't like the "Symfony Experience" that we're giving new people!

Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

@weaverryan I appreciate and 100% agree with your comment. I'm going to open an issue to try to improve Symfony installation once and for all.

However, for Symfony 2.5 we might need to update the installation instructions because it's already published and it will ask the user these questions.


Running Symfony2
----------------
Expand Down