perfsonar development work

["Jeff W. Boote" <>]

Loukik Kudarimoti wrote:
> 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 totally agree with using svn this way. It is very useful to let it show the 
'latest' version of a document. :)

> 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.

I agree with the doc break-down.

> 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.
>

The schema break-down I'm struggling with some. I don't like a service by 
service breakdown. I envision many services using the same schema (using the 
same message types). For example, the MA and MP implement some of the same 
message types. And, I expect them both to implement some of the LS message types 
in the future.

I would prefer something that organized based on message type and data type. 
And, I actually like the way it is currently divided between base schema (rnc's) 
and examples (instance docs). So, I would prefer to keep the existing 
organization under 'schema'. But, I agree the examples (instance docs) 
organization needs work. How about something like:

perfsonar/schema        # current rnc's (including sub-dir's)
	# But, documentation needs to be added. I'm somewhat ambivalent if this is done 
by better annotations in the rnc's, or done with documents on the side. (All 
things being equal, I would probably prefer annotations - I would expect that to 
stay in sync with the rnc better.)

perfsonar/schema-profiles/
                overview_of_metadata-data_structure.html
                /messages/
                        message_description.(anything but .doc ;) )
                                # includes how different data types are 
included
                        # examples of messages
                        SetupData.xml
                        KeyRequest.xml
                /datatypes/
                        /ping/
                        /snmp-utilization/
                        /owamp/

jeff