Skip to content

Commit

Permalink
Remove mentions of mozilla-mobile
Browse files Browse the repository at this point in the history
[doc only]
  • Loading branch information
badboy committed Jan 10, 2025
1 parent 015f77a commit 29e1722
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 27 deletions.
9 changes: 5 additions & 4 deletions docs/dev/cut-a-new-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The development & release process roughly follows the [GitFlow model](https://nv
* [Standard release](#standard-release)
* [Hotfix release for latest version](#hotfix-release-for-latest-version)
* [Hotfix release for previous version](#hotfix-release-for-previous-version)
* [Upgrading android-components to a new version of Glean](#upgrading-android-components-to-a-new-version-of-glean)
* [Upgrading mozilla-central to a new version of Glean](#upgrading-mozilla-central-to-a-new-version-of-glean)
* [Recovering from a failed automated release](#recovering-from-a-failed-automated-release)

## Published artifacts

Expand Down Expand Up @@ -203,10 +204,10 @@ If you need to release a hotfix for a previously released version (that is: not
* This might have merge conflicts with the `main` branch, which you need to fix before it is merged.
7. Once the above pull request lands, delete the support branch.
## Upgrading android-components to a new version of Glean
## Upgrading mozilla-central to a new version of Glean
On Android, Mozilla products consume the Glean SDK through its wrapper in [`android-components`](https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/).
The process of vendoring a new version of Glean in to Mozilla Central now handles the upgrade process for android-components and no manual updating is needed here.
Glean is integrated into Mozilla products in mozilla-central (Firefox Desktop, Firefox for Android, Focus for Android).
See [Updating the Glean SDK](https://firefox-source-docs.mozilla.org/toolkit/components/glean/dev/updating_sdk.html) on how to update the Glean SDK in mozilla-central.
## Recovering from a failed automated release
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ basic strategy for instrumenting an Android application with crash telemetry usi
**Note:** This is a _very_ simple example of instrumenting crashes using the Glean SDK. There will be challenges to
using this approach in a production application that should be considered. For instance, when an app crashes it can be in an
unknown state and may not be able to do things like upload data to a server. The recommended way of instrumenting crashes with
Android Components is called [lib-crash](https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/components/lib/crash), which takes into consideration things like multiple processes and persistence.
Android Components is called [lib-crash](https://searchfox.org/mozilla-central/source/mobile/android/android-components/components/lib/crash), which takes into consideration things like multiple processes and persistence.

## Before You Start

Expand Down
5 changes: 1 addition & 4 deletions docs/user/language-bindings/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,10 @@ The Glean Kotlin SDK is primarily used for integration with Android applications
It assumes a common interaction model for mobile applications.
It sends builtin pings at startup of the integrating application.

It is available standalone as `org.mozilla.telemetry:glean`
or via [Android Components][ac] as `org.mozilla.components:service-glean`
from the [Mozilla Maven instance][maven].
It is available standalone as `org.mozilla.telemetry:glean` from the [Mozilla Maven instance][maven].

The Kotlin SDK can also be used from Java.

[ac]: https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/
[maven]: https://maven.mozilla.org/?prefix=maven2

See [Android](android/) for more on integrating Glean on Android.
Expand Down
29 changes: 11 additions & 18 deletions docs/user/user/adding-glean-to-your-project/kotlin.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,20 @@ Each module that uses the Glean Kotlin SDK needs to specify it in its build file
Add this to your Gradle configuration:

```Groovy
implementation "org.mozilla.components:service-glean:{latest-version}"
implementation "org.mozilla.telemetry:glean:{latest-version}"
```

{{#include ../../../shared/blockquote-warning.html}}

##### Pick the correct version

> The `{latest-version}` placeholder in the above link should be replaced with the version of Android Components used by the project.
The Glean Kotlin SDK is released as part of [android-components](https://github.com/mozilla-mobile/firefox-android/tree/main/android-components/). Therefore, it follows android-components' versions.
The [android-components release page](https://github.com/mozilla-mobile/android-components/releases/) can be used to determine the latest version.

For example, if version *33.0.0* is used, then the include directive becomes:

```Groovy
implementation "org.mozilla.components:service-glean:33.0.0"
```
> The `{latest-version}` placeholder in the above link should be replaced with the [latest version of the Glean SDK](https://github.com/mozilla/glean/releases).
>
> For example, if version *63.0.0* is the latest version, then the include directive becomes:
>
> ```Groovy
> implementation "org.mozilla.telemetry:glean:63.0.0"
> ```
{{#include ../../../shared/blockquote-info.html}}
Expand Down Expand Up @@ -80,19 +77,15 @@ In order for the Glean Kotlin SDK to generate an API for your metrics, two Gradl

The Glean Gradle plugin is distributed through Mozilla's Maven, so we need to tell your build where to look for it by adding the following to the top of your `build.gradle`:

```
```Groovy
buildscript {
repositories {
// Include the next clause if you are tracking snapshots of android components
maven {
url "https://snapshots.maven.mozilla.org/maven2"
}
maven {
url "https://maven.mozilla.org/maven2"
}
dependencies {
classpath "org.mozilla.components:tooling-glean-gradle:{android-components-version}"
classpath "org.mozilla.telemetry:glean-gradle-plugin:{latest-version}"
}
}
}
Expand All @@ -102,7 +95,7 @@ buildscript {

##### Important

> As above, the `{android-components-version}` placeholder in the above link should be replaced with the version number of android components used in your project.
> As above, the `{latest-components-version}` placeholder in the above link should be replaced with the version number of the Glean SDK used in your project.
The JetBrains Python plugin is distributed in the Gradle plugin repository, so it can be included with:

Expand Down

0 comments on commit 29e1722

Please sign in to comment.