Welcome, Guest
Username: Password: Remember me

TOPIC: Documentation and wiki

Documentation and wiki 8 years 4 months ago #22256

  • Lux
  • Lux's Avatar
  • OFFLINE
  • Senior Boarder
  • Posts: 96
  • Thank you received: 39
Hello, Community!

I would like to share some ideas about the documentation of Telemac.
I am deeply grateful for the continuous effort of the whole community in documenting how to install and use telemac and its modules.
More specifically about the wiki available online (wiki.opentelemac.org/), I would have some questions :
  • What is its framework (or goal)?
    • It seems to include many topics (installation, pre-requisites, configuration, ...) and among them the "user manual" (available as pdf here : www.opentelemac.org/index.php/manuals)
    • Concerning this last point, is there not a danger to duplicate the present user manual within it? Will the wiki replace the present user manual in the future (and what about translation policy?)?

      - In my opinion, the wiki is suitable to include some new features :
      - a snippet section in which everyone could share its files (e.g. fortran and/or configuration files) associated with explanations in the wiki, about common needs/tasks. For instance, how to initialize/modify the bottom/friction/... by zones, define complex plan distribution, use private tables, ...
      - a reference manual (similar to dico) possibly included as a glossary
      - documentate some pre/post processing tools. Perhaps the scripts part could be included in this documentation (eventually automated generated from the comments written in the source files)
  • Is it (or will it) be possible to contribute? I completely agree about this philosophy : "feel free to consider contributing a section if you had to learn through the use of an existing feature without documentation so the next person looking for that information won't have to go through the same thing", but how to have writing access to the specific pages?

With my best regards,
Luc
The administrator has disabled public write access.

Documentation and wiki 7 years 7 months ago #26154

  • Lux
  • Lux's Avatar
  • OFFLINE
  • Senior Boarder
  • Posts: 96
  • Thank you received: 39
Is there any recent progress toward a collaborative documentation, such as a wiki?
Will the actual dokuwiki persist? Are contributions possible somehow?
Thank you for any information about that.

I take advantage of this post to inform the maintainers that the current wiki is at the present time not reachable with a Network Access Message (delivered by the from Microsoft Forefront TMG?). It has been solved immediately afterwards.
The administrator has disabled public write access.

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