Commit Graph

36 Commits

Author SHA1 Message Date
Andrey Kurilin
6e06677b34 [Docs] Rework "Rally Plugins Reference"
- 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
2016-03-04 17:00:13 +02:00
Jenkins
6232405ef2 Merge "[Docs] Add cli reference to docs" 2016-03-02 17:59:34 +00:00
Luz
0dd2930d19 Documentation tox fix
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
2016-02-29 13:12:22 +00:00
Andrey Kurilin
1fdb5e3d17 [Docs] Add cli reference to docs
Change-Id: Ie6497abc115c81753b0d51f87aeeac664d6720cf
2016-02-26 16:31:03 +02:00
Jenkins
110f013833 Merge "Integrate Rally & Alembic" 2016-02-01 12:24:54 +00:00
Boris Pavlovic
a8de21a077 Integrate Rally & Alembic
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>
2016-01-29 11:24:16 +00:00
Boris Pavlovic
768f7834a8 Update plugin image in documentation
Old one is out of date and contains wrong information

Change-Id: I9c05a0b2faec5dce87abed737b063d086e7caeab
2016-01-26 14:59:56 -08:00
Yatin Kumbhare
d7d539fe21 Fix for the deprecated library function
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I11f6dcf16a16fa5c6d9d813d1e671ea6bca991f1
2016-01-04 19:59:37 +05:30
Boris Pavlovic
c45e1440bb Fix Rally Version in Docs
Use pbr version instead of hardcoded value in configuration of docs

Change-Id: I3fe5e296f11e921a342393f22ba97c6874283a60
2015-12-15 10:58:44 -08:00
Jenkins
e3d11abfa4 Merge "[Spec]Add a spec for distiributed load generation" 2015-11-21 00:32:43 +00:00
Illia Khudoshyn
58b8859f43 [Spec]Add a spec for distiributed load generation
Change-Id: If2462a1142bbf1ce49cd61ac114ab0ced7394ed8
2015-11-19 14:45:06 +00:00
Shuquan Huang
b8e7e38573 OpenStack typo
change capitalization of OpenStack

Change-Id: I990639a0a2a7aa9c995a2c53367d0c424cd522bd
2015-11-15 13:01:34 +08:00
Chris St. Pierre
ce94b93875 Make code blocks in documentation prettier
This commit tags code blocks with the appropriate language so that
Sphinx can add syntax highlighting and make them look nicer.

Change-Id: Id8f178110236b1d97015162b148f3e9127251a3a
2015-09-25 11:05:16 -05:00
Roman Vasilets
f59d38bb47 Add 'Who Is Using Rally' paragraph to the docs
Add 'who is using rally' paragraph to overview section in the
rally.readthedocs.org.

Change-Id: Ic22a265856f0b1d17844730f66036591dbdc3cd9
2015-09-24 17:34:03 +03:00
Boris Pavlovic
20ccd2248f [docs] Add plugin reference
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
2015-09-17 09:20:18 -07:00
Atsushi SAKAI
967b5a4672 Fix eight typos on Rally documentation
It affects five files.
optinal => optional
   https://rally.readthedocs.org/en/latest/feature_request/launch_specific_benchmark.html
behaviour => behavior
natigate => navigate
  https://rally.readthedocs.org/en/latest/release_notes/latest.html
Fuctional => Functional
directiry => directory
automaticaly => automatically
  https://rally.readthedocs.org/en/latest/contribute.html
nessesary => necessary
  https://rally.readthedocs.org/en/latest/plugins.html
Relase => Release
  https://rally.readthedocs.org/en/latest/project_info.html

Change-Id: Ia939b2a5efb6cec63365ba8d71db1b31d827835c
Closes-Bug: #1477849
2015-07-24 09:24:06 +00:00
Boris Pavlovic
80b69c7522 Fix pbr and it's version checks (unblock gates)
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
2015-05-01 10:51:03 +02:00
Mikhail Dubov
186e09bb12 [Docs] Various fixes
* 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
2015-04-20 23:02:17 +03:00
Swapnil Kulkarni
09c01e755e Update stackforge to openstack
Found the issue while configuring devstack,
the libs were having stackforge location.

Change-Id: Ibd93eccb7d89cb6b06a1e8cc1d7d6f65ce52f352
2015-04-20 14:02:43 +05:30
Boris Pavlovic
8d28cb41ac Release 0.0.3
Relese notes for 0.0.3 version

Set new version in doc/source/conf.py

Set new version in setup.cfg

Change-Id: I0569af56525dbb64ffd8ca209cc2212f69dbbe68
2015-04-14 16:50:14 +03:00
Boris Pavlovic
cde656bae2 Release 0.0.2
* 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
2015-03-12 17:48:57 +03:00
Mikhail Dubov
90ca881e84 Fix texts and images in docs
* 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
2015-03-10 15:08:15 +03:00
Oleh Anufriiev
89bd4aa865 Publishing functional tests reports
Change-Id: I4b7543e7244ecc776e6d0955c0428423cca3ad3c
2015-02-10 06:49:46 +02:00
jacobliberman
04d57d373b Replace ' with " in [doc, samples]
Partial bug: 1405884

Change-Id: If6bebfbdd1243adb88fcc3cb015c8f15399e8934
2015-01-29 10:28:46 -06:00
Mikhail Dubov
30b1ad593f Restructure Rally docs
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
2015-01-20 00:27:30 +03:00
Sergey Skripnick
c81e8a5f8b Reorganize test module structure
Moved test modules:
 tests/             ->  tests/unit
 test_ci/           ->  tests/ci
 tests_functional   ->  tests/functional
 rally/hacking      ->  tests/hacking

Add testing read me file

Co-Authored-By: Boris Pavlovic <boris@pavlovic.me>
Co-Authored-By: Andrey Kurilin <akurilin@mirantis.com>

Change-Id: I57c09d892da4adf863c358a4d63e3543b50d10b7
2014-10-07 13:50:40 +00:00
Christian Berendt
667c0557a3 Stop using intersphinx
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
2014-09-25 18:09:22 +00:00
Oleh Anufriiev
0df7f9af4f User_stories and feature requests appended to sphinx
also some markup fixes to treat toctree look

Change-Id: Ibeac44a79e60dc6b2d82259a199856ad67c5fc36
2014-09-12 06:49:26 +03:00
Swapnil Kulkarni
a834d51eac Fix copyright in doc/source/config.py
Mirantis is raplaced by OpenStack Foundation

https://trello.com/c/RdKHZqlq

Change-Id: I371db495da0b14ddaa8e9473dd559880d4990752
2014-08-08 17:58:58 +00:00
Oleh Anufriiev
8e25d36fd8 Amended sphinx documents
Updated from https://wiki.openstack.org/wiki/Rally

Change-Id: I520b08202910ad476447fa09ca0a5993fc1bffc5
2014-08-07 20:09:36 +03:00
Oleh Anufriiev
3684c92cfc Fix side menu depth
Change-Id: I112ee28f032b4ead9f1cbd67b3d18f357e54d7b6
2014-07-30 15:16:13 +03:00
Mikhail Dubov
e0c898a024 Improve doc/source
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
2014-06-25 07:41:16 +04:00
Sergey Skripnick
77c58df20d Prepare documentation for readthedocs
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
2014-06-05 17:45:51 +03:00
Olga Kopylova
ba13051039 Add documentation for plugins
Documentation how to create and use plugins stored in doc/plugins.rst file

Change-Id: Icdf816861bc81b7a2fbcca92ebaf44ca0cb05903
2014-05-19 23:34:54 +03:00
Doug Hellmann
40e68657d5 Switch to oslosphinx
Use the version of the doc theme without the namespace
package.

Partial-bug: #1277168
Change-Id: I7788a9d6b5984fdfcc4678f2182104d2eb8a2be0
2014-03-12 10:19:46 -07:00
Ilya Kharin
0843b1aea4 Add support to build docs by Sphinx
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
2014-01-15 19:11:11 +04:00