rally/doc
Boris Pavlovic e2d52daf12 Refactoring of scenario plugin base
* Moved rally.task.scenarios.base -> rally.task.scenario

  - Shorter imports and simpler structure of tree
  - Unified with other plugin bases

* Add rally.task.atomic module

  - We will use atomic actions in both scenarios and context
    this is first step of unification

  - Module has only links to method and atomic action context
    with new names. So we will change all plugins but won't
    touch atomic actions at this patch (to reduce amount of
    LOC in this patch)

  - Next step is to move and unify atomic action code for
    scenarios and contexts

* Rename rally.task.scenario.scenario to rally.task.scenario.configure

  scenario.scenario is unclear and not aligned with other plugin
  types where configure() method is used for the same purpose

* Add shortcut rally.plugins.openstack.scenario.configure

  so there is no need to import rally.plugins.openstack.scenario
  and rally.task.scenario modules

* Fix all unit tests & docs

Change-Id: I388bd1c1af951670c6a1d043cfeb2a6753a085b0
2015-08-14 08:27:20 -07: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 Refactoring of scenario plugin base 2015-08-14 08:27:20 -07:00
specs Fix item name in new task format spec 2015-08-06 18:23:58 +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

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