minor #4250 Clarifying Bundle Best Practices is for *reusable* bundles (weaverryan)

weaverryan · weaverryan · commit ef11ef40d1cc · 2014-10-06T10:06:57.000-04:00
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes #4250). Discussion ---------- Clarifying Bundle Best Practices is for *reusable* bundles | Q | A | ------------- | --- | Doc fix? | no | New docs? | No | Applies to | 2.3+ | Fixed tickets | Hi guys! I wanted to be a little bit more clear that the bundle best practices doc is all about structuring your reusable bundles, not necessarily your application bundles. I realize I broke from the Cookbook-standard of "How to..." title, but this title sounded the best to me. I'm also not worried about breaking the anchor on the top title, since it's already the top of the page. Thanks! Commits ------- 1caa1fd Some fixes thanks to @stof e7b1ae3 Clarifying that the bundles best practices entry is for reusable bundles, not for app bundles
diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst
@@ -1,12 +1,19 @@
 .. index::
    single: Bundle; Best practices
 
-How to Use best Practices for Structuring Bundles
-=================================================
+Best Practices for Reusable Bundles
+===================================
 
-A bundle is a directory that has a well-defined structure and can host anything
-from classes to controllers and web resources. Even if bundles are very
-flexible, you should follow some best practices if you want to distribute them.
+There are 2 types of bundles:
+
+* Application-specific bundles: only used to build your application;
+* Reusable bundles: meant to be shared across many projects.
+
+This article is all about how to structure your **reusable bundles** so that
+they're easy to configure and extend. Many of these recommendations do not
+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.
 
 .. index::
    pair: Bundle; Naming conventions
