[oi-dev] Fwd: [OpenIndiana-discuss] Documentation-Project

[Tobias Famulla]

Dear all Developers,

As I mentioned on the Discussion-List(see below), I had the idea of
transforming the OpenSolaris-documentation to another system and change
some parts to the OpenIndiana specific behaviors.

Deano wrote on the Discussion-list, that it might be more helpful, to
discuss the pros and cons of different systems and especially asking for
people who also write the discussion and maintain it afterwards.
I think I am not able to maintain such documentation, because I am very
new to the OpenIndiana and Solaris operating system and such
developement process as a whole.

Because of that, I would ask on this list, if anybody sees the
importance of an documentation, sees advantages of a special
documentation system and would be able to maintain it. The other
question is of course, whether the below described idea is an good one,
or work on another part would be more helpful.

Sincerely,

Tobias

-------- Original-Nachricht --------
Betreff: 	[OpenIndiana-discuss] Documentation-Project
Datum: 	Thu, 26 May 2011 15:54:36 +0200
Von: 	Tobias Famulla <ebay at famulla.eu>
Antwort an: 	Discussion list for OpenIndiana
<openindiana-discuss at openindiana.org>
An: 	Discussion list for OpenIndiana <openindiana-discuss at openindiana.org>



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

_______________________________________________
OpenIndiana-discuss mailing list
OpenIndiana-discuss at openindiana.org
http://openindiana.org/mailman/listinfo/openindiana-discuss


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://openindiana.org/pipermail/oi-dev/attachments/20110530/c1271847/attachment-0004.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: uni.vcf
Type: text/x-vcard
Size: 121 bytes
Desc: not available
URL: <http://openindiana.org/pipermail/oi-dev/attachments/20110530/c1271847/attachment-0004.vcf>