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
46 lines
1.6 KiB
ReStructuredText
46 lines
1.6 KiB
ReStructuredText
Usage
|
|
========
|
|
|
|
Usage - Development
|
|
-------------------
|
|
A development server can be run as follows::
|
|
|
|
gulp dev
|
|
|
|
This 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 :code:`gulp dev`, files written to :code:`app/data/` will be
|
|
automatically synchronized with the browser. Note that these files will *not* be
|
|
copied to :code:`build/` during :code:`gulp prod`, but you can copy them
|
|
manually using :code:`gulp data`.
|
|
|
|
Usage - Production
|
|
------------------
|
|
The production application can be build using::
|
|
|
|
gulp prod
|
|
|
|
The result will be written to :code:`./build` and should be appropriate for
|
|
distribution. Note that all files are not required:
|
|
|
|
- Directory structure (:code:`js/`, :code:`css/`, :code:`fonts/`,
|
|
:code:`images/`): required.
|
|
- Static resources (:code:`fonts/`, :code:`images/`): required.
|
|
- Core files (:code:`index.html`, :code:`js/main.js`, :code:`css/main.css`):
|
|
required unless gzipped versions are used.
|
|
- Gzipped versions of core files (:code:`*.gz`): not required, but preferred.
|
|
Use instead of plain core files to save on disk usage and bandwidth.
|
|
- Source maps (:code:`js/main.js.map`, :code:`js/main.js.map.gz`): only required
|
|
for debugging purposes.
|
|
|
|
Data should be written to :code:`build/data/` using :code:`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.
|