Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 55b3358

Browse filesBrowse files
javiereguiluzweaverryan
authored andcommitted
Removed the sidebar and made some minor tweaks
1 parent 9ae352d commit 55b3358
Copy full SHA for 55b3358

File tree

Expand file treeCollapse file tree

1 file changed

+35
-37
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+35
-37
lines changed

‎cookbook/bundles/best_practices.rst

Copy file name to clipboardExpand all lines: cookbook/bundles/best_practices.rst
+35-37Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -197,56 +197,54 @@ the only mandatory file and must be the entry point for the documentation.
197197
Installation Instructions
198198
~~~~~~~~~~~~~~~~~~~~~~~~~
199199

200-
In order to ease the installation process of third-party bundles, consider using
201-
the following standardized instructions in your ``README.md`` file.
200+
In order to ease the installation of third-party bundles, consider using the
201+
following standardized instructions in your ``README.md`` file.
202202

203-
.. sidebar:: Installation Instructions Template
204-
205-
This template assumes that your bundle is in its ``1.x`` version. If not,
206-
change the ``"~1"`` installation version accordingly (e.g. ``"~2"``).
207-
208-
.. code-block:: text
203+
.. code-block:: text
209204
210-
Installation
211-
============
205+
Installation
206+
============
212207
213-
Step 1: Download the Bundle
214-
---------------------------
208+
Step 1: Download the Bundle
209+
---------------------------
215210
216-
Use Composer to add the bundle as a new dependency of your project:
211+
Use Composer to add the bundle as a new dependency of your project:
217212
218-
```bash
219-
$ composer require <package-name> "~1"
220-
```
213+
```bash
214+
$ composer require <package-name> "~1"
215+
```
221216
222-
This command requires to have Composer installed globally, as explained
223-
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
224-
of Composer documentation.
217+
This command requires to have Composer installed globally, as explained
218+
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
219+
of Composer documentation.
225220
226-
Step 2: Enable the Bundle
227-
-------------------------
221+
Step 2: Enable the Bundle
222+
-------------------------
228223
229-
Then, enable the bundle adding the following line in the `AppKernel`
230-
class of your project:
224+
Then, enable the bundle adding the following line in the `AppKernel`
225+
class of your project:
231226
232-
```php
233-
<?php
234-
// app/AppKernel.php
227+
```php
228+
<?php
229+
// app/AppKernel.php
235230
236-
// ...
231+
// ...
237232
238-
public function registerBundles()
239-
{
240-
$bundles = array(
241-
// ...
242-
return new <vendor>\<bundle-name>\<bundle-long-name>(),
243-
);
244-
}
245-
```
233+
public function registerBundles()
234+
{
235+
$bundles = array(
236+
// ...
237+
return new <vendor>\<bundle-name>\<bundle-long-name>(),
238+
);
239+
}
240+
```
246241
247-
Optionally, you can add *Step 3*, *Step 4*, etc. to explain other required
248-
installation steps, such as registering routes or dumping assets.
242+
This template assumes that your bundle is in its ``1.x`` version. If not, change
243+
the ``"~1"`` installation version accordingly (``"~2"``, ``"~3"``, etc.)
249244

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

251249
Routing
252250
-------

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.