[documentation] add static

rande · rande · commit f6d93ad693af · 2014-02-27T18:56:24.000-05:00
diff --git a/docs/plugins/static.rst b/docs/plugins/static.rst
@@ -1,40 +1,28 @@
-.. note::
-
-    This documentation is under construction, more to come soon
-
-
-
 Static
 ======
 
-Serve static file from the datasource
-
 Features
-~~~~~~~~
+--------
 
-  - Insert here the different feature available for this plugin
+  - Add a handler to render static file
 
 Configuration
-~~~~~~~~~~~~~
+-------------
 
-  - Insert the yaml configuration for the DI
+There is no configuration option. You only need to enable the plugin by adding this line into the IoC configuration file.
 
 .. code-block:: yaml
 
-    element.plugins.cache:
-        cache_control:
-            - { "path": "^.*\\.(txt|jpg|png|gif|xls|doc|docx)$",    "Cache-Control": ['public', 's-maxage=14212800']}
-            - { "path": "^(blog|gallery).*",    "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^.*\\.rss",            "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^contact.*",           "Cache-Control": ['private', 'must-revalidate']}
-            - { "path": "^/$",                  "Cache-Control": ['public', 's-maxage=3600']}
+    element.plugins.static:
+
+Usage
+-----
 
-Events
-~~~~~~
+Just place a store a file in the datasource and access it with a browser. That's it.
 
- - List event or entry points for this plugin
+If the url contains the ``?mode=preview=
 
 Architecture
-~~~~~~~~~~~~
+------------
 
- - Provide information about how the feature is implemented
+The plugin provides a ``StaticNodeLoader`` to create a node object from a path, the created node type is ``element.static``.
