engineering/unrhodecode
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: mention working with frontend using grunt and polymer

Browse source
This commit is contained in:
Marcin Lulek 2016-08-26 12:25:01 +02:00
parent 4c8bca758c
commit da05a4bb68
2 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/contributing/dev-setup.rst
View file

@ -111,15 +111,18 @@ time operation::
Compile CSS and JavaScript
^^^^^^^^^^^^^^^^^^^^^^^^^^
To use the application's frontend, you will need to compile the CSS and
JavaScript with Grunt. This is easily done from within the nix-shell using the
following command::
To use the application's frontend and prepare it for production deployment,
you will need to compile the CSS and JavaScript with Grunt.
This is easily done from within the nix-shell using the following command::
make web-build
grunt
You will need to recompile following any changes made to the CSS or JavaScript
files.
When developing new features you will need to recompile following any
changes made to the CSS or JavaScript files when developing the code::
grunt watch
This prepares the development (with comments/whitespace) versions of files.
Start the Development Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

5
docs/contributing/standards.rst
View file

@ -45,6 +45,11 @@ JavaScript
----------
This currently remains undefined. Suggestions welcome!
However, we have decided to go forward with W3C standards and picked
WebComponents as the foundation of user interface. New functionality should
be implemented as components using the
`Polymer Project` <https://www.polymer-project.org>`_ library
and should avoid external dependencies like `jquery`.
HTML
----