rally/doc
Andrey Kurilin d186b998a2 [Docs] Rework "Rally Plugins Reference"
- Add "Contents" add the top of page
- Mark each group of plugin as a Category and make it's name as a link
- Mark each plugin as a Sub-category and make it's name as a link
- Parse plugin description and parameters instead of displaying them as quotes
- Add pluging's namespaces
- Add references to github for each plugin module
- Add "Table Of Contents" sidebar(already used at readthedocs, but was missed
  from http://docs.openstack.org/developer/rally/)

Change-Id: I8889ccc7f82b0f46495ce607c242d37242360a25
2016-03-04 17:00:13 +02:00
..
ext [Docs] Rework "Rally Plugins Reference" 2016-03-04 17:00:13 +02:00
feature_request Move "tempest concurrency" feature request to implemented 2016-01-25 23:13:25 +00:00
release_notes Release notes for 0.3.1 2016-02-18 22:19:41 +00:00
source [Docs] Rework "Rally Plugins Reference" 2016-03-04 17:00:13 +02:00
specs [spec] Refactoring scenario utils 2016-02-22 19:44:38 +02:00
user_stories Make code blocks in documentation prettier 2015-09-25 11:05:16 -05:00
README.rst Add release notes section in Rally's doc 2015-08-21 15:58:36 +08: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.