the-turing-way icon indicating copy to clipboard operation
the-turing-way copied to clipboard

Add guidance about using Turing Way vs "The Turing Way" in materials

Open aleesteele opened this issue 1 year ago • 2 comments

Summary

In the past, we have used "TTW" as a way of shortening "the Turing Way" in various materials, but are sunsetting that in favour of using the full name.

What can be changed in our guides to reflect this? Where can we

  • [ ] Add a note to the Style Guide in the Community Handbook about using the full name
  • [ ] Review current materials to see if "TTW" is used as reference in any

aleesteele avatar Jul 15 '24 21:07 aleesteele

I'm not aware of the previous context of this discussion, but it might be worth also noting the support for abbreviations in Jupyter Book 1 and MyST-MD/Jupyter Book 2. MyST-MD supports an "automatic" form of abbreviations whereby abbreviations are automatically applied for text, e.g. after declaring TTW as an abbreviation in the project frontmatter,

I love TTW

generates a tooltip and lightweight emphasis to indicate TTW is an abbrev.

Sphinx also supports abbreviations, but they need to be declared everywhere.

agoose77 avatar Jul 16 '24 08:07 agoose77

Thanks so much for your comment, @agoose77! That's great to know. This shift to using the full-name and not the abbreviation is more of a cultural question than a technical one I will say, but this is really great to know for other abbreviations that we use throughout the project (and more broadly within the foss/oss ecosystem).

aleesteele avatar Aug 02 '24 18:08 aleesteele