[OpenIndiana-discuss] Documentation-Project

Tobias Famulla ebay at famulla.eu
Thu May 26 13:54:36 UTC 2011


Hello OpenIndiana-Community,

I am in an Open-Source-seminar at University, in which we have to hold a 
presentation about an Open-Source project and participate in the 
development-process of this project.

I chose OpenIndiana for this Course, because I think it is an 
interesting young project and the developement of a free Solaris is 
important for the open-source-community.

Becaus it lacks in a good documentation of OpenIndiana yet, as far as i 
read in the wiki, I had the idea of writing a script to transform the 
latest OpenSolaris documentation  from XML to a 
Sphinx-documentation(restructuredText) and rewrite it in some parts. I 
think Sphinx is a wonderful tool to write a good documentation and 
export it to html and pdf. It might be easier to handle these documents 
than the XML ones.

If you like the idea of writing the OpenSolaris-documentation in Sphinx, 
it might be helpful to integrate it in the revision control system to 
have an easy way to manage the documentation.

On another point, it would help me for the presentation, if someone 
writes me, how decisions for the project are made and how the project is 
managed(commitments to the sourcetree and something like that)

Sincerely yours,

Tobias Famulla



More information about the OpenIndiana-discuss mailing list