gecko/services/healthreport/docs/index.rst
Gregory Szorc ff2ea33e7d Bug 961146 - Refactor Health Report documentation, import external docs; r=rnewman
FHR docs were extracted from /services/docs into their own compartment.
This arguably should have been done originally.

Documentation on the payload format has been imported from
https://github.com/mozilla-services/docs. Those docs were created in a
time before we had in-tree docs and this tree is a more logical home for
them.

--HG--
rename : services/docs/healthreport.rst => services/healthreport/docs/index.rst
extra : rebase_source : 4e2fd62cc98ea2620f580e34d032cb39bafb5108
extra : amend_source : bd6309cc9d53aba1b085067960bf20a94125c5b0
2014-01-22 17:47:15 -08:00

36 lines
1.2 KiB
ReStructuredText

.. _healthreport:
=====================
Firefox Health Report
=====================
``/services/healthreport`` contains the implementation of the
``Firefox Health Report`` (FHR).
Firefox Health Report is a background service that collects application
metrics and periodically submits them to a central server. The core
parts of the service are implemented in this directory. However, the
actual XPCOM service is implemented in the
:ref:`data_reporting_service`.
The core types can actually be instantiated multiple times and used to
power multiple data submission services within a single Gecko
application. In other words, everything in this directory is effectively
a reusable library. However, the terminology and some of the features
are very specific to what the Firefox Health Report feature requires.
.. toctree::
:maxdepth: 1
architecture
dataformat
Legal and Privacy Concerns
==========================
Because Firefox Health Report collects and submits data to remote
servers and is an opt-out feature, there are legal and privacy
concerns over what data may be collected and submitted. **Additions or
changes to submitted data should be signed off by responsible
parties.**