Tracking: Turing Way

[rowanc1]

We had a wonderful conversation this morning with the TuringWay team on how best to support the TuringWay team in their adoption of JupyterBook v2, which will be using mystmd. There were a lot of exciting possibilities that we talked about in terms of creating an ecosystem of content that the TuringWay could expose (figure, equations, glossaries), and that be included, linked to and cross-referenced by other books, tutorials, and communities in the wider open-science ecosystem. There are also some current deficiencies in MyST MD at the moment, one of the core ones is around internationalization. We got a really good demo from @BatoolMM on how that process is working, and some of the sticking points on how to bring content together to have a unified experience between languages. The localization also must include right-to-left languages, which will require a number of style updates and improvements across the components.

Resources for translations:

• https://turingway-arabic.netlify.app/welcome.html
• https://github.com/TWTranslation/the-turing-way/tree/main/book/translation

Example of Turing Way content deployed in MyST

• https://rowanc1-turingway.curve.space/ (this is deployed using Curvenote)

Some cool things

Updates that need to happen

• Glossary #618
• Improve the upgrade process #1223 (in progress)
• Internationalization and localization (this is a big task that we need to break down, what is necessary is a lot clearer to me notw after @BatooIMM's demo) #166
• Host multiple languages in a single theme
• PR: fix admonitions with Note --> note (that can be upstreamed right away)
• Way to turn off @username references on a page (e.g. changelogs) or have those fallback to a configured list of IDs and improve, e.g. our GitHub person cards.
• Discuss and demo different ways to build out the infrastructure for the book (and tradeoffs between the different approaches)
• Idea (curious on your take): #1305
• Improved header / footer information

There are probably a number of other things that will come out as we work towards these goals, I encourage members of the TuringWay team to jump in here and let us know how we can support you. Please try the preview above and get a sense of where we are at. One of the cool wins is that the performance of navigating between pages should be improved quite a bit. There are also some abbreviations that will work and increase accessibility etc. for various pages.

I know that my team and @agoose77 do have some time to help with specific things, and some issues are in progress this week, so hopefully when we meet again in a few weeks there will be some progress to show!

@JimMadge @da5nsy @BatoolMM @agoose77 @sgibson91

We have had some previous conversations with the Environmental DataScience Book as well:

https://github.com/alan-turing-institute/environmental-ds-book

@acocac