minor fix

[myslice.git] / README

diff --git a/README b/README
index f168023..175e65b 100644 (file)
--- a/README
+++ b/README
@@ -13,7 +13,6 @@ See the devel/ subdir for more devel-oriented doc.
 * git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git
 
 * edit myslice/settings.py and
 * git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git
 
 * edit myslice/settings.py and

-** change DEVELOPER_ROOT if you didnt clone into ~/git/myslice-django

 ** change the location of your backend API (not yet supported)
 
 * edit myslice/config.py and enter the details of your manifold backend
 ** change the location of your backend API (not yet supported)
 
 * edit myslice/config.py and enter the details of your manifold backend


@@ -22,7 +21,7 @@ See the devel/ subdir for more devel-oriented doc.
 $ manage.py syncdb
 
 * gather static files
 $ manage.py syncdb
 
 * gather static files

-$ make static
+$ ./manage.py collectstatic (formerly, we used make static, which is deprecated)

 
 * run a local server:
 $ manage.py runserver 0.0.0.0:8000
 
 * run a local server:
 $ manage.py runserver 0.0.0.0:8000


@@ -31,19 +30,10 @@ $ devel/server-loop.sh
 when you just need to hit ^C yourself when your static files need to be refreshed - see below
 
 * use it from your browser 
 when you just need to hit ^C yourself when your static files need to be refreshed - see below
 
 * use it from your browser 

+(See more notes on using the development server below)

 
 

-.......... NOTES on using the development server
-. first off, running manage.py runserver is provided by django as a development convenience but SHOULD NOT be used in production
-. second, when you do use it for developement purposes, please be aware that:
-.. the recommended layout for the various files and pieces (py, html, js and css) qith django is really painful
-   we should use e.g. plugins/simplelist.py, plugins/templates/plugins.html, plugins/static/js/simplelist.js and plugins/static/css/simplelist.css
-.. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces in such a layout but from a completely flat codebase
-   I mean I want to be able to store all the files building a plugin in a single (git) directory 
-   Of course it's a completely different matter once the service is packaged and installed, these files of course get properly separated.
-.. as a result it is a little bit less convenient to use the development server
-   when you change the layout of your static and template files, you might need to re-run 'make static', so it is recommended to use
-   devel/server-loop.sh instead
-
+* install dependencies
+$ pip install -r path/to/requirements/file.txt

 
 ==================== Status
 
 
 ==================== Status
 


@@ -57,6 +47,14 @@ that your manifold backend knows about).
 For logging out: click on 'logged as *jean*', this shows a
 confirmation page for logging out. this is intended to be temporary.
 
 For logging out: click on 'logged as *jean*', this shows a
 confirmation page for logging out. this is intended to be temporary.
 

+*** Packaging ***
+
+I've done a very rough attempt at packaging for rpm.
+The logic seems about right but needs more work, in particular in terms of installing myslice.conf
+in the httpd conf.d directory. 
+It seems like our app won't work on f14 as is because Django is only 1.3.1 on f14
+Plan is to target f18 but I lack a test machine.
+Also of course I'll try to tackle debian/ubunti at some point.

 
 *** Features ***
 
 
 *** Features ***
 


@@ -96,6 +94,7 @@ Third party tools shipped:
 * datatables
 * spin
 * bootstrap
 * datatables
 * spin
 * bootstrap

+* and others are added as we build the system when they become needed

 
 I've tried to keep track of the version I picked and to have an easy upgrade path.
 
 
 I've tried to keep track of the version I picked and to have an easy upgrade path.
 


@@ -107,8 +106,11 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat
   . settings.py
   . urls.py
 
   . settings.py
   . urls.py
 

-* engine:
-  the code for building / rendering plugins / queries
+* manifold:
+  the code for dealing with queries, sending them to the backend, and offering the /manifold/proxy/ URL
+
+* unfold:
+  the code for building / rendering plugins 

 
 * plugins:
   the actual code for plugins
 
 * plugins:
   the actual code for plugins


@@ -119,19 +121,19 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat
   for how to use a separate authentication system, 
   as well as settings.py for how to enable it
 
   for how to use a separate authentication system, 
   as well as settings.py for how to enable it
 

-* insert_above: 
-  a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
-

 * trash/
   rough/preliminary views in here - as the name suggests this is temporary
 
 * views/
   will receive actual views over time 
   currently has some global html templates as well
 * trash/
   rough/preliminary views in here - as the name suggests this is temporary
 
 * views/
   will receive actual views over time 
   currently has some global html templates as well

+  + some global static files (css, js, images..)
+
+* insert_above: 
+  a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header

 
 * third-party/
 
 * third-party/

-   * third party stuff (bootstrapfs, jquery, datatables)
-   * + some global static files (css, js, images..)
+   * third party javascript and css stuff (bootstrapfs, jquery, this kind of things)

      see more about that below too
 
 * devel:
      see more about that below too
 
 * devel:


@@ -148,57 +150,72 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat
 * myslice.sqlite3
   this is where django stores its own stuff, as per settings.py
 
 * myslice.sqlite3
   this is where django stores its own stuff, as per settings.py
 

-==================== conventions for templates
+==================== conventions for templates & static files
+==================== and NOTES on using the development server
+
+. first off, running manage.py runserver is provided by django as a development convenience but
+  SHOULD NOT be used in production
+
+. second, when you do use it for developement purposes, please be aware that:
+
+.. the recommended layout for the various files and pieces (py, html, js and css) with django is
+   IMHO really painful; we *SHOULD* use e.g. 
+      plugins/simplelist.py, 
+      plugins/templates/plugins.html,
+      plugins/static/js/simplelist.js 
+      plugins/static/css/simplelist.css
+   which I have tried doing for a while but I found mmyself just hopping around in the file tree all
+   day long, wasting cycles all along
+
+.. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces (this is in
+   the Makefile). Bottom line is we can essentially store this wherever we want.
+   The only restriction being that if you have a template that is *not* html, then it *has to* sit
+   in a templates/ directory, otherwise it gets shipped as a static file.  
+
+.. as a result, we can now store all the files building a plugin in a single (git) directory; like e.g.
+      plugins/quickfilter/quickfilter.py
+      plugins/quickfilter/quickfilter.html
+      plugins/quickfilter/quickfilter.js
+      plugins/quickfilter/quickfilter.css
+
+   Of course it's a completely different matter once the service is packaged and installed, these
+   files of course get properly separated.
+
+.. as a result it is a little bit less convenient to use the development server when you change the
+   layout of your static and template files, you might need to re-run 'make static', so it is
+   recommended to use devel/server-loop.sh instead
+
+
+All this being said, here are our current conventions for storing templates and static files

 
 * templates:
   we store this under templates/ within the corresponding app, e.g.
 
 * templates:
   we store this under templates/ within the corresponding app, e.g.

-  auth/templates/login.html
+     auth/templates/login.html

   for now this is mostly about html, but the engine can be used for rendering anything 
   for now this is mostly about html, but the engine can be used for rendering anything 

-  including js(on) or whatever..
-
-==================== conventions for static files
+  including js(on) or whatever (in which case, as stated above, this *must* have /templates/ in its path.

 
 * static files:
   we chose to have all static files (images, but also javascript and stylesheets) in the various
 
 * static files:
   we chose to have all static files (images, but also javascript and stylesheets) in the various

-  proj or app where they belong, under a static/ subdir that has this structure:
+  proj or app where they belong, with a layout like:

   where-it-belongs/
   where-it-belongs/

-    static/

       img/
       css/
       js/
       img/
       css/
       js/

+  Honestly it's not yet very clear sometimes what 'where-it-belongs' should be sometimes, and it
+  does not matter too much anyway, given that the code doesn't need to change when we move things
+  around. So in particular it's fuzzy between myslice/ (where the logo could fit e.g.) views/ and
+  even trash/

 
 

-NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another) 
-at any time without any change needed in the code
-
-* filenames / locations
-
-  you can run the following make targets to have a summary of where things are
-
-  $ make list-html list-js list-css list-img
-  -- or --
-  $ make list-all
+Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are 

 
 

-  as far as possible it's great to have things named the same after e.g. say a plugin name
-    like e.g.
-    plugins/quickfilter.py
-    plugins/templates/quickfilter.html
-    plugins/static/js/quickfilter.js
-    plugins/static/css/quickfilter.css
+$ make static templates

 
 

-  it's sometimes not working though, so here are a few additional conventions
+that would reset all-static/ and all-templates/ for you from the other contents

 
 

-    the global layout (for now I needed only one) is named layout-myslice.html
-      it provides the global layout with one menu stuck on top and 2 divs 3/4 1/4
+* third-party
+  please note that the set of files that actually get exposed in all-static from third-party is
+  hand-coded in Makefile because we tried to preserve the original codebase layout from mainstream,
+  and there's only so much in common between 2 differents js libraries at this point.

 
 

-    the views that I currently have are all named in templates/view-<>.html
-      they all extend a layout
-      they should/could admittedly move where they belong (in auth/slice/engine) 
-      so that they would go with their views.py code, but for now it's impler this way

 
 

-    and there are 3 'widgets' (login, logout, and topmenu) 
-      these could maybe be best implemented as a plugin now that I have the right model for that
-      however esp. for the login/logout I'm not quite sure this will remain over time
-      so for now it's good enough like this

 
 

-So in summary there's still room for a lot of improvement on this particular topic..
-At the very least topmenu should be made a plugin, and maybe also login/logout