1479382 - [remote-dbg-next] Document technical specifications for new about:debugging UI

Status: RESOLVED FIXED

(DevTools :: about:debugging, enhancement, P1)

Description

[Julian Descottes [:jdescottes]]

As discussed, we should first try to agree on an overall architecture for the UI, mostly about:
- state
- actions
- patterns and guidelines

The goal of this bug is to document this in a file that could live next to the source code. This will serve as reference work document as we start landing the code for this new UI. 

Note that we expect that the more specific sections of the document will be easier to keep updated if they live next to the code. So as things will get implemented, this document should be stripped of the most detailed sections to retain only high level architecture and guidelines.

Comment 1

[Julian Descottes [:jdescottes]]

https://docs.google.com/document/d/1zCoFfG8Wm3M5y_EI5o4JYNJPYvZbzreguENKoAsCymo/edit?usp=sharing

Belén, Daisuke here is a first shot at the architecture document I mentioned. Let me know what you think, particularly about the state and actions. For the actions, I think that when we decide to implement one, we should get more specific and discuss the name, arguments and overall implementation (async, not async, which part of the state will be impacted etc...)

Maybe as an exercise, we could go through two flows:
- modification of the addon list
- update the selected page from this-firefox to connect

Also let me know if you think the document should try and draw the boundaries of the different components. 

Feel free to suggest and comment on the document. If you feel like it, I can also open it for edition.

Comment 2

[:Harald Kirschner :digitarald]

Moving major about:debugging ng work into milestone 1, leaving m0 for prior bugfix work.

Comment 3

[Julian Descottes [:jdescottes]]

Attachment: Bug 1479382 - Add README.md in aboutdebugging-new to document architecture guidelines;r=daisuke,ladybenko

Comment 4

[Julian Descottes [:jdescottes]]

Integrated the feedback so far, and pushed for review!

Comment 5

[Phabricator Automation]

Comment on attachment 8997370 [details]
Bug 1479382 - Add README.md in aboutdebugging-new to document architecture guidelines;r=daisuke,ladybenko

Daisuke Akatsuka (:daisuke) has approved the revision.

https://phabricator.services.mozilla.com/D2708

Comment 6

[Julian Descottes [:jdescottes]]

Belén: can you review the patch on phabricator? Note that the document is now a bit outdated. I can either:
- update it here and land it later
- land it and update it after

I would prefer the second option

Comment 7

[Belén [:ladybenko]]

Comment on attachment 8997370 [details]
Bug 1479382 - Add README.md in aboutdebugging-new to document architecture guidelines;r=daisuke,ladybenko

Belén [:ladybenko] has approved the revision.

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c9d2c08bea3c
Add README.md in aboutdebugging-new to document architecture guidelines;r=daisuke,ladybenko

Comment 9

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/c9d2c08bea3c