Closed Bug 1657598 Opened 5 years ago Closed 5 years ago

[docs] Provide an integration checklist

Categories

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

Product:
Data Platform and Tools
Component:
Glean: SDK
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: mdroettboom, Assigned: mdroettboom)

Details

(Whiteboard: [docdays])

Attachments

(1 file)

Link to GitHub pull-request: https://github.com/mozilla/glean/pull/1137
42 bytes, text/x-github-pull-request
Details | Review

We have a lot of the details about integrating Glean into a product already. However, it would probably be useful to have a short and simple checklist for integration somewhere (linking out to the details), so it's clear exactly what an integration should entail. Something like:

  1. Integrate into your build,
  2. Make sure markdown docs are in your docs,
  3. Register with probe_scraper,
  4. Make sure there is a user-accessible way to disable telemetry
  5. Make sure telemetry is turned off during CI [the details of which are app specific]
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:m?][docdays]
Assignee: nobody → mdroettboom
Priority: P3 → P1
Whiteboard: [telemetry:glean-rs:m?][docdays] → [docdays]
Status: NEW → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: