Field report, 2025 March

[rkdarst]

Schedule below. Overall it seemed OK timing, but maybe got a bit rushed at the Github Pages part and we had one question about someone who couldn't follow that we didn't have time to answer.

9:03 ( 0 min) START 5.1 Documentation
9:03 ( 2 min) . . Introduction to topics, initial questions
9:06 ( 2 min) . . Aside: looking at icebreakers
9:08 (24 min) . § Motivation and wishlist
9:32 (14 min) . § Popular tools and solutions
9:46 ( 9 min) . § In-code documentation
9:55 ( 8 min) . § README files
10:02 (10 min) STOP
10:12 (36 min) . § Sphinx and Markdown
10:48 ( 8 min) . § Deploying Sphinx documentation to Github Pages
10:56 ( 5 min) . § Summary and Q&A
11:01 (60 min) STOP

[mmesiti]

Things I remember on my side, plus things I've noticed now watching the video of March 2025:

• I think my zoom setup has serious problems. My mouse pointer was not visible, this was actually discovered by Jarno that afternoon during the Jupyter session, and after that when Jarno tried to draw something on my screen the zoom screen share just got broken, and we had to scramble to find a solution.
• the video of the presenters hides, sometimes, some important information (url, or commands typed). I should have organized my screen slightly differently, like add some padding on top.
• using a shell on a different account than mine to do the demonstration is ok, but I should have set up permissions correctly (this has cause the waste of some minutes and a bit of stress)
• I should possibly get a webcam that I can put on the main screen I am sharing
• A bit more familiarity with the material (with it structure and aim of every section) could have helped. I think that teaching it again might actually improve time management and also the significance of my comments while I am doing things. I also have the impression that perhaps I've been spending a little too much time talking about motivation, or that maybe motivations could be explained more clearly without actually using more time.