openstack/rally
Code Issues Proposed changes
master
rally/doc
History
Takashi Kajinami a776d20941 Replace retired oslosphinx 
oslosphinx[1] was retired in favor of openstackdocstheme.

[1] https://github.com/openstack-archive/oslosphinx

Change-Id: Idc054fe3164ae12767291c30edcc562532a2c0d9
2024-05-09 14:20:32 +09:00
..
ext Replace deprecated inspect.getargspec 2021-07-15 20:55:46 +09:00
feature_request update documentation reference 2018-02-09 15:05:35 +08:00
release_notes Prepare to Rally 1.0.0 release 2018-06-20 19:02:05 +03:00
source Replace retired oslosphinx 2024-05-09 14:20:32 +09:00
specs Update the community page. 2019-12-03 10:09:22 +08:00
user_stories update references to samples/deployments to point to openstack plugin repo 2019-01-14 14:47:46 +00:00
README.rst update documentation reference 2018-02-09 15:05:35 +08:00
requirements.txt Replace retired oslosphinx 2024-05-09 14:20:32 +09:00

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.