-
Notifications
You must be signed in to change notification settings - Fork 437
EAMxx: add 2025 tutorial presentations #7101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ddf5a29
to
73c5633
Compare
|
To reviewers, the source code of these presentations is a pretty plain markdown you will find in the PR files page. The resulting presentations can be viewed here: https://docs.e3sm.org/E3SM/pr-preview/pr-7101/EAMxx/user/presentations/. Take a look and let me know. For @rljacob, this introduces a slightly different workflow setup that others may wish to make use of for their presentations. I also converted the pypi-based python dependency installation to conda because pypi no longer suffices. For @xylar, jfyi and in case you have some advice on the micromamba setup (if you prefer we follow different procedures to keep a consistent approach across the project, happy to edit here, just let me know) |
Please explain the workflow you are envisioning. |
I should clarify, everything we have working for docs so far will remain working with no changes whatsoever. In this PR, I show this our docs workflow can be generalized to presentations if people wish to store their presentations in github repos (here for project presentations like those EAMxx tutorial ones or in private repos for their own work). The big advantage is that tracking markdown in git is much friendlier than other formats. Here's how I envision one could add more presentations:
|
But doesn't this mean you have to write your presentation in markdown to start? I don't understand the point of even making this workflow available. You had a perfectly good pdf of the tutorial on our world readable confluence site. Just link to that. |
In the ethos of "docs near and tracked with the code" ... a PDF isn't easily git-trackable. That's the main advantage. We can easily update these markdown files for the next presentations. Also, having the presentation be in html is helpful. Can natively copy out of it (as opposed to copying out of PDF which may or may not work) |
If you see the tutorial as something you want to generalize and expand as an integral part of the user's guide, this makes sense. But we don't want every presentation ever to be made about eamxx to live in eamxx/docs. |
Oh, I see the potential misunderstanding here. This is just for a very LIMITED set of presentations we want to make available as part of the "living" docs, like the tutorial. But we definitely won't be adding other presentations. And, I expect the tutorial presentations to be updated, rather than adding more. Sorry, I should've been clearer about the intentions... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work on this. The slides look excellent, and I like the motivation behind using markdown for better version tracking
Adds the presentation from the 2025 EAMxx tutorial at the E3SM All-Hands. This PR does that by revisiting installing the python dependencies in the gh-pages workflow (moving from pypi to conda) and utilizing a nodejs framework (marp) to create slide decks out of markdown files. [BFB]
adds the presentation from the 2025 EAMxx tutorial at the E3SM All-Hands. This PR does that by revisiting installing the python dependencies in the gh-pages workflow (moving from pypi to conda) and utilizing a nodejs framework (marp) to create slide decks out of markdown files.
[BFB]