Skip to content

Commit

Permalink
feature #4377 Added interlinking and fixed install template for reusa…
Browse files Browse the repository at this point in the history
…ble bundles (WouterJ)

This PR was merged into the 2.3 branch.

Discussion
----------

Added interlinking and fixed install template for reusable bundles

| Q   | A
| --- | ---
| Doc fix? | yes
| New docs? | no
| Applies to | all
| Fixet tickets | -

See commit descriptions for more info

Commits
-------

35d8e5f Reverted removal of version
94f04a4 Added interlinking between the 2 best practices
  • Loading branch information
weaverryan committed Nov 7, 2014
2 parents a27238e + 35d8e5f commit 12a09ab
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion cookbook/bundles/best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ apply to application bundles because you'll want to keep those as simple
as possible. For application bundles, just follow the practices shown throughout
the book and cookbook.

.. seealso::

The best practices for application-specific bundles are discussed in
:doc:`/best_practices/introduction`.

.. index::
pair: Bundle; Naming conventions

Expand Down Expand Up @@ -219,7 +224,7 @@ following standardized instructions in your ``README.md`` file.
following command to download the latest stable version of this bundle:
```bash
$ composer require <package-name>
$ composer require <package-name> "~1"
```
This command requires you to have Composer installed globally, as explained
Expand Down Expand Up @@ -254,6 +259,9 @@ following standardized instructions in your ``README.md`` file.
}
```
This template assumes that your bundle is in its ``1.x`` version. If not, change
the ``"~1"`` installation version accordingly (``"~2"``, ``"~3"``, etc.)

Optionally, you can add more installation steps (*Step 3*, *Step 4*, etc.) to
explain other required installation tasks, such as registering routes or
dumping assets.
Expand Down

0 comments on commit 12a09ab

Please sign in to comment.