[Paraview-developers] ParaView User's Guide

Utkarsh Ayachit utkarsh.ayachit at kitware.com
Thu Jan 15 17:40:47 EST 2015


Folks,

The ParaView User's Guide is very close to being ready for the public.
As several of you know, it has now moved to LaTeX files. Now the next
question is where do these live? Our original plan was to include the
files in the ParaView source repository itself. That would make it
easier to enforce that developer document UI changes along with the
commits that change the UI/Python API etc. However, the source files
(and high resolution images) are close to 500 MB, hence not ideal for
inclusion in the ParaView source.

Another option is to put that in a separate repository. Then, to
enforce the "document as you go" requirement, we won't approve merge
requests (once we move to gitlab, or topics on gerrit until then)
unless the commit log references a commit in the documentation
repository.

Any other suggestions? What are people's thoughts?

Utkarsh


More information about the Paraview-developers mailing list