1277898 - document system add-on install and upgrade process

Status: RESOLVED FIXED

(Toolkit :: Add-ons Manager, defect)

Description

[Robert Helmer [:rhelmer]]

We have moved a number of Firefox features to system add-ons (Pocket, Hello, and some less user-visible features like e10s rollout) and using Balrog to push out-of-release-cycle updates to these out as part of the "go faster" project.

While there was a PRD written before any work started, there are some edge cases that cause confusion about exactly how this process works, so Osmose took some time to document the current situation in more detail.

Let's land this in toolkit/docs/ and hook it up so "./mach docs" works and it is published to gecko.readthedocs.org

Comment 1

[Robert Helmer [:rhelmer]]

(In reply to Robert Helmer [:rhelmer] from comment #0)
> Let's land this in toolkit/docs/ and hook it up so "./mach docs" works and
> it is published to gecko.readthedocs.org

After looking at how other toolkit/ code is doing this, I decided to put it in ./toolkit/mozapps/extensions/docs/ and make it Add-on Manager specific instead.

Comment 2

[Robert Helmer [:rhelmer]]

Attachment: Bug 1277898 - start documenting add-on manager code, starting with system add-on spec

Review commit: https://reviewboard.mozilla.org/r/57622/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/57622/

Comment 3

[Robert Helmer [:rhelmer]]

gps, do we need to do anything special to get this published on gecko.readthedocs.org or is this patch enough? Thanks!

Comment 4

[Osmose [:osmose, :mkelly]]

Comment on attachment 8759736 [details]
Bug 1277898 - start documenting add-on manager code, starting with system add-on spec

Got it built locally, looks good to me. Thanks rhelmer!

Comment 5

[Robert Helmer [:rhelmer]]

Comment on attachment 8759736 [details]
Bug 1277898 - start documenting add-on manager code, starting with system add-on spec

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/57622/diff/1-2/

Comment 6

[Robert Helmer [:rhelmer]]

We were missing a code block around one of the example XML responses, that's fixed now.

Comment 7

[Gregory Szorc [:gps]]

Comment on attachment 8759736 [details]
Bug 1277898 - start documenting add-on manager code, starting with system add-on spec

https://reviewboard.mozilla.org/r/57622/#review54584

I didn't really look at the content but the Sphinx integration looks correct.

Comment 8

[Gregory Szorc [:gps]]

gecko.readthedocs.io updates from mozilla-central every few hours. Just land this and it should appear.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/9d34386dec39
start documenting add-on manager code, starting with system add-on spec r=gps

Comment 10

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/9d34386dec39