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
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
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
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
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
a3e95cbeb1
Merge branch 'master' into m16/ping-uploading
2020-05-11 13:54:25 +02: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
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
18ee045487
1606837: Add spellchecking to docs ( #613 )
...
* Include Rust Cookbook's upstream spell-checking script
* Add local modifications to the spellcheck.sh script
* Integrate the spellchecking script
* Spelling corrections and custom dictionary
* Fix permissions
* Use Debian sid for spell-checking
* Add documentation about writing documentation
* HOWTOs -> Howtos
* Add link to other docs
* eg. -> e.g.
* Document the scope of the documentation.
2020-01-07 20:53:57 +05:30
Jan-Erik Rediger
d445ca998f
Add note about login requirement
2019-12-17 15:05:45 +01:00
Jan-Erik Rediger
7fb710463f
Use a relative link
...
mdbook doesn't play nice with absolute links
2019-12-17 15:02:27 +01:00
Jan-Erik Rediger
48a14f3f73
Document debug pings and the HTTP header
...
[doc only]
2019-12-17 11:30:45 +01:00
Jan-Erik Rediger
cc4bc7952c
Rename `deletion_request` ping to `deletion-request` ping
2019-12-13 11:50:30 +01:00
Jan-Erik Rediger
a29cf80cba
Use all-pings everywhere
2019-12-13 11:42:45 +01:00
Jan-Erik Rediger
0ca9d0d1cb
Document more clearly why a second directory is needed
2019-11-28 13:01:39 +01:00
Jan-Erik Rediger
b8ebdcb1cd
Write the deletion ping into a separate directory
2019-11-28 13:01:39 +01:00
Michael Droettboom
8b511a346a
Document all the Python things ( #491 )
...
* Document all the Python things
* Address low-hanging fruit comments in the PR
* Update test fixture instructions
* Clarify events ping
* Typo
* Fix typo
* Add link to other docs.
* Add note about Python data directory
* Update docs/user/testing-metrics.md
Co-Authored-By: Raphael Pierzina <raphael@hackebrot.de>
2019-11-20 13:11:31 -05:00
Michael Droettboom
d2e73e3267
[doc only] 1583511: Document the directory structure
2019-10-14 10:55:19 +02:00
Jan-Erik Rediger
ae5147f6bc
Test snapshotting of sparse histogram and fix documentation accordingly
2019-08-26 11:47:33 -07:00
Michael Droettboom
39ae10e31b
Address comments in PR
2019-08-22 15:19:01 -04:00
Michael Droettboom
864aa9a239
[doc only] Document memory distribution metric type ( #243 )
...
* [doc only] Document memory distribution metric type
* Fix copy-pasta
* Better describe the filling in of missing values in payloads
* Address comments in the PR
* Update docs/user/metrics/memory_distribution.md
Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
2019-08-14 10:12:53 -04:00
Michael Droettboom
02c35b9a2b
[doc only] 1571744: Document the custom distribution type ( #241 )
...
Fix issues mentioned in the PR
Change datatypes
2019-08-12 12:32:41 -04:00
Michael Droettboom
a53f12bb6f
[doc only] 1564989: Document functional timing distributions ( #240 )
2019-08-12 11:52:15 -04:00
Jan-Erik Rediger
30c75eb47d
We removed labeled timespans
...
[doc only]
2019-08-09 14:49:45 +02:00
Jan-Erik Rediger
d3d00169c7
1569765: Add "all_pings" to handle metrics that are sent on all… ( #206 )
...
1569765: Add "all_pings" to handle metrics that are sent on all pings
2019-08-05 10:11:55 +02:00
Michael Droettboom
640319a548
Add docs about the special ping name.
2019-07-31 10:48:44 -04:00
Jan-Erik Rediger
82bc8b7152
Bug 1564486 - Remove labeled timespans docs
...
[doc only]
2019-07-29 15:35:03 +02:00
Michael Droettboom
71f4f09e18
[doc only] Reformat the event payload description
2019-07-22 14:01:48 -04:00
Jan-Erik Rediger
f41278d283
Make the example a subsection
2019-07-19 10:30:41 +02:00
Jan-Erik Rediger
252038848a
Document payload of the missing metric types
...
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
2019-07-19 10:30:41 +02:00
Jan-Erik Rediger
5e008ed409
Document timespan & timing distribution payload format
2019-07-19 10:30:41 +02:00
Michael Droettboom
2cd6ea5c49
Link to event metrics docs
2019-07-18 09:51:49 -04:00
Michael Droettboom
d15ea146c5
Address comments in the PR
2019-07-17 16:11:16 -04:00
Michael Droettboom
238479f2c0
Update docs/dev/core/internal/payload.md
...
Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
2019-07-17 13:52:33 -04:00
Michael Droettboom
8db234a3f6
[doc only] 1557046: Document more about event payload
2019-07-17 10:43:40 -04:00