Files
rally-openstack/doc
Boris Pavlovic 3d9b1e43a6 Rename certification/ to tasks/
Every day Rally step by step closer to the point where Rally is going to be
generic framework and it would be possible to split Rally & Rally OpenStack Plugins

One of the blockers for doing this is certification & samples directories and
their contents. Current apporach creates a lot of confusion:

- Rally Users are running samples against production
- Rally samples are actually not that usefull, because creating from them
  tasks takes a lot of time
- Rally Users don't know what certification task is and how to use it
- Samples are hard to ship/find in packaged way (when rally is installed)
- Samples are going to be impossible to ship after the split
- We have to keep hunderds of yaml/json files in actual state
  in our repo (extra work for developers)

Proposed approach is to:

- Create mechansim CLI command that generates samples using plugin names
- Rename certification -> tasks
- Put in tasks directory pre created and tested tasks for different use cases:
  key performance metrics, functional testing, load testing of key functionality,
  ha Testing
- Remove samples as they are not needed anymore

Change-Id: I4c45224c3af637d17dab0edea038c69a2bae8b1a
2017-09-19 18:01:25 -07:00
..
2017-08-29 13:25:37 -07:00
2017-09-19 18:01:25 -07:00
2017-08-29 13:25:41 -07:00
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.