From: Thierry Parmentelat Date: Sat, 5 Oct 2013 05:03:26 +0000 (+0200) Subject: updated readme X-Git-Tag: myslice-0.2-5~30 X-Git-Url: http://git.onelab.eu/?p=myslice.git;a=commitdiff_plain;h=fd55728601b62284b99e27f7d06723206649b5a7 updated readme --- diff --git a/README b/README index 79ca81c9..d05ded49 100644 --- a/README +++ b/README @@ -153,68 +153,45 @@ package is published) . second, when you do use it for developement purposes, please be aware that: -NOTE. this whole business is being changed -basically we come back to the way django has it by default... - -==changing== .. the recommended layout for the various files and pieces (py, html, js and css) with django is -==changing== IMHO really painful; we *SHOULD* use e.g. -==changing== plugins/quickfilter/quickfilter.py, -==changing== plugins/quickfilter/templates/quickfilter.html, -==changing== plugins/quickfilter/static/js/quickfilter.js -==changing== plugins/quickfilter/static/css/quickfilter.css -==changing== which I have tried doing for a while but I found myself just hopping around in the file tree all -==changing== day long, wasting cycles big time -==changing== -==changing== .. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces (this is in -==changing== the Makefile). Bottom line is we can essentially store this wherever we want. -==changing== The only restriction being that if you have a template that is *not* html, then it *has to* sit -==changing== in a templates/ directory, otherwise it gets shipped as a static file. -==changing== -==changing== .. as a result, we can now store all the files building a plugin in a single (git) directory; like e.g. -==changing== plugins/quickfilter/quickfilter.py -==changing== plugins/quickfilter/quickfilter.html -==changing== plugins/quickfilter/quickfilter.js -==changing== plugins/quickfilter/quickfilter.css -==changing== -==changing== Of course it's a completely different matter once the service is packaged and installed, these -==changing== files of course get properly separated. -==changing== -==changing== .. as a result it is a little bit less convenient to use the development server when you change the -==changing== layout of your static and template files, you might need to re-run 'make static', so it is -==changing== recommended to use devel/server-loop.sh instead -==changing== -==changing== -==changing== All this being said, here are our current conventions for storing templates and static files -==changing== -==changing== * templates: -==changing== we store this under templates/ within the corresponding app, e.g. -==changing== auth/templates/login.html -==changing== for now this is mostly about html, but the engine can be used for rendering anything -==changing== including js(on) or whatever (in which case, as stated above, this *must* have /templates/ in its path. -==changing== -==changing== * static files: -==changing== we chose to have all static files (images, but also javascript and stylesheets) in the various -==changing== proj or app where they belong, with a layout like: -==changing== where-it-belongs/ -==changing== img/ -==changing== css/ -==changing== js/ -==changing== Honestly it's not yet very clear sometimes what 'where-it-belongs' should be sometimes, and it -==changing== does not matter too much anyway, given that the code doesn't need to change when we move things -==changing== around. So in particular it's fuzzy between myslice/ (where the logo could fit e.g.) views/ and -==changing== even trash/ -==changing== -==changing== Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are -==changing== -==changing== $ make static templates -==changing== -==changing== that would reset static/ and templates/ for you from the other contents -==changing== -==changing== * third-party -==changing== please note that the set of files that actually get exposed in all-static from third-party is -==changing== hand-coded in Makefile because we tried to preserve the original codebase layout from mainstream, -==changing== and there's only so much in common between 2 differents js libraries at this point. -==changing== +.. the recommended layout for the various files and pieces (py, html, js and css) with django is e.g. + plugins/quickfilter/___init__.py, + plugins/quickfilter/templates/quickfilter.html, + plugins/quickfilter/static/js/quickfilter.js + plugins/quickfilter/static/css/quickfilter.css + plugins/quickfilter/static/img/some-image.png + +.. the files actually used by the development server are the ones located in + static/ + templates/ + +you can and should use the following make targets to refresh the +contents of these directories when running a developement server +$ make static to refresh static/ +$ make redo-static to clean up static/ and then refresh its contents +$ make templates to refresh templates/ +$ make redo-templates to clean up templates/ and then refresh its contents +$ make redo equivalent to make redo-static redo-templates + +.. as far as possible, please make sure to use third-party to store +any javascript tool or utility that your plugin depends upon + +also we have the convention that all material in third-party should be +tagged with a version number, with a symlink pointing to the version +being used, like this + +~/git/myslice/third-party $ ls -ld spin* +lrwxr-xr-x 1 parmentelat staff 10 Sep 6 17:55 spin -> spin-1.3.0 +drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.2.8 +drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.3.0 + +finally, as far as possible we keep track of the urls used to pull +stuff in the first place so that upgrades are easier + +. third, be careful when importing third party material, to stay away from demo-oriented material + +e.g. at some point we were using demo_page.css and demo_table.css from the datatables demo and sample pages +unfortunately these are not tailored for production use as they are setting styles on a very wide scope +that breaks a lot of stuff, so please refrain from using these altogether ======== update django database to reflect changes in existing models without any migration system (e.g., south) =========