X-Git-Url: http://git.onelab.eu/?p=myslice.git;a=blobdiff_plain;f=README;h=d05ded49c3ba8e1dcc5dfcb4ae62249668edff5a;hp=1b17b87c48f604916a9a2bb98653962dea16b7de;hb=7ac6b8ac4422eeff85370e103c72c9413343e879;hpb=b30b56e41ba053b7521e0d6a1fc459330b96964b diff --git a/README b/README index 1b17b87c..d05ded49 100644 --- a/README +++ b/README @@ -17,13 +17,20 @@ See the devel/ subdir for more devel-oriented doc. * edit myslice/config.py and enter the details of your manifold backend * init django -$ manage.py syncdb +$ ./manage.py syncdb +$ ./manage.py migrate * gather static files -$ ./manage.py collectstatic (formerly, we used make static, which is deprecated) +$ ./manage.py collectstatic -- or -- $ ./manage.py collectstatic --noinput -$ make +-- or -- +$ make static (which is a shorthand for cleaning up and run manage collectstatic --noinput) + +* gather templates files + for now we still seem to rely on a make-based templates-collection process + that creates templates/ +$ make templates [$ make redo (each time when you pull, do that and restart the server)] * run a local server: $ manage.py runserver 0.0.0.0:8000 @@ -105,6 +112,11 @@ package is published) for how to use a separate authentication system, as well as settings.py for how to enable it +* ui/ + provides building blocks for the UI, especially layouts (1 or 2 columns) as + well as the topmenu widget + + some global static files (css, js, images..) + * portal/ this is where the first implementation of myslice, with complete user-management including registration, is taking place @@ -113,11 +125,6 @@ package is published) rough/preliminary scaffolding views are 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 @@ -130,13 +137,10 @@ package is published) ========== automatically generated -* all-static: (generated, no need to source-control) - this is where 'make static' will gather all your static contents if you run a local server - make has convenience targets to refresh this area - $ make static - $ make clean-static +* static/: (generated by collectstatic, see above, do not source-control) + $ manage.py [ --noinput ] collectstatic -* django-static +* templates/ * myslice.sqlite3 this is where django stores its own stuff, as per settings.py @@ -149,65 +153,45 @@ package is published) . 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 myself just hopping around in the file tree all - day long, wasting cycles big time - -.. 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. - auth/templates/login.html - for now this is mostly about html, but the engine can be used for rendering anything - 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 - proj or app where they belong, with a layout like: - where-it-belongs/ - 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/ - -Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are - -$ make static templates - -that would reset all-static/ and all-templates/ for you from the other contents - -* 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 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) =========