← Back to branch summary

~ubuntu-branches/ubuntu/raring/horizon/raring

« back to all changes in this revision

Viewing changes to docs/source/ref/run_tests.rst

  • Committer: Package Import Robot
  • Author(s): Chuck Short
  • Date: 2012-05-24 14:33:20 UTC
  • mfrom: (1.1.14)
  • Revision ID: package-import@ubuntu.com-20120524143320-i7eswfq6ecxlvh5a
Tags: 2012.2~f1-0ubuntu1
* New usptream release. 
* Prepare for quantal:
  - debian/patches/fix-coverage-binary-name.patch: Refreshed.
* Temporarily pass the testsuite.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/source/ref/run_tests.rst
43
43
This isn't recommended, but can be a timesaver when you only need to run
44
44
the code tests and not the frontend tests during development.
45
45
 
 
46
Using Dashboard and Panel Templates
 
47
===================================
 
48
 
 
49
Horizon has a set of convenient management commands for creating new
 
50
dashboards and panels based on basic templates.
 
51
 
 
52
Dashboards
 
53
----------
 
54
 
 
55
To create a new dashboard, run the following:
 
56
 
 
57
    ./run_tests.sh -m startdash <dash_name>
 
58
 
 
59
This will create a directory with the given dashboard name, a ``dashboard.py``
 
60
module with the basic dashboard code filled in, and various other common
 
61
"boilerplate" code.
 
62
 
 
63
Available options:
 
64
 
 
65
* --target: the directory in which the dashboard files should be created.
 
66
  Default: A new directory within the current directory.
 
67
 
 
68
Panels
 
69
------
 
70
 
 
71
To create a new panel, run the following:
 
72
 
 
73
    ./run_tests -m startpanel <panel_name> --dashboard=<dashboard_path>
 
74
 
 
75
This will create a directory with the given panel name, and ``panel.py``
 
76
module with the basic panel code filled in, and various other common
 
77
"boilerplate" code.
 
78
 
 
79
Available options:
 
80
 
 
81
* -d, --dashboard: The dotted python path to your dashboard app (the module
 
82
  which containers the ``dashboard.py`` file.).
 
83
* --target: the directory in which the panel files should be created.
 
84
  If the value is ``auto`` the panel will be created as a new directory inside
 
85
  the dashboard module's directory structure. Default: A new directory within
 
86
  the current directory.
 
87
 
46
88
Give me metrics!
47
89
================
48
90