8000 Updated the best practices article for reusable bundles by javiereguiluz · Pull Request #5014 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Updated the best practices article for reusable bundles #5014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 26, 2015
Merged

Updated the best practices article for reusable bundles #5014

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a391563
Updated the best practices article for reusable bundles
javiereguiluz Feb 19, 2015
9981193
Minor fixes and added a cross link
javiereguiluz Feb 19, 2015
fa0b902
Fixed a minor syntax issue
javiereguiluz Jun 24, 2015
4276ced
Added back some information wrongly removed during the rebase
javiereguiluz Jun 24, 2015
776eaee
Reworded as a definition list
javiereguiluz Jun 24, 2015
286631d
Added a blank line beteen definition list items
javiereguiluz Jun 24, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added back some information wrongly removed during the rebase
  • Loading branch information
@javiereguiluz
javiereguiluz committed Jun 24, 2015
commit 4276ced28474d7b56dfc169d51fbf93dfbdea873
119 changes: 86 additions & 33 deletions cookbook/bundles/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,55 +194,108 @@ Installation Instructions
In order to ease the installation of third-party bundles, consider using the
following standardized instructions in your ``README.md`` file.

.. code-block:: text
.. configuration-block::

Installation
============
.. code-block:: markdown

Step 1: Download the Bundle
---------------------------
Installation
============

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:
Step 1: Download the Bundle
---------------------------

```bash
$ composer require <package-name> "~1"
```
Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:

This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.
```bash
$ composer require <package-name> "~1"
```

Step 2: Enable the Bundle
-------------------------
This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.

Then, enable the bundle by adding the following in the `app/AppKernel.php`
file of your project:
Step 2: Enable the Bundle
-------------------------

```php
<?php
// app/AppKernel.php
Then, enable the bundle by adding it to the list of registered bundles
in the `app/AppKernel.php` file of your project:

// ...
class AppKernel extends Kernel
{
public function registerBundles()
```php
<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
$bundles = array(
// ...
public function registerBundles()
{
$bundles = array(
// ...

new <vendor>\<bundle-name>\<bundle-long-name>(),
);

new <vendor>\<bundle-name>\<bundle-long-name>(),
);
// ...
}

// ...
}
```

// ...
}
```
.. code-block:: rst

Installation
============

Step 1: Download the Bundle
---------------------------

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:

.. code-block:: bash

$ composer require <package-name> "~1"

This command requires you to have Composer installed globally, as explained
in the `installation chapter`_ of the Composer documentation.

Step 2: Enable the Bundle
-------------------------

Then, enable the bundle by adding it to the list of registered bundles
in the ``app/AppKernel.php`` file of your project:

.. code-block:: php

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...

new <vendor>\<bundle-name>\<bundle-long-name>(),
);

// ...
}

// ...
}

.. _`installation chapter`: https://getcomposer.org/doc/00-intro.md

This template assumes that your bundle is in its ``1.x`` version. If not, change
the ``"~1"`` installation version accordingly (``"~2"``, ``"~3"``, etc.)
The example above assumes that you are installing the latest stable version of
the bundle, where you don't have to provide the package version number
(e.g. ``composer require friendsofsymfony/user-bundle``). If the installation
instructions refer to some past bundle version or to some unstable version,
include the version constraint (e.g. ``composer require friendsofsymfony/user-bundle "~2.0@dev"``).

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