1680020 - Document JS and C++ APIs in the Book

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, task, P1)

Description

[Chris H-C :chutten|PTO (back Oct 23)]

When we started implementing C++ and JS APIs (see trees rooted at bug 1642646 and bug 1662858) we didn't know where the API docs would live. So we documented the APIs inline in the source files, but omitted the sort of usage documentation that full language bindings get in the Book of Glean.

Now we've decided to document these APIs in the Book, so we can get to writing.

This bug is about adding a tab for C++ and a tab for JS to the metric type docs detailing how to use and test these metric types from C++ and JS. These tabs should contain notices that we only support these languages in Firefox Desktop (at time of writing) as part of Project FOG (throw in a link to here).

Comment 1

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/glean/pull/1400

Comment 2

[Chris H-C :chutten|PTO (back Oct 23)]

PR Merged.