openstack
/
sushy-tools
Code Issues Proposed changes

Merge "Add contributor docs on running sushy-tools locally"

This commit is contained in:
Zuul 2019-06-11 09:29:11 +00:00 committed by Gerrit Code Review
parent 1edffefe72 255e376731
commit aae0242c81
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/contributor/index.rst
View File

@ -4,3 +4,30 @@ Contributing
============
.. include:: ../../../CONTRIBUTING.rst
Cloning the sushy-tools repository
++++++++++++++++++++++++++++++++++
If you haven't already, sushy-tools source code should be pulled directly
from git.
.. code-block:: bash
# from the directory where you want the source code to reside
git clone https://opendev.org/openstack/sushy-tools
Running the emulators locally
+++++++++++++++++++++++++++++
Activate the virtual environment and run the emulator of your choice. For
instance, to run the dynamic emulator:
.. code-block:: bash
tox -e venv -- sushy-emulator
For more information on running the emulators, refer to the user docs for the
:doc:`dynamic-emulator <../user/dynamic-emulator>` and the :doc:`static-
emulator <../user/static-emulator>`.