From 1146cdb32a5eb31f34b35ff1540c1e77738900af Mon Sep 17 00:00:00 2001 From: Sullivan SENECHAL Date: Sat, 18 Jun 2016 10:52:11 +0200 Subject: [PATCH] Revert "Assets management documentation" (#59) --- Makefile | 6 +----- Resources/doc/index.rst | 1 - Resources/doc/reference/assets.rst | 23 ----------------------- Resources/doc/reference/introduction.rst | 22 ---------------------- 4 files changed, 1 insertion(+), 51 deletions(-) delete mode 100644 Resources/doc/reference/assets.rst diff --git a/Makefile b/Makefile index 146f561..e27d3cd 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ # # It's auto-generated by sonata-project/dev-kit package. -.PHONY: test docs assets +.PHONY: test docs all: @echo "Please choose a task." @@ -20,7 +20,3 @@ test: docs: cd Resources/doc && sphinx-build -W -b html -d _build/doctrees . _build/html - -assets: - cd Resources/assets_src && npm install - cd Resources/assets_src && gulp diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst index 557f8fb..9841c4b 100644 --- a/Resources/doc/index.rst +++ b/Resources/doc/index.rst @@ -10,4 +10,3 @@ Reference Guide reference/introduction reference/installation - reference/assets diff --git a/Resources/doc/reference/assets.rst b/Resources/doc/reference/assets.rst deleted file mode 100644 index d061db4..0000000 --- a/Resources/doc/reference/assets.rst +++ /dev/null @@ -1,23 +0,0 @@ -Assets -====== - -Assets are managed with gulp which requires nodejs/npm and a global gulp install. - -* stylesheets are generated from .scss files located in ``/Resources/assets_src/src/scss`` -* javascripts are generated from files located in ``/Resources/assets_src/src/js`` - -.. warning:: - - Do not edit directly files located in the ``/Resources/public`` folder, - if you want to contribute, you should edit files in the ``/Resources/assets_src/src`` folder. - - -Compiling Sources ------------------ - -If you made some modifications in the sources, -you can generate the public ones with the following command: - -.. code-block:: bash - - make assets \ No newline at end of file diff --git a/Resources/doc/reference/introduction.rst b/Resources/doc/reference/introduction.rst index a6b30b8..e7a9e61 100644 --- a/Resources/doc/reference/introduction.rst +++ b/Resources/doc/reference/introduction.rst @@ -7,28 +7,6 @@ This small introduction will try to explain the basics concepts behind the A Dashboard ----------- -A ``Dashboard`` is a collection of blocks, actually of block containers, containing the -blocks required to manage its content. A Block ------- - -The ``SonataDashboardBundle`` does not know how to manage content, actually there is -no content management. This part is delegated to services. The bundle only -manages references to the service required by a dashboard. Reference information is -stored in a ``Block``. - -A block is a small unit, it contains the following information: - - - service id - - position - - settings used by the service - -Each block service must implement the ``Sonata\PageBundle\Block\BlockServiceInterface`` -which defines a set of functions to create so the service can be integrated -nicely with editing workflow. The important information is that a block service -must always return a ``Response`` object. - -By default the ``SonataDashboardBundle`` is shipped with a core block service: - - - sonata.dashboard.block.container : Block container