Skip to content

Commit

Permalink
Add deprecation note to getting-started chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
SenseException committed Sep 7, 2018
1 parent d36aec8 commit ff1df41
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions docs/en/tutorials/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,21 @@ Install Doctrine using the Composer Dependency Management tool, by calling:
$ composer install

This will install the packages Doctrine Common, Doctrine DBAL, Doctrine ORM,
Symfony YAML and Symfony Console into the `vendor` directory. The Symfony
dependencies are not required by Doctrine but will be used in this tutorial.
into the `vendor` directory.

Add the following directories:
::

doctrine2-tutorial
|-- config
| |-- xml
| `-- xml
| `-- yaml
`-- src

.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

Obtaining the EntityManager
---------------------------

Expand Down Expand Up @@ -150,6 +153,10 @@ step:
// obtaining the entity manager
$entityManager = EntityManager::create($conn, $config);
.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

The require_once statement sets up the class autoloading for Doctrine and
its dependencies using Composer's autoloader.

Expand Down Expand Up @@ -308,6 +315,10 @@ but you only need to choose one.
</entity>
</doctrine-mapping>
.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

.. code-block:: yaml
# config/yaml/Product.dcm.yml
Expand Down Expand Up @@ -851,6 +862,10 @@ the ``Product`` before:
</entity>
</doctrine-mapping>
.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

.. code-block:: yaml
# config/yaml/Bug.dcm.yml
Expand Down Expand Up @@ -963,6 +978,10 @@ Finally, we'll add metadata mappings for the ``User`` entity.
</entity>
</doctrine-mapping>
.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

.. code-block:: yaml
# config/yaml/User.dcm.yml
Expand Down Expand Up @@ -1493,6 +1512,10 @@ we have to adjust the metadata slightly.
</entity>
</doctrine-mapping>
.. note::
The YAML driver is deprecated and will be removed in version 3.0.
It is strongly recommended to switch to one of the other mappings.

.. code-block:: yaml
Bug:
Expand Down

0 comments on commit ff1df41

Please sign in to comment.