openstack/stackviz
Code Issues Proposed changes

Update README.rst to include upstream planning etherpad

Browse Source 
Small updates to the README, including adding instructions on how to
generate a `config.json` using stackviz-export and local subunit+dstat
files. Also includes a link to the upstream planning etherpad, which
will be used for ideas about getting StackViz working with data from
devstack-gate runs.

Change-Id: I206cb5ea6331eaf005b8c9c43a1e7b93e2d77a92
This commit is contained in:
Austin Clark 2015-11-05 09:43:50 -07:00
parent d84e984fb7
commit 5d9c24d574
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.rst
View File

@ -24,6 +24,12 @@ A development server can be run as follows::
This will open a web browser and reload code automatically as it changes on the This will open a web browser and reload code automatically as it changes on the
filesystem. 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/
Usage - Production Usage - Production
================== ==================
The production application can be build using:: The production application can be build using::
@ -56,7 +62,7 @@ Roadmap
- Will remain in this namespace (:code:`openstack-qa/stackviz`). - Will remain in this namespace (:code:`openstack-qa/stackviz`).
- Will decouple data processing from build process, allowing for - Will decouple data processing from build process, allowing for
distribution to nodes as a prebuilt static site. distribution to nodes as a prebuilt static site.
- Data sources will be configured in in a :code:`config.json`. - Data sources will be configured in a :code:`config.json`.
- Will support local and remote sources via REST/JSONP (pending API spec). - Will support local and remote sources via REST/JSONP (pending API spec).
- Angular conversion: current codebase will be rewritten to use Angular. - Upstream Implementation: https://etherpad.openstack.org/p/BKgWlKIjgQ