Overview graphics for all the tools in use

[programlich]

As a first time user the number of different tools used in the microcourse is a bit overwhelming (github, readthedocs, quercus, colab, several external toutorials and docs, hivemqtt, mongodb, ...). What really would help me is an overview graphics in the beginning of the course, that shows, which platforms are used, how they are linked and which purpose they serve. This way it would be a bit less confusing to switch the platform so many times. In the end, everything makes sense, but in the process of getting to know it, it can be confusing to switch websites so frequently.

[sgbaird]

Good point about an overview graphic.

Would something like the graphic in https://ac-microcourses.readthedocs.io/en/latest/courses/hello-world/1.6-connecting-the-pieces.html, except perhaps extended and maybe a second graphic that covers more course-specific tools (Quercus, readthedocs, etc.) be in line with your suggestion?

[programlich]

yep, thats exactly the kind of thing I was thinking about.

[SissiFeng]

I drafted a flowchart to show the flow of each chapter that might help with understanding. If any mistake, please let me know.

[sgbaird]

Overall looks good. A few thoughts:

1. The Pico W never communicates directly with Ax, it happens through the MQTT layer
2. Maybe some separation of tools vs. topics?

@SissiFeng what do you think about modifying this slide (I shared access to your email) so that it has the column-based separation between the 4 modules?

@programlich thoughts?

[programlich]

I think that looks pretty good to get an idea about the tools which are used in the overall structure of the course. Perhaps, instead of writing "mongoDB" or "hivemq" the logos of these products could be used to add a bit more color to the graphic.

Besides, a second graphic might me a good thing, in which the structure of the learning tools is listed. This way the student could get an idea about the structure of the learning process of the course which includes all the different platforms that are used. I am mostly referring to all the toutorials which are linked, but also to the use of githab codespace, google colab and quercus.

[sgbaird]

Any insertions, deletions, or modifications you'd recommend?

• GitHub Classroom / git / GitHub / GitHub Actions / GitHub Codespaces
• Quercus
• readthedocs
• Google Colab / Jupyter notebooks

[programlich]

Perhaps a section of external services could be added:

• HiveMQ
• MongoDB atlas
• (AWS)

[sgbaird]

@SissiFeng not super urgent, but wanted to resurface this

[SissiFeng]

I modified it as per the comments above. The icons of the tools used were not included to keep the content of the screen from looking too complicated.