Skip to content

Commit 3c3ffac

Browse files
committed
Clarify usage.md a bit
1 parent 1d4dab3 commit 3c3ffac

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

usage.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ subtitle: Help us make Quarkus even better, anonymously.
55
permalink: /usage/
66
---
77

8-
## Why does Quarkus want to gather usage analytics?
8+
## Why does Quarkus want to gather usage analytics?
99

1010
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.
1111

1212
## How will this work?
1313

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.
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.
1515

1616
![/assets/images/usage-prompt-arrows.png](/assets/images/usage-prompt-arrows.png)
1717

@@ -25,29 +25,31 @@ We will share what is learned from these anonymous usage data and plan on integr
2525

2626
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:
2727

28-
### Set Globally
28+
### Set globally
2929

30-
You can configure the global settings by editing the `io.quarkus.analytics.localconfig` file in the `.redhat` folder of your user’s home directory.
30+
You can manually configure the global settings by editing the `io.quarkus.analytics.localconfig` file in the `.redhat` folder of your user’s home directory.
3131

32-
#### To active collection:
32+
#### To enable analytics collection
3333

3434
```
3535
{"disabled":false}
3636
```
37-
#### To de-active collection:
37+
38+
#### To disable analytics collection
3839

3940
```
4041
{"disabled":true}
4142
```
4243

43-
### Set Per Project
44+
### Set per build
45+
46+
You can configure it for a given build by using the `quarkus.analytics.disabled` system property:
4447

45-
You can set this by project using the system property `quarkus.analytics.disabled=true`
48+
- To disable analytics collection, set `quarkus.analytics.disabled` to `true`.
49+
- To enable analytics collection, set `quarkus.analytics.disabled` to `false`.
4650

47-
Example using maven:
51+
For instance, when using Maven, you can disable analytics collection for a single run with:
4852

4953
```
50-
mvn clean install -Dquarkus.analytics.disabled=true
54+
./mvnw clean install -Dquarkus.analytics.disabled=true
5155
```
52-
53-
Similarly, you can set it to `quarkus.analytics.disabled=false` if you want to enable it for a single run.

0 commit comments

Comments
 (0)