Hi Jerome: On Thu, 17 Jun 2010, Jerome Caffaro wrote: > I especially have great expectations from the HOWTOs sections. I am > sure there are plenty of Invenio admin/users who keep their own > detailed instructions on how to perform some standard tasks. This is > could be the perfect place to share them.
Yes. > Not sure this is the idea behind this HOWTOs category (and this wiki), > but I can see well a specific HOWTO topic growing little by little with > small additions, until the day it can maybe all be compiled and revised > into a guide to be integrated right into the Invenio software. This is > back to the question of (t)wiki VS Invenio guides. I like the idea of > having locally installed documentation, but I also like the idea of > (draft) user-contributed documentation in an easy-to-use system (VS > Git/WebDoc). Exactly. I'm also concerned by this dichotomy, especially WRT hacking guides that are still living as webdocs while they could be part of the wiki, e.g. release numbering, e.g. common concepts, e.g. test suite strategy. This webdoc-vs-wiki dichotomy was born kind of historically, we should probably move most (all) of hacking guides to either (1) wiki pages or (2) epydoc-generated code browser API documentation pages. There should be no need to document APIs separately when we have <http://cdsware.cern.ch/invenio/code-browser/invenio.shellutils-module.html>. (User and Admin guides should still stay in release-specific local webdocs, of course.) > (Well I guess you are suggesting initial categories that can be > populated with up-to-date content right from the beginning. Otherwise > we'll also need more Installation/InvenioOnFooBar, for eg. > InvenioOnMacOSX) Yes. My example was non-exhaustive, just to illustrate the global picture. Best regards -- Tibor Simko
