8000 Merge branch '4.4' · symfony/symfony-docs@5729dcc · GitHub
[go: up one dir, main page]
Skip to content

Commit 5729dcc

Browse files
OskarStarkOskarStark
committed
Merge branch '4.4'
* 4.4: Simplified the docs about Symfony technical requirements
2 parents 361f645 + b2a3c35 commit 5729dcc

File tree

8 files changed

+33
-92
lines changed

8 files changed

+33
-92
lines changed

‎_build/redirection_map

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -445,3 +445,4 @@
445445
/routing/extra_information /routing
446446
/console/request_context /routing
447447
/form/action_method /forms
448+
/reference/requirements /setup

‎best_practices/creating-the-project.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,9 @@ create files and execute the following commands:
3939
This command creates a new directory called ``blog`` that contains a fresh new
4040
project based on the most recent stable Symfony version available.
4141

42-
.. tip::
42+
.. seealso::
4343

44-
The technical requirements to run Symfony are simple. If you want to check
45-
if your system meets those requirements, read :doc:`/reference/requirements`.
44+
Check out the :ref:`technical requirements for running Symfony applications <symfony-tech-requirements>`.
4645

4746
Structuring the Application
4847
---------------------------

‎deployment.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ you'll need to do:
118118
A) Check Requirements
119119
~~~~~~~~~~~~~~~~~~~~~
120120

121-
Use the :doc:`Symfony Requirements Checker </reference/requirements>` to check
122-
if your server meets the technical requirements to run Symfony applications.
121+
Use the ``check:requirements`` command to check if your server meets the
122+
:ref:`technical requirements for running Symfony applications <symfony-tech-requirements>`.
123123

124124
.. _b-configure-your-app-config-parameters-yml-file:
125125

‎migration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ First of all your environment needs to be able to support the minimum
6262
requirements for both applications. In other words, when the Symfony
6363
release you aim to use requires PHP 7.1 and your existing application
6464
does not yet support this PHP version, you will probably have to upgrade
65-
your legacy project. You can find out the
66-
:doc:`requirements </reference/requirements>` for running Symfony and
67-
compare them with your current application's environment to make sure you
65+
your legacy project. Use the ``check:requirements`` command to check if your
66+
server meets the :ref:`technical requirements for running Symfony applications <symfony-tech-requirements>`
67+
and compare them with your current application's environment to make sure you
6868
are able to run both applications on the same system. Having a test
6969
system, that is as close to the production environment as possible,
7070
where you can just install a new Symfony project next to the existing one

‎reference/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,5 @@ Reference Documents
2222

2323
dic_tags
2424
events
25-
requirements
2625

2726
.. include:: /reference/map.rst.inc

‎reference/map.rst.inc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@
2828
2929
* :doc:`/reference/dic_tags`
3030
* :doc:`/reference/events`
31-
* :doc:`/reference/requirements`

‎reference/requirements.rst

Lines changed: 0 additions & 74 deletions
This file was deleted.

‎setup.rst

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,27 @@ Installing & Setting up the Symfony Framework
1010
Do you prefer video tutorials? Check out the `Stellar Development with Symfony`_
1111
screencast series.
1212

13+
.. _symfony-tech-requirements:
14+
1315
Technical Requirements
1416
----------------------
1517

1618
Before creating your first Symfony application you must:
1719

18-
* Make sure to have PHP 7.1 or higher installed (and :doc:`these PHP extensions </reference/requirements>`
19-
which are installed and enabled by default by PHP);
20+
* Install PHP 7.1 or higher and these PHP extensions (which are installed and
21+
enabled by default in most PHP 7 installations): `Ctype`_, `iconv`_, `JSON`_,
22+
`PCRE`_, `Session`_, `SimpleXML`_, and `Tokenizer`_;
2023
* `Install Composer`_, which is used to install PHP packages;
2124
* `Install Symfony`_, which creates in your computer a binary called ``symfony``
2225
that provides all the tools you need to develop your application locally.
2326

27+
The ``symfony`` binary provides a tool to check if your computer meets these
28+
requirements. Open your console terminal and run this command:
29+
30+
.. code-block:: terminal
31+
32+
$ symfony check:requirements
33+
2434
.. _creating-symfony-applications:
2535

2636
Creating Symfony Applications
@@ -57,6 +67,12 @@ will create a new ``my_project_name/`` directory, download some dependencies
5767
into it and even generate the basic directories and files you'll need to get
5868
started. In other words, your new application is ready!
5969

70+
.. note::
71+
72+
The project's cache and logs directory (by default, ``<project>/var/cache/``
73+
and ``<project>/var/log/``) must be writable by the web server. If you have
74+
any issue, read how to :doc:`set up permissions for Symfony applications </setup/file_permissions>`.
75+
6076
Running Symfony Applications
6177
----------------------------
6278

@@ -81,12 +97,6 @@ Open your browser and navigate to ``http://localhost:8000/``. If everything is
8197
working, you'll see a welcome page. Later, when you are finished working, stop
8298
the server by pressing ``Ctrl+C`` from your terminal.
8399

84-
.. tip::
85-
86-
If you're having any problems running Symfony, your system may be missing
87-
some technical requirements. Use the :doc:`Symfony Requirements Checker </reference/requirements>`
88-
tool to make sure your system is set up.
89-
90100
.. _install-existing-app:
91101

92102
Setting up an Existing Symfony Project
@@ -258,3 +268,10 @@ Learn More
258268
.. _`Main recipe repository`: https://github.com/symfony/recipes
259269
.. _`Contrib recipe repository`: https://github.com/symfony/recipes-contrib
260270
.. _`Symfony Recipes documentation`: https://github.com/symfony/recipes/blob/master/README.rst
271+
.. _`iconv`: https://php.net/book.iconv
272+
.. _`JSON`: https://php.net/book.json
273+
.. _`Session`: https://php.net/book.session
274+
.. _`Ctype`: https://php.net/book.ctype
275+
.. _`Tokenizer`: https://php.net/book.tokenizer
276+
.. _`SimpleXML`: https://php.net/book.simplexml
277+
.. _`PCRE`: https://php.net/book.pcre

0 commit comments

Comments
 (0)
0