1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/services/healthreport/docs/index.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,36 @@
1.4 +.. _healthreport:
1.5 +
1.6 +=====================
1.7 +Firefox Health Report
1.8 +=====================
1.9 +
1.10 +``/services/healthreport`` contains the implementation of the
1.11 +``Firefox Health Report`` (FHR).
1.12 +
1.13 +Firefox Health Report is a background service that collects application
1.14 +metrics and periodically submits them to a central server. The core
1.15 +parts of the service are implemented in this directory. However, the
1.16 +actual XPCOM service is implemented in the
1.17 +:ref:`data_reporting_service`.
1.18 +
1.19 +The core types can actually be instantiated multiple times and used to
1.20 +power multiple data submission services within a single Gecko
1.21 +application. In other words, everything in this directory is effectively
1.22 +a reusable library. However, the terminology and some of the features
1.23 +are very specific to what the Firefox Health Report feature requires.
1.24 +
1.25 +.. toctree::
1.26 + :maxdepth: 1
1.27 +
1.28 + architecture
1.29 + dataformat
1.30 + identifiers
1.31 +
1.32 +Legal and Privacy Concerns
1.33 +==========================
1.34 +
1.35 +Because Firefox Health Report collects and submits data to remote
1.36 +servers and is an opt-out feature, there are legal and privacy
1.37 +concerns over what data may be collected and submitted. **Additions or
1.38 +changes to submitted data should be signed off by responsible
1.39 +parties.**
