1559133 - Make Glean book landing page less confusing

Status: RESOLVED FIXED

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

Description

[Alessio Placitelli [:Dexter]]

In bug 1557734 we removed docs from glean-ac and pointed that repo to glean-core docs, to avoid keeping docs in sync. However, the landing page is a bit confusing for people coming from glean-ac:

Glean is a modern approach for a mobile Telemetry library. It started out as an android-components library, written purely in Kotlin to be used on Android.

Glean is a work-in-progress to transform the concepts behind Glean 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 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 Glean, but are not yet implemented in this version.

We should:

• make sure that the docs do not mention or suggest things about glean-core, unless needed;
• make sure the landing page is consistent for both products;
• adjust the "file a bug" link?

Comment 1

[Alessio Placitelli [:Dexter]]

This should also include:

• removing all the "not implemented" notes;
• change the "Set up your dev environment" to be specific to Rust/glean-core (maybe adding a big note to the top?)

Comment 2

[Michael Droettboom [:mdroettboom]]

removing all the "not implemented" notes;

I think gfritschze already handled this.

Comment 3

[Michael Droettboom [:mdroettboom]]

Attachment: GitHub Pull Request