Skip to content

Removing some installation instructions #4608

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

Merged
merged 3 commits into from
Dec 20, 2014
Merged

Removing some installation instructions #4608

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78e08f4
Removing some installation instructions
weaverryan Dec 7, 2014
9d925ff
[#4608] Using #. for numbered bullets
weaverryan Dec 20, 2014
3395b50
Re-wording parameters.yml section and removing note about vendor #4608
weaverryan Dec 20, 2014
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
30 changes: 3 additions & 27 deletions cookbook/workflow/new_project_git.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,10 @@ that's stored using the `Git`_ source control management system.
Initial Project Setup
---------------------

To get started, you'll need to download Symfony and initialize your local
git repository:
To get started, you'll need to download Symfony and get things running. See
the :doc:`/book/installation` chapter for details.

#. Download the `Symfony Standard Edition`_ using Composer:

.. code-block:: bash

$ php composer.phar create-project symfony/framework-standard-edition path/ '~2.5'

.. tip::

Add the ``-vvv`` flag to see everything that Composer is doing - this is
especially useful on a slow connection where it may seem that nothing is
happening.

Composer will now download the Standard Distribution along with all of the
required vendor libraries. For more information about downloading Symfony using
Composer, see `Installing Symfony using Composer`_.
Once your project is running, just follow these simple steps:

#. Initialize your Git repository:

Expand Down Expand Up @@ -90,16 +76,6 @@ to learn more about how to configure and develop inside your application.

.. include:: _vendor_deps.rst.inc

Vendors and Submodules
~~~~~~~~~~~~~~~~~~~~~~

Instead of using the ``composer.json`` system for managing your vendor
libraries, you may instead choose to use native `git submodules`_. There
is nothing wrong with this approach, though the ``composer.json`` system
is the official way to solve this problem and probably much easier to
deal with. Unlike Git submodules, Composer is smart enough to calculate
which libraries depend on which other libraries.

Storing your Project on a remote Server
---------------------------------------

Expand Down
23 changes: 11 additions & 12 deletions cookbook/workflow/new_project_svn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,28 +46,27 @@ widespread standard structure:
Initial Project Setup
---------------------

To get started, you'll need to download Symfony and get the basic Subversion setup:
To get started, you'll need to download Symfony and get the basic Subversion setup.
First, download and get your Symfony project running by following the
:doc:`Installation </book/installation>` chapter.

1. Download the `Symfony Standard Edition`_ with or without vendors.
Once you have your new project directory and things are working, follow along
with these steps:

2. Unzip/untar the distribution. It will create a folder called Symfony with
your new project structure, config files, etc. Rename it to whatever you
like.

3. Checkout the Subversion repository that will host this project. Suppose
1. Checkout the Subversion repository that will host this project. Suppose
it is hosted on `Google code`_ and called ``myproject``:

.. code-block:: bash

$ svn checkout http://myproject.googlecode.com/svn/trunk myproject

4. Copy the Symfony project files in the Subversion folder:
2. Copy the Symfony project files in the Subversion folder:
Copy link
Member

Choose a reason for hiding this comment

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

can't we use the # syntax here? (oh, docbot would be so nice in this case :P)

Copy link
Member Author

Choose a reason for hiding this comment

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

I usually avoid it because I know for sure the numbers will work exactly as expected whereas with # I'm never totally sure if a line break might cause the numbers to restart. It's like an extra tool that I just don't care to use - the rare re-numbering is easy anyways

Copy link
Member

Choose a reason for hiding this comment

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

I would prefer # characters cause it makes diffs easier to read on reviews.

Copy link
Member

Choose a reason for hiding this comment

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

Other chapters (the new_project_git one above for instance) are using the # notation already. IMO, we should be consistent


.. code-block:: bash

$ mv Symfony/* myproject/

5. Now, set the ignore rules. Not everything *should* be stored in your Subversion
3. Now, set the ignore rules. Not everything *should* be stored in your Subversion
repository. Some files (like the cache) are generated and others (like
the database configuration) are meant to be customized on each machine.
This makes use of the ``svn:ignore`` property, so that specific files can
Expand All @@ -88,21 +87,21 @@ To get started, you'll need to download Symfony and get the basic Subversion set

$ svn ci -m "commit basic Symfony ignore list (vendor, app/bootstrap*, app/config/parameters.yml, app/cache/*, app/logs/*, web/bundles)"

6. The rest of the files can now be added and committed to the project:
4. The rest of the files can now be added and committed to the project:

.. code-block:: bash

$ svn add --force .
$ svn ci -m "add basic Symfony Standard 2.X.Y"

7. Copy ``app/config/parameters.yml`` to ``app/config/parameters.yml.dist``.
5. Copy ``app/config/parameters.yml`` to ``app/config/parameters.yml.dist``.
Copy link
Member

Choose a reason for hiding this comment

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

the installer already creates a parameters.yml file

Copy link
Member

Choose a reason for hiding this comment

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

And parameters.yml.dist exists in the standard edition already, no need to create it

The ``parameters.yml`` file is ignored by svn (see above) so that
machine-specific settings like database passwords aren't committed. By
creating the ``parameters.yml.dist`` file, new developers can quickly clone
the project, copy this file to ``parameters.yml``, customize it, and start
developing.

8. Finally, download all of the third-party vendor libraries by
6. Finally, download all of the third-party vendor libraries by
Copy link
Member

Choose a reason for hiding this comment

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

This is not needed if you used the installer

Copy link
Member

Choose a reason for hiding this comment

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

Maybe we could create a short list of instructions for people using the installer and then an additional list of things that you need to know in case you didn't use the installer.

Copy link
Member

Choose a reason for hiding this comment

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

IMO, this page should only care about the SVN-specific instructions. Even people not using the installer will already have the vendors at this step if they followed the installation instructions linked at the top of this page, as they also ask to install vendors for other installation methods

executing Composer. For details, see :ref:`installation-updating-vendors`.

.. tip::
Expand Down