Open Bug 1751996 (fxms-docs) Opened 2 years ago Updated 1 month ago

[meta] Messaging System maintainable documentation

Categories

(Firefox :: Messaging System, task, P1)

task

Tracking

()

People

(Reporter: pdahiya, Unassigned)

References

(Depends on 12 open bugs, Blocks 1 open bug)

Details

(Keywords: meta)

Scope of this bug is to track discussion and implementation of a maintainable Messaging System documentation on experimenter https://experimenter.info/messaging/desktop-messaging-surfaces/ that doesn't run out of date.

Audience of this documentation:

  1. Product
  2. QA
  3. UX
  4. DS
  5. Messaging system customers

Purpose of this documentation:

  1. Easily maintainable
  2. Highlights available messaging surface
  3. FAQs of messaging system customers

Existing documents created and maintained by audiences
User engagement surfaces DS perspective - https://mana.mozilla.org/wiki/display/DATA/User+Engagement+Surfaces

Messaging surfaces UX perspective - https://mana.mozilla.org/wiki/display/FIREFOX/Repository+of+current+UX
https://projects.invisionapp.com/share/JEQW8IBZHUV#/screens/353126959
https://miro.com/app/board/o9J_ljMvwmg=/

Message collision - infrastructure work - product perspective:
https://docs.google.com/document/d/1NeSGYe8xPx7J6t4OWnlx2Qa7B__7iIMMSor1yeNoCAg/edit

Messaging system - Engineering perspective
https://firefox-source-docs.mozilla.org/toolkit/components/messaging-system/docs/index.html
https://docs.google.com/document/d/1wEQEXjcSZGE8VP5qLmfS9MRmbbLY02R_4Z8-TL8OG_I/edit#
https://docs.google.com/document/d/1o8W-gEkgw2GC7KFSfQRkKfWzNJg1-6fpkVPrYmmot4Y/edit

Messaging System - Content perspective
https://docs.google.com/document/d/1nhkYbNUxguj1u_NnZl_D-Hq9uOw5obrIFewUvFnckDo/edit#heading=h.rjjti5jbcg61

No longer blocks: ms-deployments
Priority: -- → P2
Depends on: 1754089
Assignee: nobody → mviar

The PR above was accepted and Messaging System is now a part of Experimenter Docs.

Second PR to add available targeting link: https://github.com/mozilla/experimenter-docs/pull/177

We may want to include sections from this draft overview of the messaging system that are missing in our section the Experimenter docs, like Remote Localization and Message Groups.

Iteration: --- → 105.1 - July 25 - Aug 5
Iteration: 105.1 - July 25 - Aug 5 → ---
Depends on: 1804311
Depends on: 1804312
Depends on: 1804313

Opened https://github.com/mozilla/experimenter-docs/issues/370 to update telemetry documentation in experimenter.info

Other than above telemetry source, DS uses below sources for analysis

The Glean Dictionary - https://dictionary.telemetry.mozilla.org/
The Probe Dictionary - https://probes.telemetry.mozilla.org/
GLAM - https://glam.telemetry.mozilla.org/?currentPage=1

Depends on: 1816441
Depends on: 1816442
Depends on: 1821499
Depends on: 1831211
Alias: fxms-docs
Depends on: 1825107
Depends on: 1844465

The bug assignee is inactive on Bugzilla, so the assignee is being reset.

Assignee: viar → nobody

Maybe this should be a metabug

Depends on: 1857995
Blocks: fxms-infra
No longer blocks: bugzy-epic
Keywords: meta
Priority: P2 → --
Summary: Messaging System maintainable documentation → [meta] Messaging System maintainable documentation
Depends on: 1869212
Depends on: 1869215
Depends on: 1868233
Depends on: 1866914
Depends on: 1872582
Depends on: 1871067
Depends on: 1873811
Depends on: 1874002
Depends on: 1874278
Depends on: 1875870
No longer blocks: bugzy-epic
Priority: -- → P1
No longer blocks: bugzy-epic
No longer blocks: bugzy-epic
Depends on: 1867871
Depends on: 1890040
Depends on: 1898038
You need to log in before you can comment on or make changes to this bug.