f3848085e1
This patch changes the format of Stackviz docs so that all information is stored in the appropriate doc/source/ directory rather than all in README.rst. README.rst now just uses the RST include directive to get its text from doc/source/readme.rst. Usage and installation are now in their own RST files for increased modularity, and are included in doc/source/readme.rst. Additional developer documentation has also been created at doc/source/man/ and includes more information on stackviz-export as well as the AngularJS front-end. Change-Id: I1d37194add998cf83a66d380ec7390e31184bdb3
1.6 KiB
Usage
Usage - Development
A development server can be run as follows:
gulp devThis will open a web browser and reload code automatically as it changes on the filesystem.
If you have subunit and dstat logs, you can create a config.json to display your runs:
stackviz-export -f <path/to/subunit> --dstat <path/to/dstat> app/data/During gulp dev, files written to app/data/
will be automatically synchronized with the browser. Note that these
files will not be copied to build/ during
gulp prod, but you can copy them manually using
gulp data.
Usage - Production
The production application can be build using:
gulp prodThe result will be written to ./build and should be
appropriate for distribution. Note that all files are not required:
- Directory structure (
js/,css/,fonts/,images/): required. - Static resources (
fonts/,images/): required. - Core files (
index.html,js/main.js,css/main.css): required unless gzipped versions are used. - Gzipped versions of core files (
*.gz): not required, but preferred. Use instead of plain core files to save on disk usage and bandwidth. - Source maps (
js/main.js.map,js/main.js.map.gz): only required for debugging purposes.
Data should be written to build/data/ using
stackviz-export like above. Note that the static production
code generated above is portable, and can be generated anywhere and
copied to another host to be combined with exported data.