Граф коммитов

639 Коммитов

Автор SHA1 Сообщение Дата
Jan-Erik Rediger 8958b73f33 Counter: Explicitly call out 0 as invalid
[doc only]
2020-05-27 14:49:01 +02:00
Alessio Placitelli 0da993a0db
Fix the docs for `RUST_LOG` verbose logging
The documented value doesn't work for me, locally. This works and matches what we advertise for the android bindings.
2020-05-25 14:29:47 +02:00
Alessio Placitelli cfdb3b2fe9
Document the max number of keys for `extra_keys` 2020-05-21 16:00:26 +02:00
Travis Long c8bb6ebf7a Reword note about iOS extensions 2020-05-21 07:49:03 -05:00
Travis Long 94e4722bbb Bug 1637987 - Document the limitations of using Glean with iOS application extensions 2020-05-21 07:49:03 -05:00
Chris H-C 6960ef5b1e
Remove `ping_type` from `ping_info` docs
It was removed in bug 1609149
2020-05-19 17:07:24 -04:00
Alessio Placitelli 4366b0384d Update the internal docs 2020-05-19 12:42:47 +02:00
Jan-Erik Rediger b77c4501fc Document the requirement to configure an HTTP client
[doc only]
2020-05-18 15:28:23 +02:00
Jan-Erik Rediger 16481e7ce9 Fix links to moved chapters
[doc only]
2020-05-18 14:35:40 +02:00
Jan-Erik Rediger 927d77c8ed Move a-c/fenix development tips into Android section 2020-05-18 13:25:40 +02:00
Jan-Erik Rediger 8501158411 Move SDK/NDK docs into Android section 2020-05-18 13:16:45 +02:00
Jan-Erik Rediger 7d61e7e257 Upgrade to NDK r21
This is the only officially supported version (at least for macOS, due
to signing).
There's no harm in updating, it is compatible will older SDKs.
2020-05-18 13:13:11 +02:00
Jan-Erik Rediger d9eec3bbff Streamline Android dev setup documentation 2020-05-18 13:07:39 +02:00
Piotr Zalewa bab6cd1cc3
Add keyword-only arguments: 'application_id' and 'application_version' to `reset_glean` method. 2020-05-14 12:58:24 +02:00
Jan-Erik Rediger bdc6fa8413
Merge pull request #875 from mozilla/time-never-sleeps 2020-05-13 09:23:49 +02:00
Jan-Erik Rediger 77ec4b241f Include note about sleep causing timer to pause on iOS
[doc only]
2020-05-12 12:56:14 +02:00
Jan-Erik Rediger bd2fc2e654 Include note about time spent in sleep on Android
[doc only]
2020-05-12 12:56:12 +02:00
Jan-Erik Rediger baad9eb184 Adjust notes about geckoview-only metric types
[doc only]
2020-05-12 12:56:10 +02:00
Jan-Erik Rediger 8592dd55c8 Fix Java API examples to be valid Java
[doc only]
2020-05-12 12:56:08 +02:00
Jan-Erik Rediger d6b2db1465 Note about ignoring .venv in an Xcode project 2020-05-12 10:54:36 +02:00
Michael Droettboom 5ce99d1bbc
[doc only] Bug 1626574: Add info about generating docs for Python (#867)
* [doc only] Bug 1626574: Add info about generating docs for Python

* Update docs/user/adding-glean-to-your-project.md

* Add additional context based on PR feedback

* Add note about including Glean docs in the project documentation

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
2020-05-11 16:58:04 -04:00
Jan-Erik Rediger a3e95cbeb1 Merge branch 'master' into m16/ping-uploading 2020-05-11 13:54:25 +02:00
Jan-Erik Rediger 53ee769ee9 Add missing license headers
[doc only]
2020-05-11 13:52:38 +02:00
Alessio Placitelli 8fe064134f
Merge pull request #860 from wlach/patch-5
Suggest needinfo'ing mreid when filing the bug to add a project to the pipeline
2020-05-08 17:58:10 +02:00
Chris H-C 98262795eb Update docs/appendix/twig.md
Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
2020-05-08 11:55:44 -04:00
Chris H-C 09b8a1f223 Add wlach's most recent TWiG
[doc only]
2020-05-08 11:55:44 -04:00
Michael Droettboom 366478c35c
Bug 1630997: Control min and max values in timing distribution (#850) 2020-05-07 11:43:04 -04:00
William Lachance 3f76eeffcb
Suggest needinfo'ing mreid when filing the bug to add a project to the pipeline
My preference would be to simply do this as part of the template, but that does not seem to be
possible (bug flags seem not to be remembered as part of the bookmarkable template)
2020-05-06 10:45:51 -04:00
Michael Droettboom bc8c697a9d
Upgrade glean_parser to 1.20.1 (#827)
* Upgrade glean_parser to 1.20.0

* spellcheck

* Fix sample app metrics.yaml

* Upgrade to glean_parser 1.20.1

* Fix syntax

* iso8601 only needed by earlier Pythons

* Upgrade to 1.20.2

* Handle iso8601 as an optional dependency

* spellcheck

* Fix up CHANGELOG
2020-05-04 12:21:43 -04:00
Jan-Erik Rediger 3e6b22a114 Add new TWiG
[doc only]
2020-05-04 17:51:16 +02:00
Michael Droettboom 5e36bbfd70
[doc only] 1615672: Elaborate on why custom pings are useful (#836)
* [doc only] 1615672: Elaborate on why custom pings are useful

* Add concrete example in all places
2020-04-29 08:10:07 -04:00
Jan-Erik Rediger 99812c9c88 Use newer Android build tools on CI
Should now be the same version as TaskCluster
2020-04-28 14:41:41 +02:00
Jan-Erik Rediger c63c1633b4 Document where SDK and NDK versions are defined and used 2020-04-28 14:40:58 +02:00
Jan-Erik Rediger 53238e1088 List internal topics in overview
[doc only]
2020-04-28 14:28:14 +02:00
Jan-Erik Rediger 613957b404
Merge pull request #847 from mdboom/rephrase-note-in-counter
[doc only]
2020-04-28 13:35:55 +02:00
Michael Droettboom 3c65a0ae98
Update twig.md 2020-04-27 15:54:55 -04:00
Travis Long ef53796238 Shorten example to address change request 2020-04-27 12:39:17 -05:00
Travis Long a61996adbf Bug 1632237 - Document how to send secondary ids in deletion request pings 2020-04-27 12:39:17 -05:00
Michael Droettboom d0eccc95db [doc only] Bug 1632072: Rephrase note on counter metrics 2020-04-27 11:26:23 -04:00
William Lachance ef58b499ba
Bug 1632645 - Explicitly note caveat about pyinstaller (#843)
* Bug 1632645 - Explicitly note caveat about pyinstaller

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: Michael Droettboom <mdboom@gmail.com>

Co-authored-by: Michael Droettboom <mdboom@gmail.com>
2020-04-24 15:43:22 -04:00
Michael Droettboom e3b223a4cd
[doc only] Remove mention of multiprocessing (#838)
This should have been updated in #819
2020-04-22 21:54:02 -04:00
Chris H-C 8520d2de98 Warn prospective Rust consumers
Do as we say, not as we do : )
2020-04-22 10:09:08 -04:00
Jan-Erik Rediger b2348dd4df Avoid "wrapper" naming
[doc only]
2020-04-21 14:15:50 +02:00
Jan-Erik Rediger caf3d85d74 Use language tabs for the different APIs
[doc only]
2020-04-21 14:15:48 +02:00
Jan-Erik Rediger 35375ac08a
Apply suggestions from code review
[doc only]

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
Co-Authored-By: Chris H-C <chutten@users.noreply.github.com>
2020-04-21 13:45:54 +02:00
Jan-Erik Rediger cb524be8f5 Document new upload mechanism
Most of the docs end up being on the code itself, with the book chapter
giving a brief overview.

[doc only]
2020-04-20 15:06:39 +02:00
Jan-Erik Rediger 880259ab79 Add mermaid support and start using mdbook-dtmo on CI
mdbook-dtmo is a Mozilla-owned mdbook reimplementation,
containing additional preprocessors.

[doc only]
2020-04-20 15:06:26 +02:00
Jan-Erik Rediger 23565d932d Update FFI docs
[doc only]
2020-04-20 15:06:26 +02:00
Jan-Erik Rediger 1cb9eeb1c2 Lay out current practices for Glean
[doc only]
2020-04-20 15:02:31 +02:00
Jan-Erik Rediger 1f0d4bef2b Regenerate docs
[doc only]
2020-04-17 15:12:37 +02:00
Travis Long 9a5f3511f8 Bug 1609251 - Rename "ping-uuid" to "document_id" for clarity 2020-04-17 07:42:05 -05:00
Chris H-C f1030526d7 Adding latest TWiG
[doc only]
2020-04-15 12:09:51 -04:00
Michael Droettboom 98a59bcb53
[doc only] Comment / doc improvements for foreground baseline pings (#823)
Address the comments in #807.
2020-04-14 10:44:13 -04:00
Michael Droettboom c070eca241
Bug 1627286: Add a baseline ping on foreground (#807)
* Bug 1627286: Add a baseline ping on foreground

* Update ping timings docs

* Address comments in PR

* Fix CHANGELOG

* Add iOS foreground baseline ping and tests

* Update generated docs

Co-authored-by: Travis Long <tlong@mozilla.com>
2020-04-14 10:03:06 -04:00
Michael Droettboom cab2666f41
[doc only] Bug 1600946: Document how to control logging (#821)
The bug proposes integrating the logging level control between Python and Rust,
but I think this has minimal benefit for the amount of complexity.

This just documents that there are two sources of log messages, how to control
them and where to get more info if you need to do something more sophisticated.
2020-04-14 10:34:23 +02:00
Alessio Placitelli a1992788cd
Mark `reason` as optional like the other fields (#812) 2020-04-08 13:47:35 -04:00
Chris H-C 5935b4bb2c
Document that client_info.locale is optional
[doc only]
2020-04-07 10:21:56 -04:00
Michael Droettboom fd8f7719bf
Bug 1626086: Wait for tasks to complete before shutting down (#798)
* Bug 1626086: Wait for tasks to complete before shutting down

* lint

* Add comment

* Add documentation about Python parallelism

* Do ping uploading in a separate process

* Fix test on Windows

* Refactor to reduce duplication

* Make multiprocessing optional

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: William Lachance <wrlach@gmail.com>

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: William Lachance <wrlach@gmail.com>

* Make it clear in the CHANGELOG that multiprocessing is optional

* Rename methods

* spellcheck

Co-authored-by: William Lachance <wrlach@gmail.com>
2020-04-06 11:32:32 -04:00
Jan-Erik Rediger 103ca861a1 Bug 1626969 - Call out that locale is determined once at initialization 2020-04-03 11:23:16 +02:00
Jan-Erik Rediger da78263082 Link to definition of unknown identifiers 2020-04-03 11:17:04 +02:00
Michael Droettboom b28f9fa6d7
[doc only] Illustrate ping schedules and various timing-related metrics (#755)
* [doc only] Illustrate ping schedules and various timing-related metrics

* [doc only] linkcheck

* Apply suggestions from code review

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* [doc only] Clarify things about submission_timestamp

* Short summaries on built-in pings.

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
2020-04-01 08:36:05 -04:00
Jan-Erik Rediger 974474b2f6
Merge pull request #795 from mozilla/optional-hardware
Bug 1625207 - device manufacturer & model are now optional
2020-04-01 10:52:44 +02:00
Michael Droettboom a7fb051973
bug 1615675: Document known telemetry antipatterns (#796)
* [doc only] bug 1615675: Document known telemetry antipatterns

A lot of the issues mentioned in the bug were addressed by previous
documentation work, but this addresses all of the remaining things there.

* Address PR comments
2020-03-31 16:57:41 -04:00
Travis Long 499ab23a29 Bug 1623506 - Clarify documentation that pings will not be logged until submitted 2020-03-31 15:55:14 -05:00
Jan-Erik Rediger 36bfeae762 Bug 1625207 - device manufacturer & model are now optional 2020-03-31 16:25:24 +02:00
Michael Droettboom 83aba44fd1
Developer convenience: Use different venv dir for each Python version (#787)
* Developer convenience: Use different venv dir for each Python version

* Fix CI

* Update docs/dev/python/setting-up-python-build-environment.md

Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
2020-03-27 10:40:58 -04:00
Michael Droettboom b11564f0e7
1604191: Python: run Glean work on a worker thread (#783)
* 1604191: Python: run Glean work on a worker thread

* Implement tests

* Add another test

* Apply suggestions from code review

Co-Authored-By: William Lachance <wrlach@gmail.com>

* Convert docstring to comment

* Add docs about parallelism

* lint

* Remove unnecessary layer of indirection

Co-authored-by: William Lachance <wrlach@gmail.com>
2020-03-27 09:18:25 -04:00
Alessio Placitelli f2e1a20474
Merge pull request #785 from Dexterp37/user_lifetime_docs
Warn against the use of `user` lifetime in the docs [doc only]
2020-03-27 14:07:24 +01:00
Alessio Placitelli 8d33f726c6
Use the proper name for the client id
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
2020-03-27 13:48:07 +01:00
Alessio Placitelli 12704a2638 Warn against the use of `user` lifetime in the docs 2020-03-27 10:54:36 +01:00
Jan-Erik Rediger 25bf9ea0b2 Remove all finalizers from metric type implementations in Kotlin
They cause us more trouble than they are worth.
This is safe.
The only thing we did do in finalizers is cleaning up the allocated
object on the native Rust side.
Without these we now potentially leak memory.
_But_ metric types were already only used for metrics, and those are
statics, so they live for the entire application runtime.
Once the application is done and exits the Glean library will also be
unloaded and thus all its data be deallocated.

The only place where we create metrics at runtime is in tests.
So we're now leaking those in tests, but that should be fine.

As a side note: Java 9 deprecates finalizers in the language, Android
itself doesn't support Java 9 (yet) and has its own implementation of it
anyway, but that's nonetheless a good hint that finalizers might not be
the best idea afterall.
2020-03-26 14:46:23 +01:00
Alessio Placitelli c475dbbec8
Merge pull request #780 from Dexterp37/doc_metric_type_swap
Document potential data loss when changing metric types
2020-03-26 14:27:35 +01:00
Alessio Placitelli abbff525fe Document that changing data types may cause data loss 2020-03-26 14:15:04 +01:00
Travis Long 2f342e7afc Update TWiG posts 2020-03-25 10:57:57 -05:00
Michael Droettboom 55bba00886
Python: Windows x86 support (#776)
* Python: Fixes and release for 32-bit Windows

This addresses the following bugs to make 32-bit Windows builds pass the
unit tests.

1622909: Release 32-bit wheels for Windows
1623335: Functional bucketing fixes
1623587: Unable to detect locale on Windows

Also relevant (but a follow-on) is:

1623307: Add Windows tests to CI

* More contexts

* Fix CircleCI config

* Fix non-Windows-x86 platforms

* Document about unknown locales

* Add documentation about FPU control

* Add comment about default locale

* Use FloatingPointContext correctly, and everywhere floating point is used

* Also update locale docs in metrics.yaml

* "C" -> "und"

* Spellcheck

* Document floating point context purpose
2020-03-24 10:17:22 -04:00
Michael Droettboom 1d9528e00a
Upgrade glean_parser to 1.19.0 (#772)
* Upgrade glean_parser to 1.19.0

* Spellcheck
2020-03-20 10:27:11 -04:00
Alessio Placitelli e6528e2f38
Update Windows build FAQs 2020-03-20 11:34:04 +01:00
Jan-Erik Rediger 27734f6291 iOS: Add missing `testGetNumRecordedErrors` methods for labeled metrics 2020-03-17 16:10:41 +01:00
Jan-Erik Rediger 131700f1bf
Merge pull request #770 from mdboom/ping-lifetime-clear
Fix metric lifetime timeline diagram
2020-03-17 10:33:17 +01:00
Jan-Erik Rediger 8b45281bed
Update docs/dev/core/internal/implementations.md
[doc only]

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
2020-03-16 13:59:05 +01:00
Michael Droettboom 44751c1346 Fix metric lifetime timeline diagram 2020-03-16 08:49:24 -04:00
Jan-Erik Rediger 28c05f7aef Add a table of all different implementations and projects of the Glean SDK
[doc only]
2020-03-16 12:22:27 +01:00
Jan-Erik Rediger 26d7dd3278
Merge pull request #766 from mdboom/python-labeled-misc
Python: Add remaining labeled metric types
2020-03-12 09:36:55 +01:00
Michael Droettboom 8c4928093f [doc only] Prepare Python for its big debut 2020-03-11 14:46:33 -04:00
Michael Droettboom 6ad5cb1be6 Address comments from PR 2020-03-11 13:06:09 -04:00
Michael Droettboom 1fa967e4e1 Add docs for labeled booleans 2020-03-11 13:01:25 -04:00
Michael Droettboom 059bd11b0a Python: Labeled boolean and labeled string metric type 2020-03-11 13:01:25 -04:00
Jan-Erik Rediger a30e58cebe
Merge pull request #765 from mdboom/python-string-list
Python: Add string list metric
2020-03-11 10:34:54 +01:00
Jan-Erik Rediger 2fcfebe990
Add newest TWiG
[doc only]

Submitting on behalf of @mdboom
2020-03-10 14:27:39 +01:00
Michael Droettboom 2165221026 Python: Add string list metric 2020-03-09 13:36:31 -04:00
Michael Droettboom 8462cc1422
Python: Implement memory distribution metric type (#763)
* Python: Implement memory distribution metric type

* Add CHANGELOG
2020-03-09 13:02:49 -04:00
Michael Droettboom dca46baff4
Python: Implement timing distribution (#762)
* Python: Implement timing distribution

* Address feedback from PR

* Update comment to reflect fact that time_unit is used in multiple places

* Fix unit tests

* Apply suggestions from code review

Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
2020-03-09 08:53:55 -04:00
Michael Droettboom b82a646daf
Use "measurement window" rather than "ping lifetime" (#761) 2020-03-06 13:02:57 -05:00
Travis Long 53df507217 Fix typo and address change requests 2020-03-05 14:15:51 -06:00
Travis Long 6e215d6efd Bug 1594036: Document that `initialize` must always be called [doc-only] 2020-03-05 13:55:07 -06:00
Travis Long 972245b113
Fix typo 2020-03-05 13:25:14 -06:00
Travis Long fed1789d0c Update to use "language" for the tabs rather that "platform" 2020-03-05 13:03:37 -06:00
Travis Long ea0f3cca40 Bug 1620320: Add iOS-specific background state definition 2020-03-05 12:13:14 -06:00
Michael Droettboom 184c82d8ce
Documentation about choosing metric types (#750)
* [doc only] Documentation about choosing metric types

* Address Travis' comments

* [doc only] Address more comments from the PR

* [doc only] Additional detail about reusing metric names
2020-03-05 10:22:58 -05:00
Raphael Pierzina 1875b3acc0
Update Python SDK documentation for logging pings (#751)
* Update Python SDK documentation for logging pings

* Add example for setting the logging level for Glean in Python
2020-03-03 20:56:11 +05:30
Jan-Erik Rediger c65b0c5a36
Merge pull request #749 from brizental/1619274/timing-fn-fix
Fix timing function name in timing distribution doc
2020-03-03 10:06:32 +01:00
Beatriz Rizental 11db2e9f2c Fix timing function name in timing distribution doc
[doc only]
2020-03-02 17:53:07 -03:00
Michael Droettboom 9bec38421e
[doc only] Fix docs about using plugin, and use a-c linkage everywhere (#748)
* [doc only] Fix docs about using plugin, and use a-c linkage everywhere

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
2020-03-03 00:21:58 +05:30
Michael Droettboom b189d659ad
Add TWiG post (#745) 2020-02-29 03:44:52 +05:30
William Lachance a3e3fd2b5f
Better docs on setting a ping tag in python (#741)
* Better docs on setting a ping tag in python

* Update python.md

* Update per Mike's suggestion
2020-02-28 23:22:45 +05:30
Michael Droettboom 9f1f6df3fb
Update the synchronous communication channel (#744) 2020-02-28 21:40:47 +05:30
Alessio Placitelli 53f5308209
Merge pull request #716 from Dexterp37/app_lifetime_docs
Clarify the usage of 'lifetime: application' [doc only]
2020-02-28 15:44:56 +01:00
Alessio Placitelli 99314a8fa0 Clarify the usage of 'lifetime: application' 2020-02-28 10:28:12 +01:00
Michael Droettboom d50eb1d0e3 Python: Implement timespan metric type 2020-02-25 18:02:04 -05:00
Michael Droettboom 9bb3ebd4cd
Python: Implement Datetime metric type (#732)
* Python: Implement Datetime metric type

* Add CHANGELOG

* Spellcheck
2020-02-25 19:08:32 +05:30
Chris H-C 7f4d8b01a4 Add my TWiG 2020-02-21 14:37:13 -05:00
Michael Droettboom dd13864071
Python: Add boolean metric type (#731)
* Python: Import boolean metric type

* Add CHANGELOG

* pythonlint
2020-02-21 19:27:05 +05:30
Michael Droettboom 9654cf4231
Python: Make public, document and test the debugging features (#733) 2020-02-21 19:26:29 +05:30
Chris H-C 49e7f64f9c Add Alessio's TWiG from last week. 2020-02-20 11:10:01 -05:00
Michael Droettboom baf34adf72
[doc only] Add brief note about Windows wheels (#722) 2020-02-20 18:53:09 +05:30
Michael Droettboom 8891184afa
[doc only] 1610521: Document the timing and memory distribution function (#720) 2020-02-20 18:52:45 +05:30
Alessio Placitelli 390d10692d
Merge pull request #728 from mdboom/error-reporting-uses-labeled-metric
[doc only] Correctly show that error recording uses a labeled metric
2020-02-20 10:04:46 +01:00
Alessio Placitelli ac77743d9d
Merge pull request #725 from mdboom/fix-typo2
[doc only] Add a subject to sentence
2020-02-20 10:03:49 +01:00
Michael Droettboom 6c07a1d468
[doc only] Mention the preinit_tasks_overflow metric (#727)
...where we talk about overflowing the task queue
2020-02-20 03:56:46 +05:30
Michael Droettboom bbf9bc7ab4
[doc only] Document we have wheels for the 3 major desktop platforms (#724) 2020-02-20 03:56:25 +05:30
Michael Droettboom 95aca134ce
[doc only] Move 'following steps' right before steps (#726) 2020-02-20 03:55:51 +05:30
Michael Droettboom a7e2d71346 [doc only] Correctly show that error recording uses a labeled metric 2020-02-19 17:24:44 -05:00
Michael Droettboom 3c67a3b1b2 [doc only] Add a subject to sentence 2020-02-19 17:09:51 -05:00
Michael Droettboom b3f0b3cac8
Document adding a new metric type in Python (#721)
* [doc only] Document adding a new metric type in Python

* [doc only] Add more detail about details
2020-02-20 03:05:58 +05:30
Beatriz Rizental c24f6f62fd Update Java documentation to use new API
[doc only]
2020-02-17 12:35:32 +01:00
Michael Droettboom 3f1fca72ae
1608585: Fix labeled regex (#668)
* 1608585: Fix labeled regex

* Update docstring

* Update docs

* Add CHANGELOG

* spellcheck

* Move CHANGELOG entry
2020-02-14 22:20:16 +05:30
Michael Droettboom 268d303f6e
Upgrade to glean_parser v1.18.2 (#712)
* Upgrade to glean_parser v1.18.1

* Fix reason list formatting
2020-02-14 20:15:19 +05:30
Alessio Placitelli 1ec7a51c64
Merge pull request #702 from Dexterp37/fixup_glean_in_fenix_docs
Fix the instructions to test Glean in Fenix [docs only]
2020-02-13 17:43:12 +01:00
Alessio Placitelli 78a60333e6
Rephrase step 2.4 2020-02-13 17:33:24 +01:00
Alessio Placitelli 285b862a98
Merge pull request #682 from tdsmith/patch-1
Disambiguate device model
2020-02-13 10:03:38 +01:00
Michael Droettboom bb60016439
Add detail about updating Glean version in consumers (#708) 2020-02-13 03:01:55 +05:30
Alessio Placitelli c89f0e90da Fix the instructions to test Glean in Fenix 2020-02-12 15:31:11 +01:00
Alessio Placitelli 8a517223b8
Merge pull request #701 from Dexterp37/change_metrics_docs
Document the process for requesting new metric types [doc only]
2020-02-12 14:51:40 +01:00
Alessio Placitelli c1ab662a11 Document the process for requesting new metric types 2020-02-12 11:27:34 +01:00
Jan-Erik Rediger 8b529ae348 Remove `ping_type` from pings. 2020-02-12 11:05:16 +01:00
Alessio Placitelli d90c68d0fb Update 'baseline' ping docs 2020-02-11 16:14:10 +01:00
Michael Droettboom 2e3f59be19
1557048: Add reason codes to the metrics ping (#649)
* 1557048: Add reason codes to the metrics ping

This adds support for sending reason codes along with pings.  The reason codes
are defined as an enumeration in the pings.yaml file, and only these values
are allowed on specific pings.

Additionally, this builds on that to add reason codes to the metrics ping.

* Use short form for enums

* Suppress compiler warning

* swiftlint

* NoReasonCodes -> NoExtraKeys

* Fix descriptions
2020-02-11 20:40:10 +05:30
Jan-Erik Rediger 0219ffee95 Use consistent 24h clock in documentation
[doc only]
2020-02-07 14:24:22 +01:00
Jan-Erik Rediger 977a59bdfc Drop automated code coverage reports
Coverage reports by now are merely a noise, take extra CI time and we
ran into some problems before generating them.
This also allows us to drop the one usage of a "xlarge" instance on CircleCI.
2020-02-06 14:34:52 +01:00
Michael Droettboom 4ca9181fab [doc only] Indicate that markdown syntax can be used in description fields 2020-02-05 21:34:04 -05:00
Jan-Erik Rediger 98f3dd916a
Merge pull request #680 from mozilla/git-link
Add "open on github" link to docs
2020-02-04 16:57:56 +01:00
Jan-Erik Rediger 72f1612ca2 Use a single properly named CSS file
[doc only]
2020-02-04 10:17:22 +01:00
Jan-Erik Rediger 2433dc672e
Link new TWiG (#681)
[doc only]
2020-02-04 00:26:50 +05:30
Tim D. Smith 65f76c2f63
Disambiguate device model
"Device model" can mean different things on Android; clarify that this is `Build.MODEL` and not e.g. `Build.DEVICE`.
2020-02-03 10:47:27 -08:00
Jan-Erik Rediger 767ed6939b Use mdbook-open-on-gh to add a "open on gh" link to the book
[doc only]
2020-01-30 15:54:59 +01:00
Jan-Erik Rediger c40ff0d478 Make mdbook render a link to the repository
[doc only]
2020-01-30 11:49:16 +01:00
Michael Droettboom 1d7eabea5d
1608130: Document how to update android-components (#667)
* 1608130: Document how to update android-components

* Update spellcheck dictionary

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/dev/cut-a-new-release.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Link to a-c CHANGELOG

* Change numbering format

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
2020-01-25 00:12:57 +05:30
Michael Droettboom 66596904db
1611177: Document that uploadEnabled=false clears metrics (#674)
* 1611177: Document that uploadEnabled=false clears metrics

* Add Python update

* Address comments in the PR

* swiftformat
2020-01-25 00:11:47 +05:30
Alessio Placitelli 769971d62c
Fixup 'exfiltrated' 2020-01-24 15:13:32 +01:00
Alessio Placitelli ff24647b81
Mention historical data 2020-01-24 15:11:09 +01:00