95e94f768a
Add a documentation section that uses the automodule sphinx documentation generator to build a utility page that shows people what the utility modules taskflow uses for *internal* usage are and include a warning to try to avoid end-users from using these modules (better to warn than not warn). This also adds on docstrings to various functions that were missing it so that they appear correctly in the generated documentation. Change-Id: Ibd5695927601614f31793ea5450887694f4320ae
104 lines
2.7 KiB
ReStructuredText
104 lines
2.7 KiB
ReStructuredText
TaskFlow
|
|
========
|
|
|
|
*TaskFlow is a Python library that helps to make task execution easy,
|
|
consistent and reliable.* [#f1]_
|
|
|
|
.. note::
|
|
|
|
If you are just getting started or looking for an overview please
|
|
visit: http://wiki.openstack.org/wiki/TaskFlow which provides better
|
|
introductory material, description of high level goals and related content.
|
|
|
|
Contents
|
|
========
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
atoms
|
|
arguments_and_results
|
|
inputs_and_outputs
|
|
|
|
patterns
|
|
engines
|
|
notifications
|
|
persistence
|
|
resumption
|
|
|
|
jobs
|
|
conductors
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
workers
|
|
|
|
Examples
|
|
--------
|
|
|
|
While developing TaskFlow the team has worked *hard* to make sure the various
|
|
concepts are explained by *relevant* examples. Here are a few selected examples
|
|
to get started (ordered by *perceived* complexity):
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
examples
|
|
|
|
To explore more of these examples please check out the `examples`_ directory
|
|
in the TaskFlow `source tree`_.
|
|
|
|
.. note::
|
|
|
|
If the examples provided are not satisfactory (or up to your
|
|
standards) contributions are welcome and very much appreciated to help
|
|
improve them. The higher the quality and the clearer the examples are the
|
|
better and more useful they are for everyone.
|
|
|
|
.. _examples: http://git.openstack.org/cgit/openstack/taskflow/tree/taskflow/examples
|
|
.. _source tree: http://git.openstack.org/cgit/openstack/taskflow/
|
|
|
|
Considerations
|
|
--------------
|
|
|
|
Things to consider before (and during) development and integration with
|
|
TaskFlow into your project:
|
|
|
|
* Read over the `paradigm shifts`_ and engage the team in `IRC`_ (or via the
|
|
`openstack-dev`_ mailing list) if these need more explanation (prefix
|
|
``[TaskFlow]`` to your emails subject to get an even faster response).
|
|
* Follow (or at least attempt to follow) some of the established
|
|
`best practices`_ (feel free to add your own suggested best practices).
|
|
* Keep in touch with the team (see above); we are all friendly and enjoy
|
|
knowing your use cases and learning how we can help make your lives easier
|
|
by adding or adjusting functionality in this library.
|
|
|
|
.. _IRC: irc://chat.freenode.net/openstack-state-management
|
|
.. _best practices: http://wiki.openstack.org/wiki/TaskFlow/Best_practices
|
|
.. _paradigm shifts: http://wiki.openstack.org/wiki/TaskFlow/Paradigm_shifts
|
|
.. _openstack-dev: mailto:openstack-dev@lists.openstack.org
|
|
|
|
Miscellaneous
|
|
-------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
exceptions
|
|
states
|
|
types
|
|
utils
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. [#f1] It should be noted that even though it is designed with OpenStack
|
|
integration in mind, and that is where most of its *current*
|
|
integration is it aims to be generally usable and useful in any
|
|
project.
|