4c0a54c142
First pack of changes in upcoming chain to redesign Rally docs.
All information related to the project overview separated and
refactored. Modified files fit 80 symbols margin where possible.
[TODO] continue with other parts of the docs:
- Installation and upgrade
- Quick start aka Rally step-by-step
- Command Line Interface
- Rally Task Component
- Rally Verification Component
- Rally Plugins, Rally Plugins Reference
- Contribute to Rally
- Request New Features
- Project Info
[TODO] add 80 symbols margin check similar to what
Performance Documentation has
Change-Id: Icc6c9665fe52a7d7c191f78a1fe3ad2a38b4231f
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.