precice / precice.github.io

The website of preCICE
https://precice.org/
12 stars 56 forks source link

Categorize the tutorials #345

Open fsimonis opened 4 months ago

fsimonis commented 4 months ago

Currently, the tutorials are unstructured on the website.

It's a topnav item that leads to a sidebar containing all tutorials. This looks a bit odd and is also inconsistent with Docs and Community:

image image image

Docs and community have titles above the sidebar, while Tutorials doesn't. Also, there is only one pretty long folder containing all tutorials.

It may be an idea to categorize the tutorials into subfolders to split this list into logical parts and make the growing list of tutorials easier to digest. Example:

MakisH commented 4 months ago

We definitely need to structure the rapidly growing collection, in some way. Deal.II has a very nice overview: https://dealii.org/current/doxygen/deal.II/Tutorial.html

I think categorization (putting things in folders) is the wrong way, as several of our tutorials belong to multiple categories.

What we can easily do, instead, is tagging each tutorial with different tags, and render them in different categories: "these tutorials use OpenFOAM", "these tutorials do an FSI application", etc.

For this, we just need a jekyll collection with a field for tags. I already did something similar in the RSE learning and teaching resources and we have something similar for our publications here. We could have a more dynamic approach and nicer visualization, though.

This is definitely something for PreECO.

Docs and community have titles above the sidebar, while Tutorials doesn't.

I guess this is easy to add, no?

MakisH commented 3 months ago

As @uekerman pointed out in #368, we still have the same issue with the sidebar in the "further cases". We should either fix that (I cannot find any quick fix), or at least add categories in the sidebar. Contradicting what I wrote above, maybe introducing some rough categories now would be 90% of a solution, and we could duplicate if we think that something should belong to multiple categories.

I would go with:

with the intention to rework the categories in the future.

Opinions?

uekerman commented 3 months ago

I would suggest to wait for a proper preECO solution for the categorization. Instead, we should try to fix the technical issue after the distribution release. @chlorenz OK?

MakisH commented 3 months ago

Another easy fix that makes sense would be to group together all the semi-duplicates (flow over heated plate direct, two meshes, nearest projection), at least in the sidebar.

uekerman commented 3 months ago

as "flow over heated plate collection"? sounds good.

MakisH commented 3 months ago

FYI, I still consider this open, even after merging #372: Let's introduce some tags eventually.

MakisH commented 2 months ago

I imagine this as a product filter in an online store:

Very useful for users and for us to discover where we use what.