zoneminder/docs/index.rst

ZoneMinder Documentation
========================

.. toctree::
   :hidden:

   installationguide/index
   userguide/index
   api
   faq
   contributing

Welcome to ZoneMinder's documentation. Please navigate to one of the links below.

If you are facing issues that are not covered in the documentation, please feel free to check the `ZoneMinder Forums <https://forums.zoneminder.com/viewforum.php?f=26>`__ or join the `ZoneMinder-Chat Slack channel <https://join.slack.com/t/zoneminder-chat/shared_invite/enQtNTU0NDkxMDM5NDQwLTdhZmQ5Y2M2NWQyN2JkYTBiN2ZkMzIzZGQ0MDliMTRmM2FjZWRlYzUwYTQ2MjMwMTVjMzQ1NjYxOTdmMjE2MTE>`__ if you prefer real time interaction.

:doc:`installationguide/index`
  Many distribution repos only hold older versions of ZoneMinder, current versions contain many bug fixes and updated functionality. Instructions here for installing updated packages or compiling from source.

:doc:`userguide/index`
  Guide to setting up ZoneMinder for the first time and detailed guides for using the ZoneMinder front end.

:doc:`api`
  Information on using the CakePHP based API for interfacing to ZoneMinder

:doc:`faq`
  Frequently Asked Questions

:doc:`contributing`
  How to contribute to ZoneMinder. As a community project we always need help, you don't need to be a coder to test or update documentation.

`Event Notification Server and Machine Learning hooks <https://zmeventnotification.readthedocs.io/en/latest/index.html>`__
        Documentation for the 3rd party Event Notification Server and Machine Learning for Object/People/Face detection.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Initial attempt to migrate wiki to readthedocs 2014-07-13 20:25:30 +08:00			`ZoneMinder Documentation`
			`========================`
Initial commit of Sphinx docs directory 2014-04-26 02:33:41 +08:00
			`.. toctree::`
Initial attempt to migrate wiki to readthedocs 2014-07-13 20:25:30 +08:00			`:hidden:`
Initial commit of Sphinx docs directory 2014-04-26 02:33:41 +08:00
Initial attempt to migrate wiki to readthedocs 2014-07-13 20:25:30 +08:00			`installationguide/index`
			`userguide/index`
Initial commit of documentation for the API 2014-04-26 03:13:32 +08:00			`api`
Added FAQ to docs 2014-04-30 11:11:20 +08:00			`faq`
Added a doc for contributing to the project 2014-04-30 21:48:03 +08:00			`contributing`
Initial commit of documentation for the API 2014-04-26 03:13:32 +08:00
add slack and forum links at the start so they are easy to discover 2019-10-29 00:28:02 +08:00			`Welcome to ZoneMinder's documentation. Please navigate to one of the links below.`

			If you are facing issues that are not covered in the documentation, please feel free to check the `ZoneMinder Forums <https://forums.zoneminder.com/viewforum.php?f=26>`__ or join the `ZoneMinder-Chat Slack channel <https://join.slack.com/t/zoneminder-chat/shared_invite/enQtNTU0NDkxMDM5NDQwLTdhZmQ5Y2M2NWQyN2JkYTBiN2ZkMzIzZGQ0MDliMTRmM2FjZWRlYzUwYTQ2MjMwMTVjMzQ1NjYxOTdmMjE2MTE>`__ if you prefer real time interaction.
Initial attempt to migrate wiki to readthedocs 2014-07-13 20:25:30 +08:00
			:doc:`installationguide/index`
codespell: misc. spelling corrections Signed-off-by: Dmitry Smirnov <onlyjob@member.fsf.org> 2016-02-08 17:41:36 +08:00			`Many distribution repos only hold older versions of ZoneMinder, current versions contain many bug fixes and updated functionality. Instructions here for installing updated packages or compiling from source.`
Initial attempt to migrate wiki to readthedocs 2014-07-13 20:25:30 +08:00
			:doc:`userguide/index`
			`Guide to setting up ZoneMinder for the first time and detailed guides for using the ZoneMinder front end.`

			:doc:`api`
			`Information on using the CakePHP based API for interfacing to ZoneMinder`

			:doc:`faq`
			`Frequently Asked Questions`

			:doc:`contributing`
			`How to contribute to ZoneMinder. As a community project we always need help, you don't need to be a coder to test or update documentation.`

Add ES/ML link to root doc 2019-10-26 00:04:09 +08:00			`Event Notification Server and Machine Learning hooks <https://zmeventnotification.readthedocs.io/en/latest/index.html>`__
consistent naming of ES -> Event Notification Server 2019-10-27 22:47:09 +08:00			`Documentation for the 3rd party Event Notification Server and Machine Learning for Object/People/Face detection.`
Add ES/ML link to root doc 2019-10-26 00:04:09 +08:00
Initial commit of Sphinx docs directory 2014-04-26 02:33:41 +08:00

			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`