docs: Create sections for usage data collection

crc-org · Jan 11, 2022 · 6b14006 · 6b14006
1 parent 0691cff
commit 6b14006
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 26 deletions.
diff --git a/docs/source/meta/product-attributes.adoc b/docs/source/meta/product-attributes.adoc
@@ -37,4 +37,6 @@
 :odo-docs-url-installing: https://docs.openshift.com/container-platform/latest/cli_reference/developer_cli_odo/installing-odo.html
 :odo-docs-url-single-component: https://docs.openshift.com/container-platform/latest/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.html
 
+:telemetry-notice-url: https://developers.redhat.com/article/tool-data-collection
+
 :rhel-resolved-docs: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_networking/using-different-dns-servers-for-different-domains_configuring-and-managing-networking
diff --git a/docs/source/topics/assembly_administrative-tasks.adoc b/docs/source/topics/assembly_administrative-tasks.adoc
@@ -1,4 +1,4 @@
 [id="administrative-tasks_{context}"]
 = Administrative tasks
 
-include::proc_starting-monitoring-alerting-telemetry.adoc[leveloffset=+1]
+include::proc_starting-monitoring.adoc[leveloffset=+1]
diff --git a/docs/source/topics/assembly_installation.adoc b/docs/source/topics/assembly_installation.adoc
@@ -7,4 +7,8 @@ include::ref_required-software-packages.adoc[leveloffset=+1]
 
 include::proc_installing-codeready-containers.adoc[leveloffset=+1]
 
+include::con_about-usage-data-collection.adoc[leveloffset=+1]
+
+include::proc_configuring-usage-data-collection.adoc[leveloffset=+1]
+
 include::proc_upgrading-codeready-containers.adoc[leveloffset=+1]
diff --git a/docs/source/topics/con_about-usage-data-collection.adoc b/docs/source/topics/con_about-usage-data-collection.adoc
@@ -0,0 +1,12 @@
+[id="about-usage-data-collection_{context}"]
+= About usage data collection
+
+{prod} prompts you before use for optional, anonymous usage data collection to assist with development.
+No personally identifiable information is collected.
+Consent for usage data collection can be granted or revoked by you at any time.
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about collected data, see the {rh} link:{telemetry-notice-url}[Telemetry data collection notice].
+* To grant or revoke consent for usage data collection, see link:{crc-gsg-url}#configuring-usage-data-collection_gsg[Configuring usage data collection].
diff --git a/docs/source/topics/proc_configuring-usage-data-collection.adoc b/docs/source/topics/proc_configuring-usage-data-collection.adoc
@@ -0,0 +1,31 @@
+[id="configuring-usage-data-collection_{context}"]
+= Configuring usage data collection
+
+Consent for usage data collection can be granted or revoked by you at any time using the following configuration commands.
+
+[NOTE]
+====
+Changes to telemetry consent do not modify a running cluster.
+The change will take effect next time you run the [command]`{bin} start` command.
+====
+
+.Procedure
+
+* To manually enable telemetry, run the following command:
++
+[subs="+quotes,attributes"]
+----
+$ {bin} config set consent-telemetry yes
+----
+
+* To manually disable telemetry, run the following command:
++
+[subs="+quotes,attributes"]
+----
+$ {bin} config set consent-telemetry no
+----
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about the collected data, see the {rh} link:{telemetry-notice-url}[Telemetry data collection notice].
diff --git a/docs/source/topics/proc_setting-up-codeready-containers.adoc b/docs/source/topics/proc_setting-up-codeready-containers.adoc
@@ -29,24 +29,3 @@ Always run the [command]`{bin}` executable with your user account.
 ----
 $ {bin} setup
 ----
-
-.Consent for telemetry data collection
-
-The `{bin} setup` command prompts you for optional, anonymous usage data collection to assist with development.
-No personally identifiable information is collected.
-
-* To manually enable telemetry, run the following command:
-+
-[subs="+quotes,attributes"]
-----
-$ {bin} config set consent-telemetry yes
-----
-
-* To manually disable telemetry, run the following command:
-+
-[subs="+quotes,attributes"]
-----
-$ {bin} config set consent-telemetry no
-----
-
-For more information about collected data, see the Red{nbsp}Hat link:https://developers.redhat.com/article/tool-data-collection[Telemetry data collection notice].
diff --git a/...arting-monitoring-alerting-telemetry.adoc → ...urce/topics/proc_starting-monitoring.adoc b/...arting-monitoring-alerting-telemetry.adoc → ...urce/topics/proc_starting-monitoring.adoc
@@ -1,8 +1,8 @@
-[id="starting-monitoring-alerting-telemetry_{context}"]
-= Starting monitoring, alerting, and telemetry
+[id="starting-monitoring_{context}"]
+= Starting monitoring
 
 {prod} disables cluster monitoring by default to ensure that {prod} can run on a typical notebook.
-Telemetry is responsible for listing your cluster in the link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
+Monitoring is responsible for listing your cluster in the link:https://console.redhat.com/openshift[Red Hat Hybrid Cloud Console].
 Follow this procedure to enable monitoring for your cluster.
 
 .Prerequisites
@@ -31,5 +31,5 @@ $ {bin} start
 [WARNING]
 ====
 Cluster monitoring cannot be disabled.
-To remove monitoring, alerting, and telemetry, set the `enable-cluster-monitoring` configurable property to `false` and delete the existing {prod} virtual machine.
+To remove monitoring, set the `enable-cluster-monitoring` configurable property to `false` and delete the existing {prod} virtual machine.
 ====