openstack/rally-openstack
Code Issues Proposed changes
f63c4786e1
rally-openstack/doc
History
Boris Pavlovic 0538b6f845 Introduce in-tree Rally specs 
Most of OpenStack projects have specs.
Specs are documents in .rst format with fixed structure.
They allow developers to use standard gerrit code review approach
to discuss and align future changes in project.

This patch includes:

- doc/specs directory
- doc/specs readme files
- spec template.rst
- unit tests that checks that specs are regarding template

Change-Id: I31e0dbb8bcbc68ca40c67c643d44b27359906b9c
2015-03-08 02:25:17 +03:00
..
feature_request Restructure Rally docs 2015-01-20 00:27:30 +03:00
source Publishing functional tests reports 2015-02-10 06:49:46 +02:00
specs Introduce in-tree Rally specs 2015-03-08 02:25:17 +03:00
user_stories Restructure Rally docs 2015-01-20 00:27:30 +03:00
README.rst Add feature_request mechanism 2014-08-25 19:20:15 +04: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.

samples

If you are looking for samples of deployments and benchmarks configuration you are on the right way

source

Source of documentation. Latest version of documentation.

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