Skip to content

Added standard bundle installation instructions #4163

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.

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

Closed
wants to merge 11 commits into from
47 changes: 47 additions & 0 deletions cookbook/bundles/best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,53 @@ semantic configuration described in the cookbook.
If you are defining services, they should also be prefixed with the bundle
alias.

Installation instructions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instructions (upper-cased)

-------------------------

In order to ease the installation process of third-party bundles, we propose
you to use the following standardized instructions in your ``README`` file:

.. code-block::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need a language here. I guess markdown doesn't work. Can you check whether or not this renders properly when you use rst?


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

Step 1: Download the bundle
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bundle

---------------------------

Use Composer to add the bundle as a new dependency of your project:

.. code-block:: bash

$ composer require "<vendor>/<bundle-name>:dev-master"

This command requires to have installed Composer globally, as explained
`in the installation chapter <https://getcomposer.org/doc/00-intro.md>`_
of Composer documentation.

Step 2: Enable the bundle
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bundle

-------------------------

Then, enable the bundle adding the following line in the ``AppKernel`` class
of your project:

.. code-block:: php

<?php
// app/AppKernel.php

public function registerBundles()
{
$bundles = array(
// ...

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

(optionally add *Step 3*, *Step 4*, etc. to explain other required
installation steps, such as registering routes or dumping assets)

Learn more from the Cookbook
----------------------------

Expand Down