зеркало из https://github.com/mozilla/glean.git
b676cdf3cf
* [doc only] Documentation cleanup This is just a basic cleanup of things I found reading through the user documentation, mainly of the form: - Correcting the uses of "Glean" vs. "Glean SDK" - Updating a few facts that became out of date - Removing a little Python -> C# copy-pasta - Adding the missing new metric parameter `data_sensitivity` - Not linking out to glean_parser for the metric parameter docs (which have been duplicated in the Glean Book for some time). * [doc only] Address comments in the PR |
||
---|---|---|
.circleci | ||
.github | ||
bin | ||
build-scripts | ||
docs | ||
glean-core | ||
gradle/wrapper | ||
gradle-plugin | ||
samples | ||
taskcluster | ||
tools/analysis/ping-patterns | ||
xcconfig | ||
.buildconfig.yml | ||
.coveragerc | ||
.detekt.yml | ||
.dictionary | ||
.flake8 | ||
.flake8rc | ||
.gitignore | ||
.swiftformat | ||
.swiftlint.yml | ||
.taskcluster.yml | ||
.yamllint | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
Cargo.lock | ||
Cargo.toml | ||
Cartfile.private | ||
DEPENDENCIES.md | ||
LICENSE | ||
Makefile | ||
README.iOS.md | ||
README.md | ||
about.toml | ||
build.gradle | ||
deny.toml | ||
glean.1.schema.json | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
publish.gradle | ||
settings.gradle |
README.md
Glean SDK
Documentation
All documentation is available online:
The Glean SDK Book
Overview
Refer to the documentation for using and developing the Glean SDK.
For an overview of Glean beyond just the SDK, see the section in the Firefox data docs.
The code in this repository is organized as follows:
- ./glean-core/ contains the source for the low-level Rust library.
- ./glean-core/ffi contains the mapping into a C FFI.
- ./glean-core/android contains the Kotlin bindings for use by Android applications.
- ./glean-core/ios contains the Swift bindings for use by iOS applications.
- ./glean-core/python contains Python bindings.
Note: The Glean SDK requires at least Rust 1.41.0. Older versions are untested.
Contact
To contact us you can:
- Find us in the #glean channel on chat.mozilla.org.
- To report issues or request changes, file a bug in Bugzilla in Data Platform & Tools :: Glean: SDK.
- Send an email to glean-team@mozilla.com.
- The Glean Core team is: :dexter, :janerik, :mdroettboom, :travis_, :gfritzsche, :chutten, :brizental.
Credits
The Glean logo artwork was contributed by Diana Ciufo. It's licensed under MPL.
License
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/