Closed Bug 1378325 Opened 7 years ago Closed 7 years ago

Append Architecture diagram into docs

Categories

(DevTools :: Console, enhancement, P1)

enhancement

Tracking

(firefox56 fixed)

RESOLVED FIXED
Firefox 56
Iteration:
56.3 - Jul 24
Tracking Status
firefox56 --- fixed

People

(Reporter: Honza, Assigned: Honza)

Details

(Whiteboard: [console-html])

Attachments

(2 files)

- introduce docs/tools/console-panel.md file
- append architecture diagram of the console panel

Honza
Assignee: nobody → odvarko
Status: NEW → ASSIGNED
Whiteboard: [console-html]
Flags: qe-verify-
Priority: -- → P1
Iteration: --- → 56.2 - Jul 10
Comment on attachment 8883530 [details]
Bug 1378325 - Append Architecture diagram into docs;

https://reviewboard.mozilla.org/r/154474/#review160250

Hi, thanks for the patch! there's a number of corrections that need to be done, so r-ing it, sorry!

::: devtools/docs/tools/console-panel.md:3
(Diff revision 1)
> +# Console Tool Architecture
> +
> +Console panel is responsible for rendering all logs coming from the current page.

*The* Console panel

::: devtools/docs/tools/console-panel.md:11
(Diff revision 1)
> +
> +Internal architecture of the Console panel (the client side) is described
> +on the following diagram.
> +
> +![Console panel architecture](console-panel-architecture.png)
> +

I'd add an "## Entry points" section to describe how to open the console

::: devtools/docs/tools/console-panel.md:12
(Diff revision 1)
> +Internal architecture of the Console panel (the client side) is described
> +on the following diagram.
> +
> +![Console panel architecture](console-panel-architecture.png)
> +
> +There are two ways how to load the Console panel. It can either run on top

*two ways to load

::: devtools/docs/tools/console-panel.md:13
(Diff revision 1)
> +on the following diagram.
> +
> +![Console panel architecture](console-panel-architecture.png)
> +
> +There are two ways how to load the Console panel. It can either run on top
> +of the Launchpad (inside a browser tab) or within DevTools Toolbox.

within *the* DevTools toolbox.

::: devtools/docs/tools/console-panel.md:19
(Diff revision 1)
> +
> +There are different entry points for these scenarios:
> +* Launchpad - uses `index.js` file as the entry point
> +* Toolbox - uses `panel.js` file as the entry point
> +
> +### Components

Why are components, actions and state indented even more? (###) - I don't think you need these as they are clearly different topics and also do not belong under the 'entry points' topic.

::: devtools/docs/tools/console-panel.md:20
(Diff revision 1)
> +There are different entry points for these scenarios:
> +* Launchpad - uses `index.js` file as the entry point
> +* Toolbox - uses `panel.js` file as the entry point
> +
> +### Components
> +The Console panel UI is built on top of [React](http://searchfox.org/mozilla-central/source/devtools/docs/frontend/react.md). It defines set of React components in `components` directory

can you make this link to the docs using a relative link?

::: devtools/docs/tools/console-panel.md:24
(Diff revision 1)
> +### Components
> +The Console panel UI is built on top of [React](http://searchfox.org/mozilla-central/source/devtools/docs/frontend/react.md). It defines set of React components in `components` directory
> +
> +### Actions
> +
> +The Console panel implements set of actions divided into several groups.

implements *a* set of actions

::: devtools/docs/tools/console-panel.md:32
(Diff revision 1)
> +* **Messages** Actions related to list of messages rendered in the panel.
> +* **UI** Actions related to the UI state.
> +
> +### State
> +
> +The Console panel manages the app state via [Redux](http://searchfox.org/mozilla-central/source/devtools/docs/frontend/redux.md).

Please use a relative link to the redux docs :)

::: devtools/docs/tools/console-panel.md:41
(Diff revision 1)
> +* `reducers/filters.js` state for panel filters. These filters can be set from within the panel's toolbar (e.g. error, info, log, css, etc.)
> +* `reducers/messages.js` state of all messages rendered within the panel.
> +* `reducers/prefs.js` Preferences associated with the Console panel (e.g. logLimit)
> +* `reducers/ui.js` UI related state (sometimes also called a presentation state). This state contains state of the filter bar (visible/hidden), state of the time-stamp (visible/hidden), etc.
> +
> +## Run on top of the Launchpad

For simplicity, these sections about 'running' the console should go under the 'two ways of loading the console panel' section above. Keeps related things together and helps not confusing people :-)
Attachment #8883530 - Flags: review?(sole) → review-
Also I can't see the console diagram because mozreview won't let me see it :(
Attaching the diagram image.

Thanks for the review comments, all fixed.

Honza
Iteration: 56.2 - Jul 10 → 56.3 - Jul 24
Comment on attachment 8883530 [details]
Bug 1378325 - Append Architecture diagram into docs;

https://reviewboard.mozilla.org/r/154474/#review161166

Thank you, this is a great start!
Attachment #8883530 - Flags: review?(sole) → review+
Pushed by jodvarko@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/1e38bde37558
Append Architecture diagram into docs; r=sole
https://hg.mozilla.org/mozilla-central/rev/1e38bde37558
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 56
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: