openstack/rally

History

sunqingliang6 0813f356b7 fix typos Change-Id: Ie0ec7353b2b97cb874dcd544d53a9330d09e1fcf		2018-06-21 17:42:46 +08:00
..
ext	[docs] Use proper reference for openstack plugins	2018-04-19 14:52:51 +00:00
feature_request	update documentation reference	2018-02-09 15:05:35 +08:00
release_notes	Prepare to Rally 1.0.0 release	2018-06-20 19:02:05 +03:00
source	Trivial: Update pypi url to new url	2018-04-20 15:13:36 +00:00
specs	fix typos	2018-06-21 17:42:46 +08:00
user_stories	Update incorrect URL and word typo	2018-03-07 02:33:42 +00:00
README.rst	update documentation reference	2018-02-09 15:05:35 +08:00
requirements.txt	[docs] Use proper reference for openstack plugins	2018-04-19 14:52:51 +00: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..

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.