minor #9418 Improved the "Installation" section of components (javiereguiluz)

javiereguiluz · javiereguiluz · commit e37d7e3c160b · 2018-03-10T19:57:32.000+01:00
This PR was squashed before being merged into the 2.7 branch (closes #9418). Discussion ---------- Improved the "Installation" section of components The current docs were written when Composer was new. Nowadays everybody should know and use Composer ... and for those who still don't, we provide a link to the article that explains all this in detail, so I think we're good. Commits ------- 9162272 Improved the "Installation" section of components
diff --git a/components/asset.rst b/components/asset.rst
@@ -45,10 +45,13 @@ simple. Hardcoding URLs can be a disadvantage because:
 Installation
 ------------
 
-You can install the component in two different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/asset`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/asset).
+    $ composer require symfony/asset
+
+Alternatively, you can clone the `<https://github.com/symfony/asset>`_ repository.
+
+.. include:: /components/require_autoload.rst.inc
 
 Usage
 -----
diff --git a/components/browser_kit.rst b/components/browser_kit.rst
@@ -17,11 +17,13 @@ The BrowserKit Component
 Installation
 ------------
 
-You can install the component in two different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>`
-  (``symfony/browser-kit`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/browser-kit).
+    $ composer require symfony/browser-kit
+
+Alternatively, you can clone the `<https://github.com/symfony/browser-kit>`_ repository.
+
+.. include:: /components/require_autoload.rst.inc
 
 Basic Usage
 -----------
diff --git a/components/class_loader.rst b/components/class_loader.rst
@@ -41,11 +41,11 @@ not be found by a class loader.
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/class-loader``
-  on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/class-loader).
+    $ composer require symfony/class-loader
+
+Alternatively, you can clone the `<https://github.com/symfony/class-loader>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/config.rst b/components/config.rst
@@ -12,11 +12,11 @@ The Config Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/config``
-  on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/config).
+    $ composer require symfony/config
+
+Alternatively, you can clone the `<https://github.com/symfony/config>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/console.rst b/components/console.rst
@@ -15,10 +15,11 @@ other batch jobs.
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/console`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/console).
+    $ composer require symfony/console
+
+Alternatively, you can clone the `<https://github.com/symfony/console>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/css_selector.rst b/components/css_selector.rst
@@ -10,10 +10,11 @@ The CssSelector Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/css-selector`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/css-selector).
+    $ composer require symfony/css-selector
+
+Alternatively, you can clone the `<https://github.com/symfony/css-selector>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/debug.rst b/components/debug.rst
@@ -14,10 +14,11 @@ The Debug Component
 Installation
 ------------
 
-You can install the component in many different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/debug`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/debug).
+    $ composer require symfony/debug
+
+Alternatively, you can clone the `<https://github.com/symfony/debug>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/dependency_injection.rst b/components/dependency_injection.rst
@@ -14,11 +14,11 @@ For an introduction to Dependency Injection and service containers see
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/dependency-injection``
-  on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/dependency-injection).
+    $ composer require symfony/dependency-injection
+
+Alternatively, you can clone the `<https://github.com/symfony/dependency-injection>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/dom_crawler.rst b/components/dom_crawler.rst
@@ -15,10 +15,11 @@ The DomCrawler Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/dom-crawler`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/dom-crawler).
+    $ composer require symfony/dom-crawler
+
+Alternatively, you can clone the `<https://github.com/symfony/dom-crawler>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/event_dispatcher.rst b/components/event_dispatcher.rst
@@ -52,11 +52,11 @@ event - ``kernel.response``. Here's how it works:
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>`
-  (``symfony/event-dispatcher`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/event-dispatcher).
+    $ composer require symfony/event-dispatcher
+
+Alternatively, you can clone the `<https://github.com/symfony/event-dispatcher>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/expression_language.rst b/components/expression_language.rst
@@ -12,10 +12,13 @@ The ExpressionLanguage Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/expression-language`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/expression-language).
+    $ composer require symfony/expression-language
+
+Alternatively, you can clone the `<https://github.com/symfony/expression-language>`_ repository.
+
+.. include:: /components/require_autoload.rst.inc
 
 How can the Expression Engine Help Me?
 --------------------------------------
diff --git a/components/filesystem.rst b/components/filesystem.rst
@@ -14,10 +14,11 @@ The Filesystem Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/filesystem`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/filesystem).
+    $ composer require symfony/filesystem
+
+Alternatively, you can clone the `<https://github.com/symfony/filesystem>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/finder.rst b/components/finder.rst
@@ -11,10 +11,11 @@ The Finder Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/finder`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/finder).
+    $ composer require symfony/finder
+
+Alternatively, you can clone the `<https://github.com/symfony/finder>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/form.rst b/components/form.rst
@@ -16,10 +16,11 @@ be from a normal form post or from an API.
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
+
+    $ composer require symfony/form
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/form`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/form).
+Alternatively, you can clone the `<https://github.com/symfony/form>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -19,10 +19,11 @@ variables and functions by an object-oriented layer.
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/http-foundation`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/http-foundation).
+    $ composer require symfony/http-foundation
+
+Alternatively, you can clone the `<https://github.com/symfony/http-foundation>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/http_kernel.rst b/components/http_kernel.rst
@@ -14,10 +14,11 @@ The HttpKernel Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/http-kernel`` on Packagist_);
-* Use the official Git repository (https://github.com/symfony/http-kernel).
+    $ composer require symfony/http-kernel
+
+Alternatively, you can clone the `<https://github.com/symfony/http-kernel>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/intl.rst b/components/intl.rst
@@ -20,10 +20,13 @@ The Intl Component
 Installation
 ------------
 
-You can install the component in two different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer</components/using_components>` (``symfony/intl`` on `Packagist`_);
-* Using the official Git repository (https://github.com/symfony/intl).
+    $ composer require symfony/intl
+
+Alternatively, you can clone the `<https://github.com/symfony/intl>`_ repository.
+
+.. include:: /components/require_autoload.rst.inc
 
 If you install the component via Composer, the following classes and functions
 of the intl extension will be automatically provided if the intl extension is
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -12,10 +12,11 @@ The OptionsResolver Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/options-resolver`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/options-resolver).
+    $ composer require symfony/options-resolver
+
+Alternatively, you can clone the `<https://github.com/symfony/options-resolver>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/phpunit_bridge.rst b/components/phpunit_bridge.rst
@@ -25,12 +25,11 @@ It comes with the following features:
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>`
-  (``symfony/phpunit-bridge`` on `Packagist`_); as a dev dependency;
+    $ composer require symfony/phpunit-bridge
 
-* Use the official Git repository (https://github.com/symfony/phpunit-bridge).
+Alternatively, you can clone the `<https://github.com/symfony/phpunit-bridge>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/process.rst b/components/process.rst
@@ -10,10 +10,11 @@ The Process Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/process`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/process).
+    $ composer require symfony/process
+
+Alternatively, you can clone the `<https://github.com/symfony/process>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/property_access.rst b/components/property_access.rst
@@ -11,10 +11,11 @@ The PropertyAccess Component
 Installation
 ------------
 
-You can install the component in two different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer</components/using_components>` (``symfony/property-access`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/property-access).
+    $ composer require symfony/property-access
+
+Alternatively, you can clone the `<https://github.com/symfony/property-access>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/psr7.rst b/components/psr7.rst
@@ -11,10 +11,13 @@ The PSR-7 Bridge
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (`symfony/psr-http-message-bridge on Packagist`_);
-* Use the official Git repository (https://github.com/symfony/psr-http-message-bridge).
+    $ composer require symfony/psr-http-message-bridge
+
+Alternatively, you can clone the `<https://github.com/symfony/psr-http-message-bridge>`_ repository.
+
+.. include:: /components/require_autoload.rst.inc
 
 The bridge also needs a PSR-7 implementation to allow converting HttpFoundation
 objects to PSR-7 objects. It provides native support for `Zend Diactoros`_.
diff --git a/components/require_autoload.rst.inc b/components/require_autoload.rst.inc
@@ -1,3 +1,6 @@
-Then, require the ``vendor/autoload.php`` file to enable the autoloading mechanism
-provided by Composer. Otherwise, your application won't be able to find the classes
-of this Symfony component.
+.. note::
+
+    If you install this component outside of a Symfony application, you must
+    require the ``vendor/autoload.php`` file in your code to enable the class
+    autoloading mechanism provided by Composer. Read
+    :doc:`this article </components/using_components>` for more details.
diff --git a/components/routing.rst b/components/routing.rst
@@ -11,10 +11,11 @@ The Routing Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/routing`` on `Packagist`_);
-* Use the official Git repository (https://github.com/symfony/routing).
+    $ composer require symfony/routing
+
+Alternatively, you can clone the `<https://github.com/symfony/routing>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/security.rst b/components/security.rst
@@ -14,10 +14,11 @@ The Security Component
 Installation
 ------------
 
-You can install the component in 2 different ways:
+.. code-block:: terminal
 
-* :doc:`Install it via Composer </components/using_components>` (``symfony/security`` on Packagist_);
-* Use the official Git repository (https://github.com/symfony/security).
+    $ composer require symfony/security
+
+Alternatively, you can clone the `<https://github.com/symfony/security>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
diff --git a/components/serializer.rst b/components/serializer.rst
diff --git a/components/stopwatch.rst b/components/stopwatch.rst
diff --git a/components/templating.rst b/components/templating.rst
diff --git a/components/translation.rst b/components/translation.rst
diff --git a/components/validator.rst b/components/validator.rst
diff --git a/components/var_dumper.rst b/components/var_dumper.rst
diff --git a/components/yaml.rst b/components/yaml.rst
