Merge pull request #342 from WouterJ/fix_index

[RFC] Refactored Index page

Author: dbu

bundles/map.rst.inc

@@ -1,3 +1,9 @@
+Key Bundles
+~~~~~~~~~~~
+
+Most of the Symfony CMF bundles provide some functionality, they integrate a
+library or they introduce a complete new concept.
+
 * :doc:`block/index`
 
   * :doc:`block/introduction`
@@ -6,14 +12,6 @@
   * :doc:`block/cache`
   * :doc:`block/relation_to_sonata_block_bundle`
 
-* **BlogBundle**
-
-  * :doc:`blog`
-
-* :doc:`content/index`
-
-  * :doc:`content/introduction`
-
 * :doc:`core/index`
 
   * :doc:`core/introduction`
@@ -28,10 +26,6 @@
   * :doc:`create/other-editors`
   * :doc:`create/developing-hallo`
 
-* **DoctrinePHPCRBundle**
-
-  * :doc:`phpcr_odm`
-
 * :doc:`media/index`
 
   * :doc:`media/introduction`
@@ -56,17 +50,43 @@
 
 * :doc:`search/introduction`
 
+* :doc:`tree_browser/index`
+
+  * :doc:`tree_browser/introduction`
+
+Showcase Bundles
+~~~~~~~~~~~~~~~~
+
+Other bundles provide an example on how to use these key bundles. They all
+show a different way of implementing a concept. You can use these bundles in
+your project, but you can also get ideas from these bundles to create your own
+bundle based on the key bundles.
+
+* **BlogBundle**
+
+  * :doc:`blog`
+
+* :doc:`content/index`
+
+  * :doc:`content/introduction`
+
 * :doc:`simple_cms/index`
 
   * :doc:`simple_cms/introduction`
   * :doc:`simple_cms/multilang`
   * :doc:`simple_cms/rendering`
   * :doc:`simple_cms/extending_page_class`
 
-* **SonataDoctrinePhpcrAdminBundle**
+Contributed Bundles
+~~~~~~~~~~~~~~~~~~~
 
-  * :doc:`doctrine_phpcr_admin`
+Besides that, the Symfony CMF team also maintains some 3th party bundles which
+help with integrating PHPCR concepts into the Symfony Framework.
 
-* :doc:`tree_browser/index`
+* **DoctrinePHPCRBundle**
 
-  * :doc:`tree_browser/introduction`
+  * :doc:`phpcr_odm`
+
+* **SonataDoctrinePhpcrAdminBundle**
+
+  * :doc:`doctrine_phpcr_admin`

components/map.rst.inc

@@ -9,3 +9,8 @@
 * **Testing**
 
   * :doc:`testing`
+
+.. note::
+
+    The Testing component is a bit strange, as it can only be used with the
+    symfony framework. There are plans to change this in the feature.

contributing/index.rst

@@ -6,6 +6,7 @@ Contributing
 
     code
     bundles
+    releases
     license
 
 .. include:: map.rst.inc

index.rst

@@ -59,6 +59,7 @@ will typically want to keep this close at hand.
 
 .. toctree::
     :maxdepth: 1
+    :numbered:
 
     book/installation
     book/simplecms
@@ -70,38 +71,20 @@ will typically want to keep this close at hand.
 Bundles
 -------
 
-Looking for some in depth information about a CMF Bundle? Want a list of all the
-configuration options of a bundle? Want to know if you can use a bundle independently and how
-to do it? In this case the reference is the right place for you.
+Looking for some in depth information about a CMF Bundle? Want to know if you
+can use a bundle independently and how to do it? In this case the bundles
+section is the right place for you!
 
-.. toctree::
-    :maxdepth: 1
-
-    bundles/block/index
-    bundles/blog
-    bundles/content/index
-    bundles/core/index
-    bundles/create/index
-    bundles/phpcr_odm
-    bundles/media/index
-    bundles/menu/index
-    bundles/routing/index
-    bundles/routing_auto
-    bundles/search/index
-    bundles/simple_cms/index
-    bundles/doctrine_phpcr_admin
-    bundles/tree_browser/index
+:doc:`Browse the bundles <bundles/index>`
 
 Components
 ----------
 
-Looking for some information about the low level components of the CMF?
-
-.. toctree::
-    :maxdepth: 1
+The Symfony CMF believes in a concept where bundles integrate library
+(components) into the framework. The components can be used in any PHP
+project, even when they are not using Symfony.
 
-    components/routing/introduction
-    components/testing
+:doc:`Browse the components <components/index>`
 
 Reference
 ---------
@@ -110,50 +93,21 @@ Ever wondered what configuration options you have available to you in files
 such as ``app/config/config.yml``? In this section, all available
 configuration is broken down per bundle.
 
-.. toctree::
-    :maxdepth: 1
-
-    reference/configuration/block
-    reference/configuration/content
-    reference/configuration/core
-    reference/configuration/create
-    reference/configuration/media
-    reference/configuration/menu
-    reference/configuration/routing
-    reference/configuration/search
-    reference/configuration/simple_cms
-    reference/configuration/tree_browser
+:doc:`Browse the reference <reference/index>`
 
 Cookbook
 --------
 
-Special solutions for specific use cases that go beyond standard usage.
-
-Want to know more about the CMF and how each part can be configured? There's a tutorial for each one.
+The cookbook consist of articles about advanced concepts of the Symfony CMF.
 
-.. toctree::
-    :maxdepth: 1
-
-    cookbook/create_new_project_phpcr_odm
-    cookbook/create_basic_cms_auto_routing
-    cookbook/creating_cms_using_cmf_and_sonata
-    cookbook/database/choosing_storage_layer
-    cookbook/editions/cmf_core
-    cookbook/editions/cmf_sandbox
-    cookbook/handling_multilang_documents
-    cookbook/installing_configuring_doctrine_phpcr_odm
-    cookbook/using_blockbundle_and_contentbundle
+:doc:`Browse the cookbook <cookbook/index>`
 
 Contributing
 ------------
 
-.. toctree::
-    :maxdepth: 1
+Do you want to contribute to the Symfony CMF? Start reading these articles!
 
-    contributing/code
-    contributing/bundles
-    contributing/releases
-    contributing/license
+:doc:`Browse the contributing guide <cookbook/index>`
 
 .. _`decoupled CMS`: http://decoupledcms.org
 .. _`Symfony2`: http://symfony.com