Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Categorize the tutorials #345

Open
fsimonis opened this issue Mar 7, 2024 · 7 comments
Open

Categorize the tutorials #345

fsimonis opened this issue Mar 7, 2024 · 7 comments
Labels
content Content-only issues technical Technical issues on the website

Comments

@fsimonis
Copy link
Member

fsimonis commented Mar 7, 2024

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:

  • Introduction
  • FSI
  • CHT
  • Fluid-Fluid
  • ...
@MakisH
Copy link
Member

MakisH commented Mar 7, 2024

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 MakisH added content Content-only issues technical Technical issues on the website labels Mar 22, 2024
@MakisH
Copy link
Member

MakisH commented Apr 7, 2024

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:

  • Basic cases
  • Conjugate heat transfer
  • Fluid-structure interaction
  • Partitioned heat conduction
  • Partitioned flows
  • Volume coupling
  • Further cases
    • ASTE turbine
    • Oscillator
    • Oscillator overlap
    • Partitioned elastic beam

with the intention to rework the categories in the future.

Opinions?

@uekerman
Copy link
Member

uekerman commented Apr 7, 2024

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
Copy link
Member

MakisH commented Apr 7, 2024

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
Copy link
Member

uekerman commented Apr 7, 2024

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

@MakisH
Copy link
Member

MakisH commented Apr 9, 2024

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

@MakisH
Copy link
Member

MakisH commented Apr 29, 2024

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

  • You go to the tutorials overview
  • You see a dynamically-generated list with all tutorials
  • You add tags in your filter and the list gets shorter

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Content-only issues technical Technical issues on the website
Projects
Status: Low
Status: WP2 Compile standard (2024-2025)
Development

No branches or pull requests

3 participants