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

Text tweaks

Browse source 
- Legacy-Id: 9898
This commit is contained in:
Henrik Levkowetz 2015-07-27 18:31:42 +00:00
parent a36e40288d
commit 3837b18ab5
1 changed files with 22 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
ietf/static/README.rst
View file

@ -1,22 +1,32 @@
Handling of External Javascript and CSS Components
==================================================
This directory (``ietf/static/``) exists for the sole purpose of providing a visible
location for ``ietf/static/bower.json``, a bower_ file which lists the external
web assets used by the datatracker.
This directory (``ietf/static/``) exists for the sole purpose of providing a
visible location for ``ietf/static/bower.json``, a bower_ file which lists the
external web assets used by the datatracker.
In order to update the version of a component listed in ``ietf/static/bower.json``,
or add a new one, you should edit ``bower.json``, and then run the management command::
In order to update the version of a component listed in
``ietf/static/bower.json``, or add a new one, you should edit ``bower.json``,
and then run the management command::
$ ietf/manage.py bower_install
That command will fetch the required version of each external component listed in ``bower.json``
(actually, it will do this for *all* ``bower.json`` files found in the ``static/`` directories
of all ``INSTALLED_APPS`` and the directories in ``settings.STATICFILES_DIRS``), saving them
temporarily under ``.tmp/bower_components/``; it will then extract the relevant ``js`` and
``css`` files and place them in an appropriately named directory under ``static/lib/``. The
latter location is controlled by ``COMPONENT_ROOT`` in ``settings.py``.
That command will fetch the required version of each external component listed
in ``bower.json`` (actually, it will do this for *all* ``bower.json`` files
found in the ``static/`` directories of all ``INSTALLED_APPS`` and the
directories in ``settings.STATICFILES_DIRS``), saving them temporarily under
``.tmp/bower_components/``; it will then extract the relevant ``js`` and
``css`` files and place them in an appropriately named directory under
``static/lib/``. The latter location is controlled by ``COMPONENT_ROOT`` in
``settings.py``.
(Not surprisingly, you need to have bower_ installed in order to use this
management command.)
The ``bower_install`` command is not run automatically by ``bin/mkrelease``,
since it needs an updated ``bower.json`` in order to do anything interesting;
and we're not running ``bower update`` since some package releases break
compatibility. So when you're intending to
(Not surprisingly, you need to have bower_ installed in order to use this management command.)
.. _bower: http://bower.io/