minor #12119 Updated related to Symfony installation and Symfony Flex (javiereguiluz)

javiereguiluz · javiereguiluz · commit 2e754097a532 · 2019-08-10T12:38:59.000+02:00
This PR was squashed before being merged into the 4.3 branch (closes #12119). Discussion ---------- Updated related to Symfony installation and Symfony Flex Don't merge this yet ... because it needs some changes in symfony.com/download too. ----- I think the new docs are better because: * Symfony Local Server articles only talks about server, not security:check and creating apps. * Flex is explained in the main setup article ... and /setup/flex is left as the article explaining how to upgrade old apps to Flex * We now talk about "Install Symfony", to simplify the explanations around "the Symfony binary", which in the past we called it "binary", "CLI", "server", "local server", etc. * The main setup + installation article shows Composer installation too, to avoid issues for people who can't install Symfony. * We only have a single place where we show how to create Symfony apps with the Symfony binary and Composer (the main /setup article) instead of showing that in multiple places. * We remove some internal details about Flex recipes which are already explained in the recipes repository. Commits ------- e614ed1 Updated related to Symfony installation and Symfony Flex
diff --git a/bundles.rst b/bundles.rst
@@ -37,7 +37,7 @@ file::
 
 .. tip::
 
-    In a default Symfony application that uses :doc:`Symfony Flex </setup/flex>`,
+    In a default Symfony application that uses :ref:`Symfony Flex <symfony-flex>`,
     bundles are enabled/disabled automatically for you when installing/removing
     them, so you don't need to look at or edit this ``bundles.php`` file.
 
diff --git a/bundles/best_practices.rst b/bundles/best_practices.rst
@@ -246,7 +246,7 @@ Installation
 ------------
 
 Bundles should set ``"type": "symfony-bundle"`` in their ``composer.json`` file.
-With this, :doc:`Symfony Flex </setup/flex>` will be able to automatically
+With this, :ref:`Symfony Flex <symfony-flex>` will be able to automatically
 enable your bundle when it's installed.
 
 If your bundle requires any setup (e.g. configuration, new files, changes to
diff --git a/configuration.rst b/configuration.rst
@@ -30,7 +30,7 @@ stores the configuration of every package installed in your application.
 Packages (also called "bundles" in Symfony and "plugins/modules" in other
 projects) add ready-to-use features to your projects.
 
-When using :doc:`Symfony Flex </setup/flex>`, which is enabled by default in
+When using :ref:`Symfony Flex <symfony-flex>`, which is enabled by default in
 Symfony applications, packages update the ``bundles.php`` file and create new
 files in ``config/packages/`` automatically during their installation. For
 example, this is the default file created by the "API Platform" package:
@@ -555,7 +555,7 @@ This is for example the content of the ``.env`` file to define the value of the
 
 In addition to your own env vars, this ``.env`` file also contains the env vars
 defined by the third-party packages installed in your application (they are
-added automatically by :doc:`Symfony Flex </setup/flex>` when installing packages).
+added automatically by :ref:`Symfony Flex <symfony-flex>` when installing packages).
 
 .. _configuration-env-var-in-prod:
 
@@ -565,7 +565,7 @@ Configuring Environment Variables in Production
 In production, the ``.env`` files are also parsed and loaded on each request so
 you can override the env vars already defined in the server. In order to improve
 performance, you can run the ``dump-env`` command (available when using
-:doc:`Symfony Flex </setup/flex>` 1.2 or later).
+:ref:`Symfony Flex <symfony-flex>` 1.2 or later).
 
 This command parses all the ``.env`` files once and compiles their contents into
 a new PHP-optimized file called  ``.env.local.php``. From that moment, Symfony
diff --git a/contributing/code/security.rst b/contributing/code/security.rst
@@ -169,8 +169,7 @@ Security Advisories
 .. tip::
 
     You can check your Symfony application for known security vulnerabilities
-    using the ``security:check`` command provided by the
-    :ref:`Symfony security checker <security-checker>`.
+    using :ref:`the security:check command <security-checker>`.
 
 Check the `Security Advisories`_ blog category for a list of all security
 vulnerabilities that were fixed in Symfony releases, starting from Symfony
diff --git a/controller/error_pages.rst b/controller/error_pages.rst
@@ -150,7 +150,7 @@ Fortunately, the default ``ExceptionController`` allows you to preview your
 *error* pages during development.
 
 To use this feature, you need to load some special routes provided by TwigBundle
-(if the application uses :doc:`Symfony Flex </setup/flex>` they are loaded
+(if the application uses :ref:`Symfony Flex <symfony-flex>` they are loaded
 automatically when installing Twig support):
 
 .. configuration-block::
diff --git a/deployment.rst b/deployment.rst
@@ -170,7 +170,7 @@ as you normally do:
 
     If you get a "class not found" error during this step, you may need to
     run ``export APP_ENV=prod`` (or ``export SYMFONY_ENV=prod`` if you're not
-    using :doc:`Symfony Flex </setup/flex>`) before running this command so
+    using :ref:`Symfony Flex <symfony-flex>`) before running this command so
     that the ``post-install-cmd`` scripts run in the ``prod`` environment.
 
 D) Clear your Symfony Cache
diff --git a/email.rst b/email.rst
@@ -17,7 +17,7 @@ own mail servers as well as using popular email providers like `Mandrill`_,
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the Swift Mailer based mailer before using it:
 
 .. code-block:: terminal
diff --git a/forms.rst b/forms.rst
@@ -17,7 +17,7 @@ learning the most important features of the form library along the way.
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the form feature before using it:
 
 .. code-block:: terminal
diff --git a/frontend/encore/installation.rst b/frontend/encore/installation.rst
@@ -16,7 +16,7 @@ project:
     $ composer require symfony/webpack-encore-bundle
     $ yarn install
 
-If you are using :doc:`Symfony Flex </setup/flex>`, this will install and enable
+If you are using :ref:`Symfony Flex <symfony-flex>`, this will install and enable
 the `WebpackEncoreBundle`_, create the ``assets/`` directory, add a
 ``webpack.config.js`` file, and add ``node_modules/`` to ``.gitignore``. You can
 skip the rest of this article and go write your first JavaScript and CSS by
diff --git a/mailer.rst b/mailer.rst
@@ -55,9 +55,9 @@ Postmark            ``composer require symfony/postmark-mailer``
 SendGrid            ``composer require symfony/sendgrid-mailer``
 ==================  =============================================
 
-Each library includes a :ref:`Flex recipe <flex-recipe>` that will add example configuration
-to your ``.env`` file. For example, suppose you want to use SendGrid. First,
-install it:
+Each library includes a :ref:`Symfony Flex recipe <symfony-flex>` that will add
+example configuration to your ``.env`` file. For example, suppose you want to
+use SendGrid. First, install it:
 
 .. code-block:: terminal
 
diff --git a/mercure.rst b/mercure.rst
@@ -47,7 +47,7 @@ Installation
 Installing the Symfony Component
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the Mercure support before using it:
 
 .. code-block:: terminal
diff --git a/messenger.rst b/messenger.rst
@@ -12,7 +12,7 @@ handle them immediately in your application or send them through transports
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install messenger:
 
 .. code-block:: terminal
diff --git a/migration.rst b/migration.rst
@@ -52,7 +52,7 @@ faster on fixing deprecations to be able to upgrade.
 .. tip::
 
     When upgrading to Symfony you might be tempted to also use
-    :doc:`Flex </setup/flex>`. Please keep in mind that it primarily
+    :ref:`Flex <symfony-flex>`. Please keep in mind that it primarily
     focuses on bootstrapping a new Symfony application according to best
     practices regarding the directory structure. When you work in the
     constraints of an existing application you might not be able to
diff --git a/page_creation.rst b/page_creation.rst
@@ -133,7 +133,7 @@ Auto-Installing Recipes with Symfony Flex
 
 You may not have noticed, but when you ran ``composer require annotations``, two
 special things happened, both thanks to a powerful Composer plugin called
-:doc:`Flex </setup/flex>`.
+:ref:`Flex <symfony-flex>`.
 
 First, ``annotations`` isn't a real package name: it's an *alias* (i.e. shortcut)
 that Flex resolves to ``sensio/framework-extra-bundle``.
@@ -145,9 +145,6 @@ to do a lot, like adding configuration files, creating directories, updating ``.
 and adding new config to your ``.env`` file. Flex *automates* the installation of
 packages so you can get back to coding.
 
-You can learn more about Flex by reading ":doc:`/setup/flex`". But that's not necessary:
-Flex works automatically in the background when you add packages.
-
 The bin/console Command
 -----------------------
 
diff --git a/profiler.rst b/profiler.rst
@@ -8,7 +8,7 @@ environments as it will lead to major security vulnerabilities in your project.
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the profiler before using it:
 
 .. code-block:: terminal
diff --git a/security.rst b/security.rst
@@ -30,7 +30,7 @@ A few other important topics are discussed after.
 1) Installation
 ---------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the security feature before using it:
 
 .. code-block:: terminal
diff --git a/security/ldap.rst b/security/ldap.rst
@@ -37,7 +37,7 @@ This means that the following scenarios will work:
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the Ldap component before using it:
 
 .. code-block:: terminal
diff --git a/serializer.rst b/serializer.rst
@@ -14,7 +14,7 @@ its philosophy and the normalizers and encoders terminology.
 Installation
 ------------
 
-In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
+In applications using :ref:`Symfony Flex <symfony-flex>`, run this command to
 install the serializer before using it:
 
 .. code-block:: terminal
diff --git a/setup.rst b/setup.rst
diff --git a/setup/flex.rst b/setup/flex.rst
diff --git a/setup/symfony_server.rst b/setup/symfony_server.rst
diff --git a/setup/upgrade_major.rst b/setup/upgrade_major.rst
diff --git a/testing.rst b/testing.rst
diff --git a/validation.rst b/validation.rst
diff --git a/workflow.rst b/workflow.rst
