Skip to content

Commit 95fc487

Browse files
committed
minor #4608 Removing some installation instructions (weaverryan)
This PR was merged into the 2.3 branch. Discussion ---------- Removing some installation instructions | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | all | Fixed tickets | n/a Hi guys! This removes some duplicate installation instructions. I want less docs, without explaining less :). Duplicate like this is an opportunity to give users more paths for no reason. I'm sure we have more things like this - like details on handling parameters.yml or other things. Thanks! Commits ------- 3395b50 Re-wording parameters.yml section and removing note about vendor #4608 9d925ff [#4608] Using #. for numbered bullets 78e08f4 Removing some installation instructions
2 parents 90ef4ec + 3395b50 commit 95fc487

File tree

2 files changed

+18
-51
lines changed

2 files changed

+18
-51
lines changed

cookbook/workflow/new_project_git.rst

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,10 @@ that's stored using the `Git`_ source control management system.
1919
Initial Project Setup
2020
---------------------
2121

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

25-
#. Download the `Symfony Standard Edition`_ using Composer:
26-
27-
.. code-block:: bash
28-
29-
$ php composer.phar create-project symfony/framework-standard-edition path/ '~2.5'
30-
31-
.. tip::
32-
33-
Add the ``-vvv`` flag to see everything that Composer is doing - this is
34-
especially useful on a slow connection where it may seem that nothing is
35-
happening.
36-
37-
Composer will now download the Standard Distribution along with all of the
38-
required vendor libraries. For more information about downloading Symfony using
39-
Composer, see `Installing Symfony using Composer`_.
25+
Once your project is running, just follow these simple steps:
4026

4127
#. Initialize your Git repository:
4228

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

9177
.. include:: _vendor_deps.rst.inc
9278

93-
Vendors and Submodules
94-
~~~~~~~~~~~~~~~~~~~~~~
95-
96-
Instead of using the ``composer.json`` system for managing your vendor
97-
libraries, you may instead choose to use native `git submodules`_. There
98-
is nothing wrong with this approach, though the ``composer.json`` system
99-
is the official way to solve this problem and probably much easier to
100-
deal with. Unlike Git submodules, Composer is smart enough to calculate
101-
which libraries depend on which other libraries.
102-
10379
Storing your Project on a remote Server
10480
---------------------------------------
10581

cookbook/workflow/new_project_svn.rst

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -46,28 +46,27 @@ widespread standard structure:
4646
Initial Project Setup
4747
---------------------
4848

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

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

53-
2. Unzip/untar the distribution. It will create a folder called Symfony with
54-
your new project structure, config files, etc. Rename it to whatever you
55-
like.
56-
57-
3. Checkout the Subversion repository that will host this project. Suppose
56+
#. Checkout the Subversion repository that will host this project. Suppose
5857
it is hosted on `Google code`_ and called ``myproject``:
5958

6059
.. code-block:: bash
6160
6261
$ svn checkout http://myproject.googlecode.com/svn/trunk myproject
6362
64-
4. Copy the Symfony project files in the Subversion folder:
63+
#. Copy the Symfony project files in the Subversion folder:
6564

6665
.. code-block:: bash
6766
6867
$ mv Symfony/* myproject/
6968
70-
5. Now, set the ignore rules. Not everything *should* be stored in your Subversion
69+
#. Now, set the ignore rules. Not everything *should* be stored in your Subversion
7170
repository. Some files (like the cache) are generated and others (like
7271
the database configuration) are meant to be customized on each machine.
7372
This makes use of the ``svn:ignore`` property, so that specific files can
@@ -88,27 +87,19 @@ To get started, you'll need to download Symfony and get the basic Subversion set
8887
8988
$ svn ci -m "commit basic Symfony ignore list (vendor, app/bootstrap*, app/config/parameters.yml, app/cache/*, app/logs/*, web/bundles)"
9089
91-
6. The rest of the files can now be added and committed to the project:
90+
#. The rest of the files can now be added and committed to the project:
9291

9392
.. code-block:: bash
9493
9594
$ svn add --force .
9695
$ svn ci -m "add basic Symfony Standard 2.X.Y"
9796
98-
7. Copy ``app/config/parameters.yml`` to ``app/config/parameters.yml.dist``.
99-
The ``parameters.yml`` file is ignored by svn (see above) so that
100-
machine-specific settings like database passwords aren't committed. By
101-
creating the ``parameters.yml.dist`` file, new developers can quickly clone
102-
the project, copy this file to ``parameters.yml``, customize it, and start
103-
developing.
104-
105-
8. Finally, download all of the third-party vendor libraries by
106-
executing Composer. For details, see :ref:`installation-updating-vendors`.
107-
108-
.. tip::
109-
110-
If you rely on any "dev" versions, then Git may be used to install
111-
those libraries, since there is no archive available for download.
97+
That's it! Since the ``app/config/parameters.yml`` file is ignored, you can
98+
store machine-specific settings like database passwords here without committing
99+
them. The ``parameters.yml.dist`` file *is* committed, but is not read by
100+
Symfony. And by adding any new keys you need to both files, new developers
101+
can quickly clone the project, copy this file to ``parameters.yml``, customize
102+
it, and start developing.
112103

113104
At this point, you have a fully-functional Symfony project stored in your
114105
Subversion repository. The development can start with commits in the Subversion

0 commit comments

Comments
 (0)