add an outdated warning to the cookbook entries as a quick solution for

#283
symfony-cmf · Oct 5, 2013 · 7913ffe · 7913ffe
1 parent 7ba6c1b
commit 7913ffe
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 2 deletions.
diff --git a/cookbook/_outdate-caution.rst.inc b/cookbook/_outdate-caution.rst.inc
@@ -0,0 +1,11 @@
+.. caution::
+
+    The cookbook is in the process of being restructured. Some documentation is
+    outdated, notable configuration examples. If something does not work, please
+    have a look in the Reference section and send pull requests to fix things,
+    or just open an issue on github so that we know about the problem.
+
+    Refer to `the documentation issues`_ to help us bringing this article up to
+    date.
+
+.. _`the documentation issues`: https://github.com/symfony-cmf/symfony-cmf-docs/issues/
diff --git a/cookbook/creating_cms_using_cmf_and_sonata.rst b/cookbook/creating_cms_using_cmf_and_sonata.rst
@@ -4,6 +4,8 @@
 Creating a CMS using CMF and Sonata
 ===================================
 
+.. include:: _outdate-caution.rst.inc
+
 The goal of this tutorial is to create a simple content management system
 using the CMF as well as `SonataAdminBundle`_ and
 :doc:`../bundles/doctrine_phpcr_admin`.
@@ -19,9 +21,9 @@ Preconditions
 .. caution::
 
     Don't forget to add a configuration for the SecurityBundle or you will get an
-    
+
     ``The function "is_granted" does not exist in SonataAdminBundle``
-    
+
     error.
 
 Installation

diff --git a/cookbook/database/choosing_storage_layer.rst b/cookbook/database/choosing_storage_layer.rst
@@ -4,6 +4,8 @@
 Choosing a Storage Layer
 ========================
 
+.. include:: ../_outdate-caution.rst.inc
+
 When building a CMS, the choice of storage layer is one of the key decisions
 to take. Many factors must be considered, the good news is that with all the
 components and Bundles in the CMF, it takes extra care to provide the

diff --git a/cookbook/editions/cmf_core.rst b/cookbook/editions/cmf_core.rst
@@ -4,6 +4,8 @@
 Installing and Configuring the CMF Core
 =======================================
 
+.. include:: ../_outdate-caution.rst.inc
+
 The goal of this tutorial is to install the minimal CMF components ("core")
 with the minimum necessary configuration. From there, you can begin
 incorporating CMF functionality into your application as needed.

diff --git a/cookbook/editions/cmf_sandbox.rst b/cookbook/editions/cmf_sandbox.rst
@@ -4,6 +4,8 @@
 Installing the CMF sandbox
 ==========================
 
+.. include:: ../_outdate-caution.rst.inc
+
 This tutorial shows how to install the Symfony CMF Sandbox, a demo platform
 aimed at showing the tool's basic features running on a demo environment.
 This can be used to evaluate the platform or to see actual code in action,

diff --git a/cookbook/handling_multilang_documents.rst b/cookbook/handling_multilang_documents.rst
@@ -4,6 +4,8 @@
 Handling Multi-Language Documents
 =================================
 
+.. include:: _outdate-caution.rst.inc
+
 The goal of the tutorial is to describe all the steps that are needed to be
 taken to use multi-language documents as clearly as possible.
 

diff --git a/cookbook/installing_configuring_doctrine_phpcr_odm.rst b/cookbook/installing_configuring_doctrine_phpcr_odm.rst
@@ -4,6 +4,8 @@
 Installing and Configuring Doctrine PHPCR-ODM
 =============================================
 
+.. include:: _outdate-caution.rst.inc
+
 The Symfony2 CMF needs somewhere to store the content. Many of the bundles
 provide documents and mappings for the PHP Content Repository - Object
 Document Mapper (PHPCR-ODM), and the documentation is currently based around

diff --git a/cookbook/installing_configuring_inline_editing.rst b/cookbook/installing_configuring_inline_editing.rst
@@ -4,6 +4,8 @@
 Installing and Configuring Inline Editing
 =========================================
 
+.. include:: _outdate-caution.rst.inc
+
 The goal of this tutorial is to install and configure the inline editing
 support.
 

diff --git a/cookbook/using_blockbundle_and_contentbundle.rst b/cookbook/using_blockbundle_and_contentbundle.rst
@@ -6,6 +6,8 @@
 Using the BlockBundle and ContentBundle with PHPCR
 ==================================================
 
+.. include:: _outdate-caution.rst.inc
+
 The goal of this tutorial is to demonstrate how the CMF
 :doc:`BlockBundle <../bundles/block/index>` and
 :doc:`ContentBundle <../bundles/content/index>` can be used as stand-alone