1673371 - Provide Documentation for FOG Rust APIs in-tree

Status: RESOLVED FIXED

(Toolkit :: Telemetry, task, P1)

Description

[Chris H-C :chutten|PTO (back Jan 5)]

Though our Rust Generic Metrics API might look a lot like the one documented in the Book of Glean it might evolve at a different speed and have some FOG-specific magic involved that our consumers will need to be aware of.

Also, they might not find the Book of Glean docs and instead wonder why they can't find Rust API docs in-tree with the C++ and JS API docs.

We can try to copy the look of the Book of Glean's API docs, but I don't know whether a tab-like display is possible given the current set of Sphinx plugins so we may be limited to non-interactive or table-based UI.

Yes, this will look like duplication. Sorry about that. But be sure to include specifics like:

• IPC caveats
• FOG-specific calls-to-action to improve the docs, improve the APIs

Comment 1

[Chris H-C :chutten|PTO (back Jan 5)]

Jan-Erik and I have chatted about a plan to turn the Glean SDK docs into their own crate that can be vendored. In the mean time we can pursue a strategy of documenting the APIs in the Book of Glean and just point people to it with linked hypertext.

Comment 2

[Chris H-C :chutten|PTO (back Jan 5)]

Attachment: Bug 1673371 - Direct FOG users to the Book of Glean for API docs r?janerik!

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/0ee3c513b2dc
Direct FOG users to the Book of Glean for API docs r=janerik

Comment 4

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/0ee3c513b2dc