Skip to content

Commit

Permalink
Merge pull request #46 from sensiolabs/fix_references
Browse files Browse the repository at this point in the history
Fix all references
  • Loading branch information
weaverryan authored Jul 12, 2016
2 parents f45eff4 + 91805f1 commit dc97c65
Show file tree
Hide file tree
Showing 157 changed files with 434 additions and 439 deletions.
4 changes: 2 additions & 2 deletions assetic/asset_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ To include an image you can use the ``image`` tag.
<?php endforeach ?>

You can also use Assetic for image optimization. More information in
:doc:`/cookbook/assetic/jpeg_optimize`.
:doc:`/assetic/jpeg_optimize`.

.. tip::

Expand Down Expand Up @@ -441,7 +441,7 @@ into your template:
<?php endforeach ?>
A more detailed guide about configuring and using Assetic filters as well as
details of Assetic's debug mode can be found in :doc:`/cookbook/assetic/uglifyjs`.
details of Assetic's debug mode can be found in :doc:`/assetic/uglifyjs`.

Controlling the URL Used
------------------------
Expand Down
2 changes: 1 addition & 1 deletion assetic/yuicompressor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ How to Minify JavaScripts and Stylesheets with YUI Compressor

The YUI Compressor is `no longer maintained by Yahoo`_. That's why you are
**strongly advised to avoid using YUI utilities** unless strictly necessary.
Read :doc:`/cookbook/assetic/uglifyjs` for a modern and up-to-date alternative.
Read :doc:`/assetic/uglifyjs` for a modern and up-to-date alternative.

Yahoo! provides an excellent utility for minifying JavaScripts and stylesheets
so they travel over the wire faster, the `YUI Compressor`_. Thanks to Assetic,
Expand Down
6 changes: 3 additions & 3 deletions best_practices/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ add an extra layer of configuration that's not needed because you don't need
or want these configuration values to change on each server.

The configuration options defined in the ``config.yml`` file usually vary from
one :doc:`environment </cookbook/configuration/environments>` to another. That's
one :doc:`environment </configuration/environments>` to another. That's
why Symfony already includes ``app/config/config_dev.yml`` and ``app/config/config_prod.yml``
files so that you can override specific values for each environment.

Expand Down Expand Up @@ -160,7 +160,7 @@ Semantic Configuration: Don't Do It

Don't define a semantic dependency injection configuration for your bundles.

As explained in :doc:`/cookbook/bundles/extension` article, Symfony bundles
As explained in :doc:`/bundles/extension` article, Symfony bundles
have two choices on how to handle configuration: normal service configuration
through the ``services.yml`` file and semantic configuration through a special
``*Extension`` class.
Expand All @@ -176,7 +176,7 @@ Moving Sensitive Options Outside of Symfony Entirely
When dealing with sensitive options, like database credentials, we also recommend
that you store them outside the Symfony project and make them available
through environment variables. Learn how to do it in the following article:
:doc:`/cookbook/configuration/external_parameters`
:doc:`/configuration/external_parameters`.

.. _`feature toggles`: https://en.wikipedia.org/wiki/Feature_toggle
.. _`constant() function`: http://twig.sensiolabs.org/doc/functions/constant.html
2 changes: 1 addition & 1 deletion best_practices/controllers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,6 @@ Pre and Post Hooks

If you need to execute some code before or after the execution of your controllers,
you can use the EventDispatcher component to
:doc:`set up before and after filters </cookbook/event_dispatcher/before_after_filters>`.
:doc:`set up before and after filters </event_dispatcher/before_after_filters>`.

.. _`ParamConverter`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
8 changes: 4 additions & 4 deletions best_practices/creating-the-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installer**, which has to be installed before creating your first project.

Use the Symfony Installer to create new Symfony-based projects.

Read the :doc:`installation chapter </book/installation>` of the Symfony Book to
Read the :doc:`installation chapter </installation>` of the Symfony Book to
learn how to install and use the Symfony Installer.

.. _linux-and-mac-os-x-systems:
Expand Down Expand Up @@ -119,7 +119,7 @@ Symfony documentation uses the AppBundle name.
.. note::

Another reason to create a new bundle is when you're overriding something
in a vendor's bundle (e.g. a controller). See :doc:`/cookbook/bundles/inheritance`.
in a vendor's bundle (e.g. a controller). See :doc:`/bundles/inheritance`.

All in all, this is the typical directory structure of a Symfony application
that follows these best practices:
Expand Down Expand Up @@ -154,7 +154,7 @@ Extending the Directory Structure

If your project or infrastructure requires some changes to the default directory
structure of Symfony, you can
:doc:`override the location of the main directories </cookbook/configuration/override_dir_structure>`:
:doc:`override the location of the main directories </configuration/override_dir_structure>`:
``cache/``, ``logs/`` and ``web/``.

In addition, Symfony3 will use a slightly different directory structure when
Expand All @@ -181,4 +181,4 @@ the Symfony directory structure.
.. _`Composer`: https://getcomposer.org/
.. _`Phar extension`: http://php.net/manual/en/intro.phar.php
.. _`public checksums repository`: https://github.com/sensiolabs/checksums
.. _`these steps`: http://fabien.potencier.org/signing-project-releases.html
.. _`these steps`: http://fabien.potencier.org/signing-project-releases.html
2 changes: 1 addition & 1 deletion best_practices/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ all of the fields:

If you need more control over how your fields are rendered, then you should
remove the ``form_widget(form)`` function and render your fields individually.
See the :doc:`/cookbook/form/form_customization` cookbook article for more information
See the :doc:`/form/form_customization` cookbook article for more information
on this and how you can control *how* the form renders at a global level
using form theming.

Expand Down
19 changes: 9 additions & 10 deletions best_practices/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Authentication and Firewalls (i.e. Getting the User's Credentials)
------------------------------------------------------------------

You can configure Symfony to authenticate your users using any method you
want and to load user information from any source. This is a complex topic,
but the :doc:`Security Cookbook Section </cookbook/security/index>` has a
lot of information about this.
want and to load user information from any source. This is a complex topic, but
the :doc:`Security Cookbook Section </security>` has a lot of information about
this.

Regardless of your needs, authentication is configured in ``security.yml``,
primarily under the ``firewalls`` key.
Expand Down Expand Up @@ -127,7 +127,7 @@ Using ``@Security``, this looks like:
Using Expressions for Complex Security Restrictions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If your security logic is a little bit more complex, you can use an `expression`_
If your security logic is a little bit more complex, you can use an :doc:`expression </components/expression_language>`
inside ``@Security``. In the following example, a user can only access the
controller if their email matches the value returned by the ``getAuthorEmail``
method on the ``Post`` object:
Expand Down Expand Up @@ -254,7 +254,7 @@ Security Voters

If your security logic is complex and can't be centralized into a method
like ``isAuthor()``, you should leverage custom voters. These are an order
of magnitude easier than :doc:`ACLs </cookbook/security/acl>` and will give
of magnitude easier than :doc:`ACLs </security/acl>` and will give
you the flexibility you need in almost all cases.

First, create a voter class. The following example shows a voter that implements
Expand Down Expand Up @@ -358,18 +358,17 @@ The `FOSUserBundle`_, developed by the Symfony community, adds support for a
database-backed user system in Symfony. It also handles common tasks like
user registration and forgotten password functionality.

Enable the :doc:`Remember Me feature </cookbook/security/remember_me>` to
Enable the :doc:`Remember Me feature </security/remember_me>` to
allow your users to stay logged in for a long period of time.

When providing customer support, sometimes it's necessary to access the application
as some *other* user so that you can reproduce the problem. Symfony provides
the ability to :doc:`impersonate users </cookbook/security/impersonating_user>`.
the ability to :doc:`impersonate users </security/impersonating_user>`.

If your company uses a user login method not supported by Symfony, you can
develop :doc:`your own user provider </cookbook/security/custom_provider>` and
:doc:`your own authentication provider </cookbook/security/custom_authentication_provider>`.
develop :doc:`your own user provider </security/custom_provider>` and
:doc:`your own authentication provider </security/custom_authentication_provider>`.

.. _`ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
.. _`@Security annotation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/security.html
.. _`expression`: http://symfony.com/doc/current/components/expression_language/introduction.html
.. _`FOSUserBundle`: https://github.com/FriendsOfSymfony/FOSUserBundle
6 changes: 3 additions & 3 deletions best_practices/web-assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ tools like GruntJS.
Use Assetic to compile, combine and minimize web assets, unless you're
comfortable with frontend tools like GruntJS.

:doc:`Assetic </cookbook/assetic/asset_management>` is an asset manager capable
:doc:`Assetic </assetic/asset_management>` is an asset manager capable
of compiling assets developed with a lot of different frontend technologies
like LESS, Sass and CoffeeScript. Combining all your assets with Assetic is a
matter of wrapping all the assets with a single Twig tag:
Expand Down Expand Up @@ -87,8 +87,8 @@ Learn More about Assetic
------------------------

Assetic can also minimize CSS and JavaScript assets
:doc:`using UglifyCSS/UglifyJS </cookbook/assetic/uglifyjs>` to speed up your
websites. You can even :doc:`compress images </cookbook/assetic/jpeg_optimize>`
:doc:`using UglifyCSS/UglifyJS </assetic/uglifyjs>` to speed up your
websites. You can even :doc:`compress images </assetic/jpeg_optimize>`
with Assetic to reduce their size before serving them to the user. Check out
the `official Assetic documentation`_ to learn more about all the available
features.
Expand Down
4 changes: 2 additions & 2 deletions bundles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ in your application and to optimize them the way you want.

.. note::

While you'll learn the basics here, an entire cookbook entry is devoted
to the organization and best practices of :doc:`bundles </cookbook/bundles/best_practices>`.
While you'll learn the basics here, an entire cookbook entry is devoted
to the organization and best practices of :doc:`bundles </bundles/best_practices>`.

A bundle is simply a structured set of files within a directory that implement
a single feature. You might create a BlogBundle, a ForumBundle or
Expand Down
8 changes: 4 additions & 4 deletions bundles/best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Templates ``Resources/views/`` Yes
Unit and Functional Tests ``Tests/`` No
=============================== ============================= ================

[1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the
[1] See :doc:`/doctrine/mapping_model_classes` for how to handle the
mapping with a compiler pass.

Classes
Expand Down Expand Up @@ -362,7 +362,7 @@ Retrieve the configuration parameters in your code from the container::
$container->getParameter('acme_blog.author.email');

Even if this mechanism is simple enough, you should consider using the more
advanced :doc:`semantic bundle configuration </cookbook/bundles/configuration>`.
advanced :doc:`semantic bundle configuration </bundles/configuration>`.

Versioning
----------
Expand All @@ -381,7 +381,7 @@ be :ref:`defined as private <container-private-services>`.
.. seealso::

You can learn much more about service loading in bundles reading this article:
:doc:`How to Load Service Configuration inside a Bundle </cookbook/bundles/extension>`.
:doc:`How to Load Service Configuration inside a Bundle </bundles/extension>`.

Composer Metadata
-----------------
Expand Down Expand Up @@ -466,7 +466,7 @@ API is being used. The following code, would work for *all* users::
Learn more from the Cookbook
----------------------------

* :doc:`/cookbook/bundles/extension`
* :doc:`/bundles/extension`

.. _`PSR-0`: http://www.php-fig.org/psr/psr-0/
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/
Expand Down
8 changes: 4 additions & 4 deletions bundles/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ bundle configuration would look like:
.. seealso::

Read more about the extension in :doc:`/cookbook/bundles/extension`.
Read more about the extension in :doc:`/bundles/extension`.

.. tip::

Expand All @@ -118,14 +118,14 @@ bundle configuration would look like:
.. seealso::

For parameter handling within a dependency injection container see
:doc:`/cookbook/configuration/using_parameters_in_dic`.
:doc:`/configuration/using_parameters_in_dic`.


Processing the ``$configs`` Array
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

First things first, you have to create an extension class as explained in
:doc:`extension`.
:doc:`/bundles/extension`.

Whenever a user includes the ``acme_social`` key (which is the DI alias) in a
configuration file, the configuration under it is added to an array of
Expand Down Expand Up @@ -285,7 +285,7 @@ to allow one ``Extension`` class to modify the configuration passed to another
bundle's ``Extension`` class, as if the end-developer has actually placed that
configuration in their ``app/config/config.yml`` file. This can be achieved
using a prepend extension. For more details, see
:doc:`/cookbook/bundles/prepend_extension`.
:doc:`/bundles/prepend_extension`.

Dump the Configuration
----------------------
Expand Down
2 changes: 1 addition & 1 deletion bundles/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Using Configuration to Change the Services

The Extension is also the class that handles the configuration for that
particular bundle (e.g. the configuration in ``app/config/config.yml``). To
read more about it, see the ":doc:`/cookbook/bundles/configuration`" article.
read more about it, see the ":doc:`/bundles/configuration`" article.

Adding Classes to Compile
-------------------------
Expand Down
2 changes: 1 addition & 1 deletion bundles/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
}

In a few rare cases, you may want a bundle to be *only* enabled in the development
:doc:`environment </cookbook/configuration/environments>`. For example,
:doc:`environment </configuration/environments>`. For example,
the DoctrineFixturesBundle helps to load dummy data - something you probably
only want to do while developing. To only load this bundle in the ``dev``
and ``test`` environments, register the bundle in this way::
Expand Down
8 changes: 4 additions & 4 deletions bundles/override.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Templates
For information on overriding templates, see

* :ref:`overriding-bundle-templates`.
* :doc:`/cookbook/bundles/inheritance`
* :doc:`/bundles/inheritance`

Routing
-------
Expand All @@ -31,7 +31,7 @@ Controllers

Assuming the third-party bundle involved uses non-service controllers (which
is almost always the case), you can easily override controllers via bundle
inheritance. For more information, see :doc:`/cookbook/bundles/inheritance`.
inheritance. For more information, see :doc:`/bundles/inheritance`.
If the controller is a service, see the next section on how to override it.

Services & Configuration
Expand Down Expand Up @@ -89,7 +89,7 @@ something beyond just the class name, you should use a compiler pass::
In this example you fetch the service definition of the original service, and set
its class name to your own class.

See :doc:`/cookbook/service_container/compiler_passes` for information on how to use
See :doc:`/service_container/compiler_passes` for information on how to use
compiler passes. If you want to do something beyond just overriding the class,
like adding a method call, you can only use the compiler pass method.

Expand Down Expand Up @@ -192,7 +192,7 @@ can override the translations from any translation file, as long as it is in
sure that the bundle containing *your* translations is loaded after any
bundle whose translations you're overriding. This is done in ``AppKernel``.

Translation files are also not aware of :doc:`bundle inheritance </cookbook/bundles/inheritance>`.
Translation files are also not aware of :doc:`bundle inheritance </bundles/inheritance>`.
If you want to override translations from the parent bundle, be sure that the
parent bundle is loaded before the child bundle in the ``AppKernel`` class.

Expand Down
4 changes: 2 additions & 2 deletions cache/varnish.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ authentication, have Varnish remove the corresponding header from requests to
prevent clients from bypassing the cache. In practice, you will need sessions
at least for some parts of the site, e.g. when using forms with
:ref:`CSRF Protection <forms-csrf>`. In this situation, make sure to
:doc:`only start a session when actually needed </cookbook/session/avoid_session_start>`
:doc:`only start a session when actually needed </session/avoid_session_start>`
and clear the session when it is no longer needed. Alternatively, you can look
into :doc:`/cookbook/cache/form_csrf_caching`.
into :doc:`/cache/form_csrf_caching`.

Cookies created in JavaScript and used only in the frontend, e.g. when using
Google Analytics, are nonetheless sent to the server. These cookies are not
Expand Down
2 changes: 1 addition & 1 deletion components/asset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ that path over and over again::
Request Context Aware Assets
............................

If you are also using the :doc:`HttpFoundation </components/http_foundation/introduction>`
If you are also using the :doc:`HttpFoundation </components/http_foundation>`
component in your project (for instance, in a Symfony application), the ``PathPackage``
class can take into account the context of the current request::

Expand Down
2 changes: 1 addition & 1 deletion components/browser_kit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This method accepts a request and should return a response::
For a simple implementation of a browser based on the HTTP layer, have a look
at `Goutte`_. For an implementation based on ``HttpKernelInterface``, have
a look at the :class:`Symfony\\Component\\HttpKernel\\Client` provided by
the :doc:`HttpKernel component </components/http_kernel/introduction>`.
the :doc:`HttpKernel component </components/http_kernel>`.

Making Requests
~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion components/class_loader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Additionally, the Symfony ClassLoader component ships with a wrapper class
which makes it possible
:doc:`to cache the results of a class loader </components/class_loader/cache_class_loader>`.

When using the :doc:`Debug component </components/debug/introduction>`, you
When using the :doc:`Debug component </components/debug>`, you
can also use a special :doc:`DebugClassLoader </components/debug/class_loader>`
that eases debugging by throwing more helpful exceptions when a class could
not be found by a class loader.
Expand Down
2 changes: 1 addition & 1 deletion components/console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ without actually printing.
The MonologBridge provides a :class:`Symfony\\Bridge\\Monolog\\Handler\\ConsoleHandler`
class that allows you to display messages on the console. This is cleaner
than wrapping your output calls in conditions. For an example use in
the Symfony Framework, see :doc:`/cookbook/logging/monolog_console`.
the Symfony Framework, see :doc:`/logging/monolog_console`.

Using Command Arguments
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion components/console/logger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ may not be sent to the :class:`Symfony\\Component\\Console\\Output\\OutputInterf
instance.

By default, the console logger behaves like the
:doc:`Monolog's Console Handler </cookbook/logging/monolog_console>`.
:doc:`Monolog's Console Handler </logging/monolog_console>`.
The association between the log level and the verbosity can be configured
through the second parameter of the :class:`Symfony\\Component\\Console\\ConsoleLogger`
constructor::
Expand Down
2 changes: 1 addition & 1 deletion components/console/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ commands, then you can run ``help`` like this:
If you have commands using ``:`` to namespace commands then you just have
to type the shortest unambiguous text for each part. If you have created the
``demo:greet`` as shown in :doc:`/components/console/introduction` then you
``demo:greet`` as shown in :doc:`/components/console` then you
can run it with:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion components/debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ and more useful::

.. note::

If the :doc:`HttpFoundation component </components/http_foundation/introduction>` is
If the :doc:`HttpFoundation component </components/http_foundation` is
available, the handler uses a Symfony Response object; if not, it falls
back to a regular PHP response.

Expand Down
Loading

0 comments on commit dc97c65

Please sign in to comment.