1561550 - Clean up Glean SDK docs to focus on the current a-c experience

Status: RESOLVED DUPLICATE of bug 1559133

(Data Platform and Tools :: Glean: SDK, defect, P3)

Description

[Georg Fritzsche [:gfritzsche]]

We changed the android-components Glean SDK README to point to the Glean SDK book.

The android-components version is the one that is currently actively in use by engineering/product/..., so we should change the docs to primarily focus on supporting that project.

This means that the docs should call out the behavior of the a-c library first... and only add the glean-core behavior as clearly marked side-notes.

Comment 1

[Georg Fritzsche [:gfritzsche]]

E.g. on the landing page:

The Glean SDK is a work-in-progress to transform the concepts behind the Glean SDK into a cross-platform library based on a low-level Rust library and the necessary platform integrations for Android and iOS (and beyond...).

Note: The cross-platform Glean SDK project is in development. It's not finished, and not used. Some of this documentation refers to features that were implemented in an earlier Android-specific version of the Glean SDK, but are not yet implemented in this version.

That is not what i expect to see for coming from the android-components README.
We should talk about the a-c library and then mention the glean-core parts as a side-note.
We can change that back later after we put glean-core into production by replacing the a-c version with glean-core, but currently glean-core is just an internal project with no users outside of our team.

Comment 2

[Georg Fritzsche [:gfritzsche]]

See also:

• Adding Glean to your project - Usage.
• Testing, currently written from the glean-core perspective.
• Ditto for Setup build environment.
• Ditto for Contributing.
• Rust component - call this out as not relevant to the current a-c project.
• Ditto for FFI.

Maybe most of these could have the a-c way documented in the current page, then have a subpage for the glean-core way?

Side-notes:

• The formatting for the extra keys in debugging is broken.

Comment 3

[Alessio Placitelli [:Dexter]]

Hey Mike, this looks related to the other doc changes you're taking on. Is this a duplicate?

Comment 4

[Michael Droettboom [:mdroettboom]]

Yeah, I think this is largely a dupe of 1559133, though there are few additional details noted here. I'll take this and keep it open for now so those details don't get lost.