[conga-luci-1stgen] RHEL5-active: luci/MAINTAINERS.rst: add "Briefly on the design" section (6f98746)

[Jan Pokorný]

Repository : http://git.fedorahosted.org/git/?p=conga-luci-1stgen.git

On branch  : RHEL5-active

> ---------------------------------------------------------------
commit 6f9874602585b1df1ad55ac46933f9d2c6f323b0
Author: Jan Pokorný <jpokorny(a)redhat.com&gt;
Date:   Wed Apr 23 22:18:52 2014 +0200

    luci/MAINTAINERS.rst: add "Briefly on the design" section
    
    Signed-off-by: Jan Pokorný <jpokorny(a)redhat.com&gt;


> ---------------------------------------------------------------
 luci/MAINTAINERS.rst |   30 ++++++++++++++++++++++++++++++
 1 files changed, 30 insertions(+), 0 deletions(-)

diff --git a/luci/MAINTAINERS.rst b/luci/MAINTAINERS.rst
index dcd7bd6..4e6b4f4 100644
--- a/luci/MAINTAINERS.rst
+++ b/luci/MAINTAINERS.rst
@@ -173,3 +173,33 @@ a standalone archive, otherwise[<--NEW] added in a form of
patches
 -- these are also the only patches expected to be found in the repo tree.
 
 Zope/Plone itself is not directly included but rather downloaded on demand.
+
+
+Briefly on the design
+=====================
+
+Common template flow structure
+------------------------------
+
+1.    {X = cluster,homebase,storage}/index_html defers to
+2a.     site/luci/Extensions/<X>_adapters.py:<X>Control that, in turn,
+        points to
+3a.       <X>ControlPost (when processint POST requests) and <X>Portal;
+          the latter propagates back to and is returned from
+2a.     site/luci/Extensions/<X>_adapters.py:<X>Control and
+1.    (in an abusive manner) injected to "css_slot" in <X>/index_html
+      to penultimately inject some Python data to the processing stream
+      so as to feed
+3b.       <X>/portlet_<X> that feeds
+2b.     <X>/<X>_portlet_fetcher that, finally, feeds
+1.  <X>/index_html (left_column, ...)
+    (the circle of near insanity is closed, thank you)
+
+Validation
+----------
+
+Two levels:
+1. pre-post:   Javascript: <X>/validate_XXX_YYY.js
+2. after-post: Python:     site/luci/Extensions/<X>_adapters.py:validateXXXYYY
+   - effectively (and unfortunately), these (often) alias with handlers
+     of the user-initiated event