Add terminal sessions to the quick start guide

[ehogan]

Pull Request checklist

We appreciate your time and effort to improve the tutorial. Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution.

---

Before you start

• Read CONTRIBUTING.md.
• Create an issue to discuss your idea. This allows your contributions to be incorporated into the tutorial.

Tasks

• Give this pull request a descriptive title.
• If you are contributing to existing lesson materials, please make sure the content conforms to the Lesson development section in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
• If you are making a new episode, please make sure the content conforms to the Lesson organization and Lesson formatting sections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
• Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
• Preview changes on your machine before pushing them to GitHub by running make serve, alternatively make docker-serve. Please see the Previewing your changes locally section in CONTRIBUTING.md for installation instructions.
• All code instructions have been tested.

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.

---

Closes #291

[ehogan]

Hi @hb326 👋 I have started this PR to add the terminal sessions to the quick start guide in the tutorial. So far, I have added one to demonstrate the loading of an environment (on JASMIN). Is this the sort of thing you were after? Are you able to build the tutorial locally so you can see it? I am planning to add one for updating the config file and one for running the example recipe. Would you remind me when you need this by? (Am I too late?) 😕

[LisaBock]

Hi @ehogan , this looks great! That's a really cool extension. Thanks!

My suggestion would be to put the video also in a box with a name e.g. "Example video". The box could then be hidden in the beginning (like the solution boxes) or not. But it would be more clear what to see here.

And a small comment: When typing esmvaltool version and esmvaltool --help in the video, an error message appears in the beginning. Could this be removed for the video?

[ehogan]

Thanks @LisaBock! 🥳

I don't know whether someone more familiar with web pages can help me with this, but I tried adding the terminal session to a box and it didn't render correctly, I'm guessing because I used HTML to embed the terminal session and the markdown templating didn't like it within a box. Any thoughts?

Related to finding someone more familar with web pages, the only way I could get this to work was to add load_environment.cast to the top level directory (I couldn't enable the file to be found if I added the file to a directory) 😞 Any thoughts on this would be appreciated! 😊

With regards to the error, there are plans for @valeriupredoi to remove that error from JASMIN via ESMValGroup/ESMValTool#3379 and once that's done I can remove it from the video (the video should reflect what a user would see when running on JASMIN and if there is no error in the terminal session but an error on JASMIN the user might worry!) 😊

[ehogan]

I had a bit more of a play with this and I can convert the terminal session to an animated gif, which allows me to add it to a box, but you lose the ability to stop / play / pause / navigate the video, and you lose the abilty to copy and paste from the terminal session (which is one of the cool things that asciinema allows!).

[LisaBock]

@bouweandela suggested once (#140) to use asciinema for bash sessions in the tutorial. Maybe he could help?

[ehogan]

@LisaBock I figured it out 😁 See 7bbb25d. What do you think? 🤔 😊

[LisaBock]

@LisaBock I figured it out 😁 See 7bbb25d. What do you think? 🤔 😊

Looks great! 🎉 👍 Cool that you figured out. I prefer it like it is now...

[ehogan]

@LisaBock I figured it out 😁 See 7bbb25d. What do you think? 🤔 😊

Looks great! 🎉 👍 Cool that you figured out. I prefer it like it is now...

Me too! 😁 🥳