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
Prepare for deployment refactoring.
Add migration to add column credentials
to deployment model and drop users and admin columns.
Add tests for migrations and walk mixin
for it implementation.
Add documentation about autogeneration of migrations.
Add possibility to make batch rendering for alembic
autogeneration.
Change-Id: I5958a96671d2fb111533c09feb462b4dcd7483b9
- 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
Added information about debugging unit test with tox.
Replace 3 references to py26 with py34 to reflect current
rally tox configuration.
Co-Authored-By: Illia Khudoshyn <ikhudoshyn@mirantis.com>
Change-Id: I10c865fae473111b35dca1b9c8f51f31ba066b42
closes-bug: 1547265
Changes:
* Add descriptive docstrings for plugins based on OutputChart
* Register these plugins in doc/ext/plugin_reference.py
so plugin/plugin_reference.htmlwill have a documentation
chapter based on added docstrings
Change-Id: I655a1c985d437d46fcb7df2865cb38bbcc608a2f
These will be used to do out-of-band cleanup in the near future, so
they are no longer specific to the cleanup context.
Change-Id: I5b5c7c89b04a080c487936cc3df0df24929ced31
Implements: blueprint cleanup-refactoring
Alembic allows us to change in future DB schema,
which we are going to do soon.
This patch adds under rally/common/db/sqlalchemy/migrations
required files for alembic as well as a first init migrations
that was autogenerated from models that we have.
As well this patch adds CLI commands for DB management
Change-Id: I7caa090aa5c4c6563b7e34d0d09baa039a3aa718
Co-Authored-By: Illia Khudoshyn <ikhudoshyn@mirantis.com>
Spec 'improve_scenario_output_format.rst' is implemented,
so it is moved to doc/specs/implemented/
Also there were some updates to this spec to conform
improvements that are actually done:
* Each output data set has 'description' text passed to
Scenario.add_output() while adding the output.
Description is displayed in HTML report under chart title.
* Method Scenario.add_output() has changed (schema
verification is added)
* Subtab 'Detailed' is renamed to 'Per iteration'
Change-Id: Iddf0b0f5edea8002493d47131994f46202363ef5
This proposes to make resource type converters into proper plugins,
stop depending on OpenStack as much as is possible without modifying
validation, and make some improvements to handle an edge case
converting images.
Change-Id: If078332230df417b3967f086815796c7a96fa882
This commit tags code blocks with the appropriate language so that
Sphinx can add syntax highlighting and make them look nicer.
Change-Id: Id8f178110236b1d97015162b148f3e9127251a3a
Tables with plugins looks quite ugly so this patch removes tables
and use just rubrics and doctest_block types of nodes
Change-Id: Ifb5d53cfa1d86ab477671d3485d63fbf09f9246c
