altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 4 Packages Projects Releases Wiki Activity

Merged in [9736] from lars@netapp.com:

Browse source 
Update the README now that the facelift has happened, and remove the outdated
TODO.
 - Legacy-Id: 9770
Note: SVN reference [9736] has been migrated to Git commit fbf30230d1f00839a28e5a28d6c6d04952103c1b
This commit is contained in:
Henrik Levkowetz 2015-07-18 09:30:54 +00:00
parent c41a079d4f
commit a14829ac88
3 changed files with 35 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README
View file

@ -1,25 +0,0 @@
This is the "facelift" datatracker branch that uses Twitter Bootstrap for
the UI.
You need to install a few new django extensions:
https://pypi.python.org/pypi/django-widget-tweaks
https://pypi.python.org/pypi/django-bootstrap3
https://pypi.python.org/pypi/django-typogrify
The meta goal of this effort is: *** NO CHANGES TO THE PYTHON CODE ***
Whenever changes to the python code are made, they can only fix HTML bugs,
or add comments (tagged with "FACELIFT") about functionality that can be
removed once the facelift templates become default. Or they need to add
functionality that is only called from the new facelift templates.
Javascript that is only used on one template goes into that template.
Javascript that is used by more than one template goes into ietf.js.
CSS that is only used on one template goes into that template.
CSS that is used by more than one template goes into ietf.css. No CSS in the
templates or - god forbid - style tags! (And no CSS or HTML styling in
python code!!)
Templates that use jquery or bootstrap plugins include the css in the pagehead
block, and the js in the js block.

35
README.datatracker Normal file
View file

@ -0,0 +1,35 @@
The "new" datatracker uses Twitter Bootstrap for the UI.
Get familiar with http://getbootstrap.com/getting-started/ and use those
UI elements instead of cooking up your own.
We have some site-wide customization applied to the bootstrap version we keep
in bootstrap/ (from which the minified dist version is built); it modifies
some stuff under less/
We also apply some additional custiomizations in static/css/ietf.css; we
should eventually move that under bootstrap/less/ if possible. (ietf.css was
what Lars used initially for customization with an unmodified bootstrap.)
Some ground rules:
* Think hard before tweaking the bootstrap CSS, it will make it harder to
upgrade to future releases.
* No <style> tags in the HTML! Put CSS into the "morecss" block of a
template instead.
* CSS that is used by multiple templates goes into static/css/ietf.css.
* Javascript that is only used on one template goes into the "js" block of
that template.
* Javascript that is used by multiple templates goes into static/js/ietf.js.
* Every template includes jquery, so write jquery code and not plain Javascript.
It's shorter and often faster.
* No CSS, HTML styling or Javascript in the python code!
* Templates that use jquery or bootstrap plugins include the css file in the
"pagehead" block, and the Javascript in the "js" block.

11
TODO
View file

@ -1,11 +0,0 @@
Major pieces not facelifted: milestone editing, liaison editing, WG workflow customization
Use affix for navigation on active_wgs.html
Figure out why {% if debug %} does not work in the text templates under ietf/templates_facelift/community/public.
Make django generate HTML5 date inputs or use a js-based datepicker.
Deferring ballots does not work. (Seems to be an upstream bug.)
Make tables that are too wide to usefully work on small screens responsive. See http://getbootstrap.com/css/#tables-responsive