[vtk-developers] Static pages for VTKExamples

[Andras Lasso]

If VTK examples have their own dedicated wiki (and not mixed with user-contributed content) then it's a different story, most of the problems that I wrote about have much less impact.

But then why would you use wiki instead of other, well-established documentation generator tools? Auto-generated content would not benefit from collaborative editing capabilities of wiki, but you would still pay the price of it (in that you need a server to run it, it is probably less efficient than serving static html, you are more restricted in structure, formatting, etc).

Andras

-----Original Message-----
From: Ben Boeckel [mailto:ben.boeckel at kitware.com] 
Sent: Monday, May 15, 2017 2:33 PM
To: Andras Lasso <lasso at queensu.ca>
Cc: Bill Lorensen <bill.lorensen at gmail.com>; Will <will.schroeder at kitware.com>; VTK Developers <vtk-developers at vtk.org>; Andrew Maclean <andrew.amaclean at gmail.com>
Subject: Re: [vtk-developers] Static pages for VTKExamples

On Mon, May 15, 2017 at 18:09:28 +0000, Andras Lasso wrote:
> Versioning may be a one of the most difficult problem to solve. We use 
> MediaWiki to maintain Slicer documentation and we've found that 
> maintaining up-to-date documentation for multiple versions is 
> unsustainable (you have to create a large number of wiki pages for 
> each software version), creates confusion (as Google keeps directing 
> users to pages belonging to random software versions), and limits 
> access (you cannot distribute documentation as a package that can be 
> used offline). Hosting documentation on a github or other 
> documentation-oriented service (such as readthedocs) does not have 
> these issues.

Note that Gitlab's wiki is available via git:

    https://gitlab.kitware.com/lorensen/VTKExamples.wiki.git

--Ben