Files
python-mistralclient/doc/source/index.rst
Ghanshyam Mann ffa67c1e64 [community goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38537
Change-Id: I01c5a3a5def5baa215413cea25fc5fda41fea2b6
2021-05-31 20:33:28 +00:00

41 lines
1.0 KiB
ReStructuredText

Python bindings to the OpenStack Workflow API
=============================================
This is a client for OpenStack Mistral API. There's a Python API
(the :mod:`mistralclient` module), and a command-line script
(installed as :program:`mistral`).
Using mistralclient
-------------------
.. toctree::
:maxdepth: 2
cli/cli_usage_with_openstack
cli/cli_usage_with_keycloak
cli/cli_usage_targeting_workflows
cli/cli_usage_source_execution
class_reference
For information about using the mistral command-line client, see
`Workflow service command-line client`_.
.. _Workflow service command-line client: https://docs.openstack.org/mistral/latest/cli/index.html
Python API Reference
--------------------
* `REST API Specification`_
.. _REST API Specification: https://docs.openstack.org/mistral/latest/api/v2.html
For Contributors
----------------
* If you are a new contributor to python-mistralclient please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing