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

177 Коммитов

Автор SHA1 Сообщение Дата
Jan-Erik Rediger d9896b838f Docs: Call out how to find the TaskCluster tasks 2020-08-18 13:33:58 +02:00
Jan-Erik Rediger a573385b99 Update docs to use the right link-checker
[doc only]
2020-08-18 10:48:02 +02:00
Jan-Erik Rediger cdc87e1bd9 Document our CI setup
[doc only]
2020-08-18 10:48:02 +02:00
Michael Droettboom ccb6b163e5
Increase rate limiter to 15 pings per minute. (#1154)
* Increase rate limiter to 15 pings per minute

* Update docs.
2020-08-17 14:57:10 -04:00
Michael Droettboom 07f5210ae7
Bug 1657908: Use a better link checker in CI and fix links (#1146)
* Bug 1657908: Use a better link checker in CI and fix links

The Python-based linkchecker had buggy checking of anchors within pages,
which has caused a number of our internal doc links to break.

This replaces it with a different link checking tool, and then corrects
all of the errors it found.

* sudo make me a sandwich

* Combine lines
2020-08-10 08:15:49 -04:00
Michael Droettboom df96612f72
Bug 1655481, Bug 1655760: Add glean_parser version update script (#1116)
* Bug 1655481, Bug 1655760: Add glean_parser version update script

Also, check the glean_parser version at runtime from the Python bindings.

* pythonlint

* Add docs

* Add __init__.py

* mypy fix
2020-08-03 18:51:34 -04:00
Jan-Erik Rediger 36753eb2a4 CI: Don't run swiftformat
[doc only]
2020-08-03 12:00:03 +02:00
Michael Droettboom 388f78be19
1641148: Integrate Python and Rust logging (#1052)
* 1641148: Integrate Python and Rust logging

This works by setting up a named pipe between Python and Rust logging.

This requires adding another thread to the Python side to read from the log.
The overhead of that *could* be problematic.

I have no idea if this approach will work on Windows.

This at least *does* work -- any callback-based approach has been ruled
out due to limitations of CFFI or the need to go to a compiling-against-
a-specific-version-of-Python approach (see details in bug).

* hangle -> handle

* Rename and better document function
2020-07-29 14:22:23 -04:00
Beatriz Rizental b623b9779f
Fix title of JWE payload on the Glean Book (#1094)
[doc only]
2020-07-23 18:15:23 +02:00
Beatriz Rizental ee5039301a
Bug 1650787 - Add docs about JWE metric type (#1087) 2020-07-22 11:00:58 +02:00
Alessio Placitelli f9508598c3 Add the high level design docs for the upload module
This is a braindump of the desired architecture for the
upload modules implemented in the language bindings, that
directly interact with the lower level upload module in
glean-core.
2020-07-14 12:53:11 +02:00
Alessio Placitelli d82a70831d
Apply suggestions from code review
Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
2020-06-25 15:52:45 +02:00
Alessio Placitelli 4dc48a31e0 Create skeleton documentation for the C# language bindings 2020-06-25 14:26:16 +02:00
Jan-Erik Rediger 35f1474be1 Remove the step about asking releaseduty for help 2020-06-24 15:46:03 +02:00
Michael Droettboom 1d747dce7e
🐃✁: Remove support for Python 3.5 (#987)
* 🐃✁: Remove support for Python 3.5

* Fix black version

* Fix tests
2020-06-23 15:24:07 -04:00
brizental f024d16c26 Describe the rate limiting on the glean book 2020-06-23 13:40:21 +02:00
Jan-Erik Rediger 91d92ad6ce Use new default branch in documentation 2020-06-09 10:04:30 +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 4366b0384d Update the internal docs 2020-05-19 12:42:47 +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
Jan-Erik Rediger a3e95cbeb1 Merge branch 'master' into m16/ping-uploading 2020-05-11 13:54:25 +02: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 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
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 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
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
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
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 e6528e2f38
Update Windows build FAQs 2020-03-20 11:34:04 +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
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
Michael Droettboom 8c4928093f [doc only] Prepare Python for its big debut 2020-03-11 14:46:33 -04:00
Michael Droettboom 9f1f6df3fb
Update the synchronous communication channel (#744) 2020-02-28 21:40:47 +05:30
Michael Droettboom baf34adf72
[doc only] Add brief note about Windows wheels (#722) 2020-02-20 18:53:09 +05:30
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
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
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