Corrects attributions, header, formatting, and hyperlink.

Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
This commit is contained in:
Michael Vincerra
2018-10-01 13:58:43 -07:00
parent 3c1f11273e
commit 44d608ca69
@@ -1,9 +1,9 @@
.. _telemetry-enable:
Enable and disable telemetry in Clear Linux
###########################################
Enable and disable telemetry in Clear Linux* OS
###############################################
|CL| includes a telemetry solution as part of the OS that records events
|CL-ATTR| includes a telemetry solution as part of the OS that records events
of interest and reports them back to the development team via the telemetrics
daemon, **telemd**. This functionality is maintained in the
**telemetrics** software bundle.
@@ -42,7 +42,7 @@ To start telemetry on your system, run the following command:
.. code-block:: bash
sudo telemctl start
sudo telemctl start
This enables and starts the :command:`telemprobd` and :command:`telempostd` daemons and your system will
begin to send telemetry data to the server defined in the file
@@ -57,7 +57,7 @@ To disable both of the telemetry daemons, run the following command:
.. code-block:: bash
sudo telemctl stop
sudo telemctl stop
Opt-out of telemetry
********************
@@ -67,7 +67,7 @@ telemetry service:
.. code-block:: bash
sudo telemctl opt-out
sudo telemctl opt-out
This creates the file :file:`/etc/telemetrics/opt-out` and stops the
telemetry services.
@@ -80,16 +80,17 @@ command and start the service:
.. code-block:: bash
sudo telemctl opt-in
sudo telemctl opt-in
This removes the file :file:`/etc/telemetrics/opt-out` file, if it exists,
and starts the telemetry services.
.. note::
To opt-in but not immediately start telemetry services, you will need to
run the command :command:`sudo telemctl stop` after the :command:`opt-in`
command is entered. Once you are ready to start the service, enter the
command :command:`sudo telemctl start`.
To opt-in but not immediately start telemetry services, you will need to
run the command :command:`sudo telemctl stop` after the :command:`opt-in`
command is entered. Once you are ready to start the service, enter the
command :command:`sudo telemctl start`.
Remove the telemetry software bundle
************************************
@@ -99,7 +100,7 @@ To completely remove telemetrics from your system, use the command
.. code-block:: bash
sudo swupd bundle-remove telemetrics
sudo swupd bundle-remove telemetrics
Additional resources
********************
@@ -109,8 +110,7 @@ Additional resources
* :ref:`telemetry-backend`
* https://github.com/clearlinux/telemetrics-client
.. _`Intel privacy policies`:
https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html
.. _Intel privacy policies: https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html
.. _`Telemetry feature description`:
https://clearlinux.org/features/telemetry