Next steps for tutorials #5
Description
I am not sure if this is the ideal place for this to-do list, since it includes task regarding changes in the actual tutorials, the website, but also some of the workflows pioneered in this repository. I am happy to move it to a better place, but do not know of any just yet.
With that being said: Here is a list of to-dos regarding the tutorials in the biggest sense:
Look and feel of website (@aaruni96)
- Remove the cornerstone filters from the list of tutorials shown on the OSCAR website. Eventually, we want to replace them with other filters, so only comment out the code and anticipate it being repopulated with other content at a future point in time.
- Mark working and failing tutorials visually on the website. For instance by a red cross (fail) or green checkmark (working). Or sort them into two groups, such as "working tutorials" and "failing tutorials". The wording needs to be chosen carefully for political reasons.
- Adjust margins of tutorials and/or place only a single tutorial on a line. (Related to Tutorials look very condensed on phone in portrait mode oscar-website#338?)
- Automatically update the "last changed" date on the OSCAR website to reflect the last changes to the tutorial.
- Related: Maybe remove the "last changed" information from the tutorials, so this need not always be updated by hand. Rather, we could use the timestamp associated with the last changes to the tutorial file. If this can be extracted that is. (https://github.com/marketplace/actions/track-and-record-changes-in-other-repos)
- Today (April 24), I found that one group theory tutorial was listed as outdated, a.k.a. due to errors. I merged my PR, and said tutorial is now listed as working. This is expected, because the website only fetches the latest tutorial tests whenever it is being built. We should improve this, e.g. by triggering a rebuild of the website once the tutorial tests are complete. This would be once every 24 hours and hopefully not consume to many resources.
How to keep tutorials working?
- Integrate the tutorial tests as non-required tests into the OSCAR CI-tests?
- Automatic alerts to tutorial authors in case their tutorial fails. Said alert could be a github issue including a ping to the username of the tutorial author. (Since we require tutorials to be hosted in github repositories, every author must have a github account. Therefore, this strategy will always work. Also, it would allow to keep track of any progress.) Alternatively, as suggested in the Wednesday OSCAR meetings, one could try a ping on slack, but this will not always work, as some tutorial authors are not present on slack.
More tutorials and more content (@HereAround)
- Activate more tutorials/cover more content of OSCAR.
- Include more feedback on polynomial ring tutorials, (e.g. on polynomial rings by @JohnAAbbott ).
- Include more feedback on polyhedral geometry tutorial.
- Add a tutorial with useful tricks for OSCAR.
cc @aaruni96