Updated training style guide #1585 #1734
Conversation
| * `training`: List here training material relevant for the page. We recommend to add your training material in TeSS. However, you can also list here training material that is not yet present in TeSS. | ||
| * `training`: List here training material relevant for the page. We recommend to add your training material in TeSS. However, you can also list here training material that is not yet present in TeSS. The supported registries that can be used in the `registry` attribute are: *YouTube*, *Zenodo*, *Carpentries*, *GitHub* and *TeSS*. |
There was a problem hiding this comment.
One could mention that TeSS is not hosting the material, and that materials should be registered on TeSS no matter which service is actually hosting it.
There was a problem hiding this comment.
"We recommend registering your training material in TeSS."
remove: However, you can also list here training material that is not yet present in TeSS.
would that be good?
There was a problem hiding this comment.
I would write the full thing, something like:
We recommend registering your training material in TeSS. Note that TeSS is a registry, and materials can be registered on TeSS independently of the hosting service used. While it is preferable to list here materials on TeSS, we offer a number of additional registry keywords. The full list is...
There was a problem hiding this comment.
i think its too long, people get tired before they even get to the main relevant points. Used gemini for rewording the longer version for ease of reading:
It is recommended to register your training materials in TeSS, a central registry that enhances the visibility and accessibility of your content. TeSS acts as a directory, meaning your materials can be listed there regardless of where they are hosted.
While TeSS is the preferred platform for registration, a number of other services can be used to host and share your training materials. These include: YouTube, Zenodo, GitHub and TeSS.
alternative shorter version:
To make your training materials more visible, we recommend registering them in TeSS, which is a central registry for training content. You can list your materials on TeSS no matter where they are hosted.
In addition to TeSS, you can also use these platforms for your materials: YouTube, Zenodo, GitHub and TeSS.
There was a problem hiding this comment.
The first suggestion looks a bit off. The second one is very readable, but fails to understand that these are registry attributes for registration of materials in RDMkit. Actually, in the second, it looks like we are recommending YouTube, and this is not the case (persistence issues, lack of identifiers, commercial platform...)
| * `training`: List here training material relevant for the page. We recommend to add your training material in TeSS. However, you can also list here training material that is not yet present in TeSS. | ||
| * `training`: List here training material relevant for the page. We recommend to add your training material in TeSS. However, you can also list here training material that is not yet present in TeSS. The supported registries that can be used in the `registry` attribute are: *YouTube*, *Zenodo*, *Carpentries*, *GitHub* and *TeSS*. |
There was a problem hiding this comment.
I would argue against YouTube being listed as a registry. Can we distinguish between hosting platforms and registries? I think this would clarify.
There was a problem hiding this comment.
Regarding Carpentries, I suspect we are pointing to the workshop materials and not to the AMY registry, where the training events are recorded. If this is the case, how does this differ from content from other providers on GitHub? To my knowledge, all the Carpentries material is on GitHub, so this is practically indistinguishable from content from any other providers that have (i) GitHub repos and (ii) a distinct website displaying the content of such repos.
There was a problem hiding this comment.
I agree with Carpentries. I will remove from examples.
YouTube issue needs to be reviewed by @bedroesb
There was a problem hiding this comment.
With the restyle of ELIXIR-Belgium/elixir-toolkit-theme#377 I am actually thinking of not making a destination between registries or anything. Just listing urls:names to training materials.
There was a problem hiding this comment.
@bedroesb I am ok with getting rid of most of these, but I think TeSS should remain (and, possibly, be more visible than it is today).
| - name: VIB Training material on TeSS | ||
| registry: TeSS | ||
| url: https://tess.elixir-europe.org/search?q=data%20analysis | ||
| url: https://tess.elixir-europe.org/content_providers/vib-training |
There was a problem hiding this comment.
This is all the content from a certain provider. I would argue this differs from the categories you mention above (query and materials), as query is a query and URLs for materials look like "https://tess.elixir-europe.org/materials/" + "name_of_content".
There was a problem hiding this comment.
VIB is not a query indeed. This is training material by VIB
Query would be ELIXIR Estonia link: https://tess.elixir-europe.org/materials?content_provider=ELIXIR+Estonia
Do you want both examples?
There was a problem hiding this comment.
The link for Estonia is a better example. One can also show other types of queries, based e.g. on keywords or even the ones based on annotations via EDAM, FAIRsharing, and bio.tools. These three categories are certainly the more FAIR-oriented (although not necessarily the most popular). But EDAM is used quite a bit, so maybe that is a possible example.
| ``` | ||
| - name: RStudio basic course in GitHub | ||
| registry: GitHub | ||
| url: https://github.com/ELIXIREstonia/2025-09-01-R-basic |
There was a problem hiding this comment.
Do we want to point to repositories or releases? I would argue it is more correct to point to releases (e.g. https://github.com/ELIXIR-Norway-Training/DMP-writing-workshop/releases/tag/2025-03-18).
There was a problem hiding this comment.
In our case, our programmers decided to do a different repo for each course.. so it's correct the way it is.
There was a problem hiding this comment.
However we might change wording if we want release info integrated.
There was a problem hiding this comment.
This has mostly to do with locking a certain set of training materials rather than generically linking a repository, where contents can significantly change over time. I was thinking about using GitHub releases, as that's also at the base of the integration with Zenodo.
|
Another quick note: the actual name of the organisation is "The Carpentries", not "Carpentries". |
Co-authored-by: Federico Bianchini <[email protected]>
Co-authored-by: Federico Bianchini <[email protected]>
No description provided.