a9287daaa9
This patch adds release notes section in Rally's root documentation. Change-Id: I4a4eccbd2f53f11846a0e17f650b9db2be6e1332 Closes-Bug: #1468054
48 lines
1.3 KiB
ReStructuredText
48 lines
1.3 KiB
ReStructuredText
========================
|
|
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_.
|
|
|
|
.. _documentation: http://rally.readthedocs.org/
|
|
|
|
|
|
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_.
|
|
|
|
.. _latest.rst: https://github.com/openstack/rally/blob/master/doc/release_notes/latest.rst
|
|
.. _archive: https://github.com/openstack/rally/tree/master/doc/release_notes/archive
|