Fix indentations in docs
This commit fixes some indentations in stackviz docs. These indentations are weird. There's no specific reason to keep it. Change-Id: Ib9805b5c7d3ba5a4b44045424fed4493322dcd67
This commit is contained in:
Masayuki Igawa
parent
6fb81ff38a
commit
7eccb67849
@ -3,17 +3,17 @@ Contributing
|
||||
If you would like to contribute to the development of OpenStack, you must
|
||||
follow the steps in this page:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html
|
||||
* http://docs.openstack.org/infra/manual/developers.html
|
||||
|
||||
If you already have a good understanding of how the system works and your
|
||||
OpenStack accounts are set up, you can skip to the development workflow
|
||||
section of this documentation to learn how changes to OpenStack should be
|
||||
submitted for review via the Gerrit tool:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
* http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
|
||||
Bugs should be filed on Launchpad, not GitHub:
|
||||
|
||||
https://bugs.launchpad.net/stackviz
|
||||
* https://bugs.launchpad.net/stackviz
|
||||
|
||||
@ -16,13 +16,14 @@ with local run data. Stackviz is currently in the process of being implemented
|
||||
upstream (see Roadmap and Planning). To use Stackviz with upstream gate runs,
|
||||
please see the server deployment project at:
|
||||
|
||||
https://github.com/timothyb89/stackviz-deployer
|
||||
* https://github.com/timothyb89/stackviz-deployer
|
||||
|
||||
Installation
|
||||
============
|
||||
Installation - Frontend
|
||||
-----------------------
|
||||
Installation of the frontend requires Node.js and Gulp. On Ubuntu::
|
||||
|
||||
sudo apt-get install nodejs npm nodejs-legacy
|
||||
sudo npm install -g gulp
|
||||
|
||||
@ -95,7 +96,7 @@ Data should be written to :code:`stackviz-html/data/` using
|
||||
|
||||
Testing
|
||||
=======
|
||||
* Python tests: :code:`tox -epy27`
|
||||
* Python tests: :code:`tox -e py27`
|
||||
* JavaScript unit tests: :code:`gulp unit`
|
||||
* JavaScript E2E tests: :code:`gulp e2e`
|
||||
|
||||
|
||||
@ -19,31 +19,31 @@ Usage
|
||||
Where DEST is the output directory of the module. If DEST does not exist, a new
|
||||
directory will be created. One of the following input options must be chosen:
|
||||
|
||||
**-f, --stream-file FILE**
|
||||
Specifies a subunit stream file to be used with the exporter. This
|
||||
argument can be used multiple times to specify additional subunit files.
|
||||
**-f, --stream-file FILE**
|
||||
Specifies a subunit stream file to be used with the exporter. This
|
||||
argument can be used multiple times to specify additional subunit files.
|
||||
|
||||
**-i, --stdin**
|
||||
Instructs stackviz-export to read a subunit stream from stdin.
|
||||
**-i, --stdin**
|
||||
Instructs stackviz-export to read a subunit stream from stdin.
|
||||
|
||||
**-r, --repository REPOSITORY**
|
||||
Specifies a :code:`.testrepository` to read subunit streams from. This
|
||||
argument can be used multiple times to specify additional repositories.
|
||||
**-r, --repository REPOSITORY**
|
||||
Specifies a :code:`.testrepository` to read subunit streams from. This
|
||||
argument can be used multiple times to specify additional repositories.
|
||||
|
||||
Stackviz also visualizes machine utilization statistics using dstat. To attach
|
||||
a dstat.csv log to the subunit output, specify the following option:
|
||||
|
||||
**--dstat FILE**
|
||||
Specifies a csv-formatted dstat log file that corresponds with the
|
||||
provided subunit stream file.
|
||||
**--dstat FILE**
|
||||
Specifies a csv-formatted dstat log file that corresponds with the
|
||||
provided subunit stream file.
|
||||
|
||||
Additional options:
|
||||
|
||||
**-h --help**
|
||||
Print help message.
|
||||
**-h --help**
|
||||
Print help message.
|
||||
|
||||
**-z --gzip**
|
||||
Enables gzip compression for data files.
|
||||
**-z --gzip**
|
||||
Enables gzip compression for data files.
|
||||
|
||||
Output
|
||||
======
|
||||
|
||||
@ -57,25 +57,25 @@ found on the test panel on the timeline. Additional tabs in this panel
|
||||
are dependent upon the logs that the test kept. Each of these tabs provides
|
||||
additional information to aid debugging. The most common tabs include:
|
||||
|
||||
**pythonlogging**
|
||||
Contains logs for API calls that were used in the test. This
|
||||
log is often quite large, as it contains full headers for every request
|
||||
at INFO, DEBUG, WARNING, and ERROR levels. To make searching these logs
|
||||
easier, the test details page has a built in filter for parsing by log
|
||||
level. In the header of the test details page, the magnifying glass
|
||||
can be clicked to only show pythonlogging lines that correspond to a
|
||||
certain level of detail. To find errors in pythonlogging quickly, it is
|
||||
advisable to only select the WARNING and ERROR levels for display.
|
||||
**pythonlogging**
|
||||
Contains logs for API calls that were used in the test. This
|
||||
log is often quite large, as it contains full headers for every request
|
||||
at INFO, DEBUG, WARNING, and ERROR levels. To make searching these logs
|
||||
easier, the test details page has a built in filter for parsing by log
|
||||
level. In the header of the test details page, the magnifying glass
|
||||
can be clicked to only show pythonlogging lines that correspond to a
|
||||
certain level of detail. To find errors in pythonlogging quickly, it is
|
||||
advisable to only select the WARNING and ERROR levels for display.
|
||||
|
||||
**reason**
|
||||
Only available for skipped tests. Lists the reason for skipping the test,
|
||||
usually to avoid triggering an outstanding bug.
|
||||
**reason**
|
||||
Only available for skipped tests. Lists the reason for skipping the test,
|
||||
usually to avoid triggering an outstanding bug.
|
||||
|
||||
**traceback**
|
||||
Only available for failed tests. Shows the full traceback of the test
|
||||
runner's error output when the test failed. This is useful in quickly
|
||||
isolating the cause of a failure. There can be multiple traceback logs
|
||||
(e.g. traceback, traceback1) for one test.
|
||||
**traceback**
|
||||
Only available for failed tests. Shows the full traceback of the test
|
||||
runner's error output when the test failed. This is useful in quickly
|
||||
isolating the cause of a failure. There can be multiple traceback logs
|
||||
(e.g. traceback, traceback1) for one test.
|
||||
|
||||
When enough information has been gleaned from more detailed logs, the button
|
||||
in the panel filter can be used to quickly navigate back to the timeline page.
|
||||
@ -129,13 +129,13 @@ Services
|
||||
by dataset service with :code:`$http` and :code:`$q` directives. Below is
|
||||
the list of calls:
|
||||
|
||||
- :code:`list` returns `config.json` using GET.
|
||||
- :code:`get(id)` calls :code:`list`, then iterates through all the
|
||||
available datasets for the requested id number. Rejects if not found.
|
||||
- :code:`raw(dataset)` returns `<dataset>_raw.json` file using GET.
|
||||
- :code:`details(dataset)` returns `<dataset>_details.json` file using GET.
|
||||
- :code:`tree(dataset)` returns `<dataset>_tree.json` file using GET.
|
||||
- :code:`dstat(dataset)` returns `dstat_log.csv` file using GET, if available.
|
||||
- :code:`list` returns `config.json` using GET.
|
||||
- :code:`get(id)` calls :code:`list`, then iterates through all the
|
||||
available datasets for the requested id number. Rejects if not found.
|
||||
- :code:`raw(dataset)` returns `<dataset>_raw.json` file using GET.
|
||||
- :code:`details(dataset)` returns `<dataset>_details.json` file using GET.
|
||||
- :code:`tree(dataset)` returns `<dataset>_tree.json` file using GET.
|
||||
- :code:`dstat(dataset)` returns `dstat_log.csv` file using GET, if available.
|
||||
|
||||
**progress**
|
||||
A wrapper for :code:`nprogress`, a progress bar library. Used in the timeline
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user