Skip to content

Commit 6b5f21c

Browse files
insectenginebrunobatmaxandersen
authored
Usagepage reorganized (#1731)
* Add usage page * split usage in two page * Update usage.md Co-authored-by: Bruno Baptista <[email protected]> * fix wording * text adjustments and graphic update * clarify some wording * Update _data/projectfooter.yaml * update image --------- Co-authored-by: brunobat <[email protected]> Co-authored-by: Max Rydahl Andersen <[email protected]>
1 parent 48c71d4 commit 6b5f21c

File tree

9 files changed

+124
-0
lines changed

9 files changed

+124
-0
lines changed

‎_data/projectfooter.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ links:
2020
url: https://github.com/orgs/quarkusio/projects/13/views/1
2121
- page: Security&nbsp;policy
2222
url: /security
23+
- page: Usage
24+
url: /usage
2325

2426
- title: Follow Us
2527
width: 1

‎_includes/usage.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="full-width-bg component" xmlns="http://www.w3.org/1999/html">
2+
<div class="grid-wrapper">
3+
<div class="width-12-12 width-12-12-m">
4+
{{ content }}
5+
</div>
6+
</div>
7+
</div>

‎_includes/usagepolicy.html

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<div class="full-width-bg component" xmlns="http://www.w3.org/1999/html">
2+
<div class="grid-wrapper">
3+
<div class="width-12-12 width-12-12-m">
4+
<p>This page contains the policy for the Red Hat sponsored anonymous data collection. See <a href="/usage">Usage</a> page for details.</a></p>
5+
<p class="intropara">In connection with your use of this Red Hat offering, Red Hat may collect telemetry data about your use of the software. This data allows Red Hat and community extension writers to understand how the software is being used and to improve Red Hat offerings and support, including identifying, troubleshooting, and responding to issues that impact users. The data may be shared internally within Red Hat to improve the user experience.</p>
6+
<H3>What information does Red Hat collect?</H3>
7+
<p>Tools within the software monitor various metrics and this information is transmitted to Red Hat. Metrics include the following information such as:</p>
8+
<ul>
9+
<li>Usage information about components, features and extensions.</li>
10+
<li>The number and nature of errors that occur during development.</li>
11+
<li>Quarkus version</li>
12+
<li>Java version, vendor</li>
13+
<li>Build tool used</li>
14+
<li>Build duration</li>
15+
<li>List of extensions and their versions</li>
16+
<li>Timezone</li>
17+
<li>CI system name, if available</li>
18+
<li>If it's built with kubernetes</li>
19+
</ul>
20+
<H3>Personal Data</H3>
21+
<p>Red Hat does not intend to collect personal information. To the extent that any telemetry data constitutes personal data, please refer to the <a href="https://www.redhat.com/en/about/privacy-policy" target="_blank">Red Hat Privacy Statement</a> for more information about Red Hat’s privacy practices.</p>
22+
<H3>Retention</H3>
23+
<p>Red Hat retains and stores telemetry data only for as long as it’s needed for the purposes described above or as otherwise required or permitted by law.</p>
24+
<H3>Data Security</H3>
25+
<p>Red Hat employs technical and organizational measures designed to protect the telemetry data.</p>
26+
<H3>Data Sharing</H3>
27+
<p>Only personnel with a valid business justification are permitted access to telemetry data. Red Hat may share telemetry data in an aggregated form that does not identify users.</p>
28+
<H3>Third Party Service Providers</H3>
29+
<p>Red Hat may engage certain service providers to assist in the collection, storage, and visualization of the telemetry data.</p>
30+
</div>
31+
</div>
32+
</div>

‎_layouts/usage.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: base
3+
---
4+
5+
{% include title-band.html %}
6+
7+
{% include usage.html %}

‎_layouts/usagepolicy.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
layout: base
3+
---
4+
5+
{% include title-band.html %}
6+
7+
{% include usagepolicy.html %}

‎assets/images/usage-prompt-arrows.png

53.6 KB
Loading

‎assets/images/usage-prompt.png

17.4 KB
Loading

‎usage.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
layout: usage
3+
title: Quarkus Usage Analytics
4+
subtitle: Help us make Quarkus even better, anonymously.
5+
permalink: /usage/
6+
---
7+
8+
## Why does Quarkus want to gather usage analytics?
9+
10+
Usage analytics (telemetry collection) is invaluable for the Quarkus team and contributors to gauge which operating systems, java version, build systems, extensions and more are used. This service is provided by Red Hat and the details can be found on [usage policy](/usage/policy) page.
11+
12+
## How will this work?
13+
14+
In order to get this information, beginning in Quarkus 3.2, when you run Quarkus the first time in dev mode (`quarkus dev`, `mvn quarkus:dev`, etc.) you get asked if you agree to contribute anonymous build data to the Quarkus community.
15+
16+
![/assets/images/usage-prompt-arrows.png](/assets/images/usage-prompt-arrows.png)
17+
18+
By answering **"Yes"**, when you perform a quarkus build, anonymized data is sent to gather usage statistics on how Quarkus is being used and adopted.
19+
20+
However if you anser **"No"**, then no usage data is sent and you will not be asked again.
21+
22+
We will share what is learned from these anonymous usage data and plan on integrate things like usage and adoption into sites like [extensions.quarkus.io](extensions.quarkus.io) and [code.quarkus.io](code.quarkus.io).
23+
24+
## How can I enable and disable ?
25+
26+
Build time analytics is not active by default. If you have opted in and would like to disable build time analytics or would like to later enable collection, you can do so in two ways:
27+
28+
### Set Globally
29+
30+
You can configure the global settings by editing the `com.redhat.devtools.quarkus.localconfig` file in the `.redhat` folder of your user’s home directory.
31+
32+
#### To active collection:
33+
34+
```
35+
{"active":true}
36+
```
37+
#### To de-active collection:
38+
39+
```
40+
{"active":false}
41+
```
42+
43+
### Set Per Project
44+
45+
You can set this by project using the system property `quarkus.analytics.disabled=true`
46+
47+
Example using maven:
48+
49+
```
50+
mvn clean install -Dquarkus.analytics.disabled=true
51+
```
52+
53+
Similarly, you can set it to `quarkus.analytics.disabled=true` if you want to enable it for a single run.

‎usage_policy.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: usagepolicy
3+
title: Telemetry Data Collection Notice
4+
subtitle:
5+
permalink: /usage/policy
6+
---
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+

0 commit comments

Comments
 (0)