.. index::
    single: Support

.. _support:

-------
Support
-------

If you are having difficulties with Turbulenz Technology, the
following support resources are available for developers:

:Documentation: http://docs.turbulenz.com
:Discussion forum: https://groups.google.com/group/turbulenz-engine-users
:Open source contribution:
    - `turbulenz_engine <https://github.com/turbulenz/turbulenz_engine>`__
    - `turbulenz_local <https://github.com/turbulenz/turbulenz_local>`__
    - `turbulenz_tools <https://github.com/turbulenz/turbulenz_tools>`__

Turbulenz Documentation
-----------------------

Documentation for Turbulenz technology can be found:

* Included with each SDK, up-to-date with that SDK version (in HTML and PDF formats).
* As part of the open source `turbulenz_engine <https://github.com/turbulenz/turbulenz_engine>`__ repository, buildable with the 'docs' command.
* Online at http://docs.turbulenz.com with the latest information.

**Programming Interfaces**

The API reference gives the details of all available calls and their
arguments:

    * :ref:`Low Level API <low_level_api>`
    * :ref:`High Level API <high_level_api>`
    * :ref:`Turbulenz Services API <turbulenz_services_api>`
    * :ref:`Protolib API <protolib_api>`

**Changes**

*For SDK releases:*

Changes, fixes and upgrade information between SDK releases are included in the release notes:

    * `Latest Release Notes (online) <http://docs.turbulenz.com/release_notes>`_

*For open source repositories:*

Changes, fixes and upgrade information between updates to the open source repositories:

    * `turbulenz_engine changelog <https://github.com/turbulenz/turbulenz_engine/blob/master/docs/source/changelog.rst>`_
    * `turbulenz_local changelog <https://github.com/turbulenz/turbulenz_local/blob/master/CHANGES.rst>`_
    * `turbulenz_tools changelog <https://github.com/turbulenz/turbulenz_tools/blob/master/CHANGES.rst>`_

**Known Issues**

A list of the latest problems and caveats we are aware of.  Some
issues will be addressed by updates to the Turbulenz SDK/open source repositories, some require
fixes from 3rd parties and some require longer term workarounds.

    * `Latest Known Issues (online) <http://docs.turbulenz.com/known_issues>`_

If you think something in the documentation is incorrect, doesn't make
sense or is missing, please let us know.

Turbulenz Engine Users Group
----------------------------

There is a Turbulenz Engine Users Group on Google Groups.
This is a public forum for news, questions, discussions, showcasing work, feature requests and more:

https://groups.google.com/group/turbulenz-engine-users

To post on the group:

1) Log-in using an existing Google account or create a new one.

2) Click the "Join group to post" button.

3) Set your email and display name preferences and click "Join this group".

4) Press the "New Topic" button near the top of the page to start writing your post.

5) You can click the "star" icon below the title to add the group to your favourites.
   If you find the group useful, you can promote it using the +1 button.

The Turbulenz team actively maintain the group by posting news/updates and responding to questions.

Contributing
------------

If you have a bug to report, patches or pull requests for any of the open source Turbulenz products you can submit them via Github here:

* `turbulenz_engine <https://github.com/turbulenz/turbulenz_engine>`__
    * `Issues <https://github.com/turbulenz/turbulenz_engine/issues>`__
    * `Pull requests <https://github.com/turbulenz/turbulenz_engine/pulls>`__
* `turbulenz_local <https://github.com/turbulenz/turbulenz_local>`__
    * `Issues <https://github.com/turbulenz/turbulenz_local/issues>`__
    * `Pull requests <https://github.com/turbulenz/turbulenz_local/pulls>`__
* `turbulenz_tools <https://github.com/turbulenz/turbulenz_tools>`__
    * `Issues <https://github.com/turbulenz/turbulenz_tools/issues>`__
    * `Pull requests <https://github.com/turbulenz/turbulenz_tools/pulls>`__

See the `contributing section <https://github.com/turbulenz/turbulenz_engine#contributing>`__ for more details.