Implement review notes widgets doc

[steersbob]

Commit: c485bf2
Tested on laptop with kubuntu 20.04 LTS on March 30 2021 with Brewblox UI build date: 2021-03-09T18:26:05.737Z. Spark with Fermentation Fridge wizard blocks (standard). Spark is powered over USB, connected over WiFi.

l7: consider renaming the widget to: Brewery Widget or System Widget. The Brewery Builder is where you design / construct this widget. The naming of all these things is a bit odd too. I understand you want Brewblox to be modular and applicable to fields outside brewing, but we still have these Brewery related names for widgets, menus, etc. For example: comments on the Brewblox UI sidepanel from top to bottom, left to right where applicable:

• Dashboards + icon is clear, but can be left out because of the list below. Not needed for navigation
• Builder + icon is clear and needed
• Admin + icon is clear and needed
• Dashboards list is clear and needed
• Builder layouts is not really clear, System layouts might be better. Maybe even not needed, there is a menu entry at the top and you will only need to go there when constructing / changing your system.
• Services list is a bit abstract (the naming), but needed and useful

l11: "The system widget shows.."

l13: "For more info on how to build your brewery (system) in the Brewblox UI,see.."

l19: "The Spark controller and other connected devices..." "The graph widget displays selected fields of your history database on your dashboard."

l23: "To improve visualization of data with different scales, two Y-axes are supported. Both Y-axes are rendered on the right side of the graph; Y1 in white, Y2 in cyan." - Question: how do I find out which value is rendered at which scale?

l25: Ok, question answered; from the graph data itself. No other way of finding this out? In the legend maybe?

l29: ah, you can find it in the menu too...

l31: hey, double clicking the widget panel background gets me to the new widget menu. If I use the edit metrics button to add a metric to my new empty widget I do not know how to finish, and get back from the menu to my widget. Naming of the "Show full widget / Show basic widget" remains weird. The full widget is the menu / settings or admin panel and you can get there in too many ways. Show in dialog works too, but only shows me the menu. For other widgets this would show me the menu + the widget side by side if the screen is wide enough, this is useful to see what I do. Also: you can copy, move, rename or remove the widget in its settings menu (three vertical dots), but cannot enter the menu to modify the displayed metrics.

Quick actions widget:

• text in guide is good
• ah you can configure the widget before adding it.
• The user interaction of activating the action is weird. Clicking the text gets me to the editing the menu, not activating it. The UI of the text + icon is good, green is activated. Maybe add an edit icon (pen)
• Is it possible to create your own toggle? Enabling / disabling a particular block now requires the creation of two actions...
• Creating an action to activate the Spark alarm does not activate the Spark alarm. The alarm remains OFF both in the UI and on the Spark even though you get a notification the action is succesful.
• When I want to change the Spark display footer text I don't know what the default state was. To remove my footer text I have to set something like a space - "dunno how this works / not important"
• In the settings menu of a block in the edit actions menu, there is only one block in the dropdown list behind the "Switch target block" option. What is this option used for? Clicking the X behind the block results in no action. Weird.
• I would like the "Show in dialog" button to show me the quick actions menu next to the widget for testing, just like with the graph and setpoint profile widgets

Intermezzo: changing to the develop build of Brewblox UI to test the grid fix. Note: it was hard to find the Brewblox version in the UI. Finally I found the Build date in the Debugging section of the Admin panel that could be used as a version number of sorts. Maybe an about section is an idea? Updated build: 2021-03-30T12:16:32.267Z.

Quick values widget:

• text in guide is good
• works pretty good
• widget and menu side by side would be nice to see what I do
• How can I add a second Field to my widget? I can only add a second widget

l74: Why is the widget in the picture called Mr Beancounter? Mine is called Session Log... Ah, I can change widget names... Is this a good example for the default?

l77: Personal opinion: the thing you create is a log, you log the brew session in a session log. If you want to be consistent, next to the user guide menu entries might have to change too so I don't know if it's worth the work.

l88: add a picture of a graph note on a Session Log? Maybe the graph itself too?

Session Log widget:

• widget is a bit harder to learn
• Clicking on a graph field starts with the confusing notification: !No data (yet) for the selected period. Reads like a warning. Maybe start with notification: rendering... till it is clear whether there is data?
• Graph: sometimes when the cursor hovers over a line, the line name does not show up. Neither with the spike lines. Persistent erratic behavior. Dunno how to trigger it. Ah, names and spike lines are triggered around history points. When showing a graph with a gap in the time range, lines are drawn but names / spike lines cannot be triggered. Normally not a problem but a bit confusing when you encounter it. Maybe dash / remove the lines in the graph when there are time gaps?
• Export session: why do you want your exported session formatted in HTML? Such a weird format for a document only containing text. What is wrong with .txt? I take it, it is hard to format and export the graphs? Exporting the graphs in the same document would be nice actually, and a good reason to format in HTML if needed.
• Export graphs to CSV - time formatting: whats the use of the time nanosecond and millisecond time formats? Who is going to use that? After talking to Bob I understand these are standard internet / computer time formats.
• After removing a session, the next session in the list shows up in the widget. Is this desired behavior? Maybe start with an empty widget again?

Spark Sim Display widget:

• will test this widget when providing feedback at adding_spark_sim.md
• current widget behavior is as expected: !Service is not a simulation
• Are there use cases of a Spark Display widget for a real Spark? Maybe when viewing Brewblox UI remotely? You can get all the information from other widgets, but it might be a nice format...

l102: what is the stopwatch widget for? "A simple, but useful widget to keep track of... during your brew."

Stopwatch widget:

• Maybe useful to add a stopwatch note to the Session Log widget for an overview of your brew session in one widget? Maybe have multiple stopwatches running + labels for their goals
• I can't see the use for the 'show in dialog' button
• Is it useful to be able to change the time formatting? So ..h..m..s instead of ..:..:..?
• Knit picking: START, PAUSE, RESET might be better descriptions of the button actions.

l112: Do you have examples of something you might want to embed? I can't think of one... Brewblox-UI-like webpages of other services? The weather / temperature forecast of your shed?

Web Frame widget:

• widget menu only breaks URLs at certain symbols. Long URLs can break out of the menu widget, see WebFrameWidgetLongURL.png. This happens both with "Show in dialog" and "Show full widget" views. Example URL: https://www.openstreetmap.org/export/embed.html?bbox=-0.004017949104309083%2C51.47612752641776%2C0.00030577182769775396%2C51.478569861898606&layer=mapnik from the Mozilla iframe page mentioned in the user guide.

General remarks:

• people might search here for information about manipulating widgets too. So moving, pinning, creating new widgets etc. - Idea: maybe a link to the Development section where you can find how to construct your own widget?