0a777912d0
Rally team posts documentation at two places: - http://rally.readthedocs.org/en/latest/ (preferable place) - http://docs.openstack.org/developer/rally/ Most projects post docs at docs.o.o with oslosphinx theme. Since default theme of sphinx is not so good, let's use official openstack theme instead. Theme from oslosphinx has several issues: - it is hard to find the link to home page of project documentation - there is no sidebar with global content Based on these two issues let's extend oslosphinx theme a bit. Change-Id: Ifc75b430b7335c6a87a9102810ec33a5a913c43a |
||
|---|---|---|
| .. | ||
| ext | ||
| feature_request | ||
| release_notes | ||
| source | ||
| specs | ||
| user_stories | ||
| 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.
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.