- 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
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>
This commit tags code blocks with the appropriate language so that
Sphinx can add syntax highlighting and make them look nicer.
Change-Id: Id8f178110236b1d97015162b148f3e9127251a3a
This patch adds single page that contains
list of all plugins with their description.
In the future next things will be addressed:
- Split this page into few pages, each page should
contain only specific type of plugins
- Improve descriptions of plugins that we have,
especially description of context classes
- Add description to base plugin classes that expalins
how everything works.
So it won't be hardcoded in plugins.rst and it will
be possilbe to use it in different places
Change-Id: I87ec6f8497392306578d91263c98c4c035acc521
New version of pbr 0.11 was released and it checks
that version in setup.cfg is bigger then latest tag
To avoid future issues we will let pbr calulate version
instead of hardcode them in setup.cfg
Temporary disable coverage job to merge this patch
Partial-bug: #1450731
Change-Id: I0c00c231cea1a0506107133803406eb56694f690
* Remove obsolete rst files
* Structural changes: added a folder "miscellaneous" for articles not included
in the main tree
* Small fixes in rst files that resulted in warnings while building the docs
* Task templates lesson is now the 4th in the tutorial
Change-Id: Id1db7e2337ca8266352a5ede68c66e4b3739335b
* Add new section in docs for release_notes
* Write release notes for 0.0.1 and 0.0.2 versions
* Move doc/feature_request/stop_scenario_after_several_errors to implemented
* Various improvements and fixes in docs
Change-Id: I787e320db5f7a17044a76f345612cd29d515f3ca
* Reuse the images from the repository in README
* Shrink the images to 800-1000px
* Fix incorrect sectioning, typos, missing info etc. on ReadTheDocs
* Add a tutorial step about the --abort-on-sla-failure feature
* Move Rally deployment engines to a separate tutorial step
* rally use deployment -> rally deployment use
Change-Id: Id5f492e40a041aa3308e9faa21b833220415323d
Modify Rally docs (for readthedocs), sticking to the following principles:
* Make the docs structure as simple as possible:
1. Overview
2. Install Rally
3. Rally step-by-step
4. User stories
5. Plugins
6. Contribute to Rally
7. Rally OS Gates
8. Request a New Feature
9. Project Info
* Keep in mind what questions different target groups usually have about Rally.
The new structure relates to these groups as follows:
1 -> Managers
2, 3, 4 -> QA
5, 6, 7, 8, 9 -> QA & Developers
* Make each docs page to be easy to get through;
* Prefer pictures over text;
* Use hyperlinks to easily navigate from page to page;
* Fix incorrect English & typos.
Also add a sample for SLA plugins.
Change-Id: I720d87be851c273689a21aaba87fc67eacf0f161
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: Iab56650edc32609d2887550ea26c4e5137ab9e7e
Related-Bug: #1368910
Here we enhance the rst docs (used for readthedocs):
* Simplify its index structure by reducing it to only 5 points:
1. Deploy (engines & server providers)
2. Verify
3. Benchmark (scenarios, engine, contexts, plugins)
4. Command Line Interface
5. Implementation (all source docs moved here)
* Extend the 'Benchmark' page with info from the "Main concepts" page from Wiki
* Add some introductory text on Deploy & Verify parts based on that from Wiki
* Simplify headings by removing "The" and "Layer"
Change-Id: I04bb553aba04009634272a88a757baa8f2c8c359
Create Makefile and recreate conf.py using sphinx-quickstart
Add _build to gitignore
Fix several nits in rst files
Add tox environment for docs building. Now docs may be built by
running `tox -edoc'
Change-Id: Ib0eb17047e583bdf3ac9111e117f908340f4d5ef
The patch introduce configuration files for building documentations by
Sphinx. Also added a simple tree of static documents for test ability of
autobuilding documentation from source code.
bp rally-sphinx-docs
Change-Id: I2a225b1bdb4ae0640428b438a0c9779e28586546