rally-openstack/doc
Alexander Maretskiy 0b7dec0985 [Doc][Reports] New documentation chapter about HTML reports
People often ask questions about HTML report (some questions
repeat again and again), so here is a special chapter proposed.

This chapter was also discussed and approved on weekly meeting.

Change-Id: I6b09b2b9f4101bcd324907e30b58a16ed4a94f7e
2016-08-17 12:37:46 +03:00
..
ext [Doc] Fix small typo in cli_reference 2016-05-11 13:13:27 +03:00
feature_request [feature request] Check queue perfdata 2016-06-30 12:00:44 +00:00
release_notes add release notes for 0.5.0 2016-07-20 17:59:09 +03:00
source [Doc][Reports] New documentation chapter about HTML reports 2016-08-17 12:37:46 +03:00
specs Add performance degradation SLA plugin 2016-07-26 12:47:53 +03:00
user_stories Make code blocks in documentation prettier 2015-09-25 11:05:16 -05:00
README.rst Change deployment model schema 2016-03-28 17:20:46 +03:00

Content of doc directory

This directory contains everything that is related to documentation and bureaucracy. You can find here 4 subdirectories:

feature_request

If some use case is not covered by Rally, it is the right place to request it. To request new feature you should just explain use case on high level. Technical details and writing code are not required at all.

source

Source of documentation. Latest version of documentation.

specs

Specs are detailed description of proposed changes in project. Usually they answer on what, why, how to change in project and who is going to work on change.

user_stories

Place where you can share any of Rally user experience. E.g. fixing some bugs, measuring performance of different architectures or comparing different hardware and so on..

release_notes

The latest.rst contains new features and API changes of Rally's latest release. And you could find all old releases in archive.