sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Gradle: Document how to flip the value from default

Open bruno-garcia opened this issue 3 years ago • 1 comments

Core or SDK?

Platform/SDK

Which part? Which one?

src/platforms/android/common/gradle.mdx

Description

    // Enable auto-installation of Sentry components (sentry-android SDK and okhttp, timber and fragment integrations).
    // Default is enabled.
    // Only available v3.1.0 and above.
    autoInstallation {
      enabled = true

Suggested Solution

This is counter intuitive because if the feature is already enabled by default, it's best to be clear about it, and say:

If you do not want this feature, here is how you turn it off: `` autoInstallation { enabled = false


The reasoning being that for those skimming things, they might see enabled=true and copy that over, because they want to enable it. The only reason to copy paste this config, or to touch it (define it) is to turn it off, so the example is suboptimal 

For more context: https://github.com/getsentry/sentry-docs/pull/4829/files#r826963286

bruno-garcia avatar Mar 17 '22 00:03 bruno-garcia

The downside of it is that if people copy-paste that, everything would be disabled by default. That was the idea behind adding the default values.

marandaneto avatar Mar 30 '22 13:03 marandaneto

I think we're safe to close it, nobody complained about having problems with disabling SAGP features so far (except some specific cases like timber integration, but for that we have another issue).

romtsn avatar Oct 18 '23 17:10 romtsn