Welcome, Guest
Username: Password: Remember me

TOPIC: Wiki outdated - consider merging documentation in a unique site/repo

Wiki outdated - consider merging documentation in a unique site/repo 1 month 1 week ago #47515

  • tomsail
  • tomsail's Avatar
  • OFFLINE
  • Junior Boarder
  • Posts: 53
  • Thank you received: 19
I got back in TELEMAC recently to install opentelemac with CMake for the conda package.

All installation notes in the wiki wiki.opentelemac.org/doku.php are all very outdated.

I figured the only place to find the Cmake is on the git gitlab.pam-retd.fr/otm/telemac-mascaret/...NG.md?ref_type=heads

Practically, I'd suggest to take down the wiki completely.

Post a link redirecting to the gitlab for installation and docs.

Have the gitlab README redirecting all users (beginners, advanced, pros etc) to online docs generated by the git.

This would avoid the overhead of keeping the wiki up to date.
The administrator has disabled public write access.

Wiki outdated - consider merging documentation in a unique site/repo 2 weeks 4 days ago #47536

  • borisb
  • borisb's Avatar
  • OFFLINE
  • Admin
  • Posts: 131
  • Thank you received: 75
Hi Thomas,

In fact, the entire website is out of date and is about to be replaced by a new site with up-to-date content and a more modern design.

As for the wiki, it has been replaced by GitLab Pages, which I recently introduced via a MR merged two days ago: otm.gitlab-pages.pam-retd.fr/telemac-mascaret/index.html.

This is an preliminary version which will be expanded and will soon include:
- Doxygen documentation for the Fortran source code
- Sphinx documentation for the Python scripts (the conversion of these from Doxygen to Sphinx is currently underway)
- A section explaining how to contribute to the project.

Later on, we may add the openTELEMAC module manuals (user, reference, validation and theory guides) so that they can be read online without having to download the PDFs.
The administrator has disabled public write access.

Wiki outdated - consider merging documentation in a unique site/repo 2 weeks 3 days ago #47539

  • tomsail
  • tomsail's Avatar
  • OFFLINE
  • Junior Boarder
  • Posts: 53
  • Thank you received: 19
Great, nice job on the online documentation, it reads very well.

Yes, an online version of the documentation would help in several ways:
- by pointing out to a specific part of the manual to users/colleagues, enabling faster research and collaboration
- by exposing the manuals to agents, you'll enhance the quality of their context. Exposing the developer manual would also greatly help, as the procedure for implementing new features and keywords is quite tedious.
The administrator has disabled public write access.

The open TELEMAC-MASCARET template for Joomla!2.5, the HTML 4 version.