Merge pull request #1553 from caponica/new-docs

New docs for actions

Resources/doc/reference/action_create_edit.rst

@@ -0,0 +1,43 @@
+Creating and Editing objects
+============================
+
+.. note::
+
+    This document is a stub representing a new work in progress. If you're reading 
+    this you can help contribute, **no matter what your experience level with Sonata 
+    is**. Check out the `issues on Github`_ for more information about how to get involved.
+
+This document will cover the Create and Edit actions. It will cover configuration 
+of the fields and forms available in these views and any other relevant settings.
+
+
+Basic configuration
+-------------------
+
+To do:
+
+- global (yml) options that affect the create and edit actions
+- a note about Routes and how disabling them disables the related action
+- using configureFormFields() to set which fields to display
+- options available when adding fields, inc custom templates
+- link to the field_types document for more details about specific field types
+
+
+Embedding other Admins
+----------------------
+
+To do:
+
+- how to embed one Admin in another (1:1, 1:M, M:M)
+- how to access the right object(s) from the embedded Admin's code
+
+
+Customizing just one of the actions
+-----------------------------------
+
+To do:
+
+- how to create settings/fields that appear on just one of the create/edit views
+  and any controller changes needed to manage them
+
+.. _`issues on Github`: https://github.com/sonata-project/SonataAdminBundle/issues/1519

Resources/doc/reference/action_delete.rst

@@ -0,0 +1,23 @@
+Deleting objects
+================
+
+.. note::
+
+    This document is a stub representing a new work in progress. If you're reading 
+    this you can help contribute, **no matter what your experience level with Sonata 
+    is**. Check out the `issues on Github`_ for more information about how to get involved.
+
+This document will cover the Delete action and any related configuration options.
+
+
+Basic configuration
+-------------------
+
+To do:
+
+- global (yml) options that affect the delete action
+- a note about Routes and how disabling them disables the related action
+- any Admin configuration options that affect delete
+- a note about lifecycle events triggered by delete?
+
+.. _`issues on Github`: https://github.com/sonata-project/SonataAdminBundle/issues/1519

Resources/doc/reference/action_list.rst

@@ -0,0 +1,53 @@
+The List View
+=============
+
+.. note::
+
+    This document is a stub representing a new work in progress. If you're reading 
+    this you can help contribute, **no matter what your experience level with Sonata 
+    is**. Check out the `issues on Github`_ for more information about how to get involved.
+
+This document will cover the List view which you use to browse the objects in your
+system. It will cover configuration of the list itself and the filters you can use
+to control what's visible.
+
+Basic configuration
+-------------------
+
+To do:
+
+- global (yml) options that affect the list view
+- a note about Routes and how disabling them disables the related action
+- using configureListFields() to set which fields to display
+- setting the identifier, and the available options
+- options available when adding general fields, inc custom templates
+- adding custom columns
+
+
+Customising the query used to generate the list
+-----------------------------------------------
+
+To do:
+
+- how to customize/optimize the list query
+
+
+Customising the sort order
+--------------------------
+
+To do:
+
+- how to set the default sort order
+- how to sort by multiple fields (this might be a separate recipe?)
+
+
+Filters
+-------
+
+To do:
+
+- basic filter configuration and options
+- how to set default filter values
+- advanced filter options
+
+.. _`issues on Github`: https://github.com/sonata-project/SonataAdminBundle/issues/1519

Resources/doc/reference/action_show.rst

@@ -0,0 +1,33 @@
+The Show action
+===============
+
+.. note::
+
+    This document is a stub representing a new work in progress. If you're reading 
+    this you can help contribute, **no matter what your experience level with Sonata 
+    is**. Check out the `issues on Github`_ for more information about how to get involved.
+
+This document will cover the Show action and related configuration options.
+
+
+Basic configuration
+-------------------
+
+To do:
+
+- global (yml) options that affect the show action
+- a note about Routes and how disabling them disables the related action
+- configuring the Show action from within your Admin class
+- a note about lifecycle events triggered by delete?
+- options available when adding general fields, inc custom templates
+- (Note, if this is very similar to the list documentation it can be combined)
+
+
+Customising the query used to show the object
+---------------------------------------------
+
+To do:
+
+- how to customize/optimize the show query
+
+.. _`issues on Github`: https://github.com/sonata-project/SonataAdminBundle/issues/1519