openstack/rally

History

Jenkins 2a7a4a9c11 Merge "[Docs] Small rename s/plot2html/report/ in docs"		2015-08-01 00:10:49 +00:00
..
feature_request	Fix eight typos on Rally documentation	2015-07-24 09:24:06 +00:00
release_notes	Fix eight typos on Rally documentation	2015-07-24 09:24:06 +00:00
source	Merge "[Docs] Small rename s/plot2html/report/ in docs"	2015-08-01 00:10:49 +00:00
specs	Change new input task format specification	2015-06-05 16:59:51 +03:00
user_stories	Fix typo docs at User stories	2015-07-14 20:09:40 +09:00
README.rst	Add specs in doc/README.rst file	2015-06-22 16:16:17 -05:00

README.rst

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..