plumed / plumed2

Development version of plumed 2
https://www.plumed.org
GNU Lesser General Public License v3.0
357 stars 284 forks source link

Tutorials are harder to find #1013

Open invemichele opened 8 months ago

invemichele commented 8 months ago

There is no longer the "tutorials" entry in the index of plumed doc, and even links to individual tutorials are gone

Master: Screenshot_2024-01-30-08-37-07-66_c0dc27f5c07cb0fb3541d6073dfd6932~2

v2.9: Screenshot_2024-01-30-08-38-04-36_c0dc27f5c07cb0fb3541d6073dfd6932~2

gtribello commented 8 months ago

Hi @invemichele

The Masterclass on OPES is still there and can be found at this link:

https://plumed-school.github.io/lessons/22/003/data/NAVIGATION.html

If you would like to put the second tutorial on that page on the plumed-tutorials site above then you can follow the instructions here:

https://plumed-school.github.io/contribute.html

so that it appears on the new tutorial site. You can still find the text of that tutorial in the plumed2 GitHub repository. It has not been deleted. Converting the tutorial from Doxygen to markdown should not take longer than 30 minutes.

We removed the old tutorials page in the plumed manual because there is a lot of duplication in the tutorials that appear on that page. Furthermore, there are things in some of my (and possibly some of the other) older tutorials that are wrong. It is frustrating when you see folks on the mail lists asking questions about the Trieste tutorial on errors (which I wrote) when you know that the newer versions of this tutorial cover this material better. We planned to send out an email explaining this change but perhaps we forgot. If that is the case then my apologies.

If you want you can modify the page you included the screenshot of so that it contains links to the tutorials on the new tutorial pages. However, notice that you can search the new tutorials page by action name. If I do a search for OPES_METAD I find that the following tutorials use this action:

tute-opes

I think that using this functionality to find tutorials on particular actions or the code in particular modules is better in the long run as the indexing does not have to be maintained by a human being. If we use the functionality on the tutorials page the tutorials are indexed automatically. Furthermore, if we have this functionality on the tutorials page it can be (and has been) transferred to the nest.

I think it may be possible to create a link to the browse page and to fill the search bar on that page with keywords relevant to the OPES method. I haven't worked out how to do it yet. It is on my to do list, however. If you know how to do it already please share it. I would be cool to have a link that you can click on that says "see tutorials on this action" or "see eggs that use this action".

carlocamilloni commented 8 months ago

@gtribello maybe the issue is that is not easy (actually i couldn' myself) to find how to reach the plumed school website. How one is supposed to find it? we should add links to it in multiple places like the manual (maybe directly from the TUTORIAL button?) the plumed.org page the plumed-nest page and so on

gtribello commented 8 months ago

@carlocamilloni the change I made ensures that if you click on the tutorials button in the manual the plumed-school website opens. That was why I made the change to plumed.

carlocamilloni commented 8 months ago

@gtribello this is ok, but we still need to propagate the link to the other pages we have in both the manual (were tutorial are mentioned) and the static pages (plumed.org/doc and plumed-nest.org), also because the manual is related to a specific version of the code so the link will work from master but not from 2.9/2.8 etc. I mean since the new tutorial page is better we should help the users to find it ;-)

invemichele commented 4 months ago

Hi @gtribello, I just noticed that most of the links here are broken https://www.plumed.org/masterclass ~Also, there seems to be a problem here https://plumed-school.github.io/manual.html~ Everything else I tested works as expected!