perfsonar development work

[Loukik Kudarimoti <>]

Hi,

One of the requirements for documentation is to be able to store 
different types of docs in a document management system. I believe that 
there is little/no disagreement amongst perfSONAR members that the 
documents need to be stored on the svn itself. Please correct me if I am 
wrong here.

I have written some documentation for SNMP MP which I would like to 
upload on the svn and right now its not so easy to figure out where it 
should go. Hence I thought of the following proposal. I haven't put too 
much thought into it but rather wanted to use it as a strawman for 
discussion.

perfsonar/doc directory on svn could have the following structure (refer 
to fig: perfsonar documentation structure.png):

* the root of the documentation (/doc) can be used for release notes, 
license, etc
* the doc/installation directory is meant for storing installation files 
using different directories. This directory can contain perfsonar suite 
release installation docs.
* doc/installation can have sub-directories per service (I thought about 
classifying based on service family : MP, MA, LS etc and within each 
family we could have a type - snmp mp under mp, etc. Somehow I wasn't 
convinced but I don't mind either ways). The installation docs per 
service could be one for each platform (windows, unix, etc) if needed. I 
can also think of basic and advanced installation docs but maybe they 
can be merged into the same file. The exact structure of these 
installation docs is something we haven't discussed about. Maybe its 
time to do so?

* the doc/design directory is meant for storing design documents.
* We need similar sub-directories here. I again propose to have one per 
service (see diagram). The design documents will include UML diagrams. 
The sources for these uml diagrams (in .dia, the agreed format) needs to 
be placed in the /img directory so that if somebody wants to re-use 
them, they are easily available.
* We also need base directory to provide documentation for the perfsonar 
base.
* A template for such a design document is not yet avaiable. Perhaps we 
need to provide one now?

Extending the reach of this discussion, the perfsonar/schema directory 
needs work as well. My initial suggestion is in the figure (refer to 
fig: perfsonar schema documentation structure.png). We can also move the 
/schema to /docs/schema. I am ok both ways.

* doc/schema has a directory /nmwg where nmwg stuff will fit in (rncs, 
etc). This point needs more discussion
* doc/schema has a directory /base which will contain stuff common to 
all services. This point needs more thought as well.
* There will be one directory per service (SNMP MP, RRD MA, etc) which 
will contain specific xml examples, schema definitions per service and 
any related documentation.

I have also attached the .dia files in case somebody needs them for 
other proposals/discussions.

Regards,
Loukik.

Attachment: perfsonar schema documentation structure.dia
Description: application/dia-diagram

Attachment: perfsonar documentation structure.dia
Description: application/dia-diagram