openstack/rally-openstack

History

chenhb-zte 16809b37a7 Add py files in doc directories to pep8 check Change-Id: Idb4f8864ab51f5e4ee2eef7745d40d5d8b5e57ce		2017-04-01 11:13:03 +08:00
..
ext	Add py files in doc directories to pep8 check	2017-04-01 11:13:03 +08:00
feature_request	Corrected the grammar mistake	2017-03-28 12:14:26 +00:00
release_notes	add release notes for 0.9.0	2017-03-20 15:28:16 +02:00
source	Add py files in doc directories to pep8 check	2017-04-01 11:13:03 +08:00
specs	removed extra 'can' from description	2017-02-17 02:38:04 +05:30
user_stories	[docs] reduce sphinx warnings	2017-02-07 15:28:53 +02:00
README.rst	Change deployment model schema	2016-03-28 17:20:46 +03: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.