<html><body bgcolor="#FFFFFF"><div>Switching to another less popular doc format doesn't seem like a great idea. I don't work with the documentation frequently, but I'd ask people that do.</div><div><br></div><div>One thing is that some of these formats are like fads... they come and go. I remember not long ago when SGML was all the rage. :-) From my perspective it would be good to have a format that has good tools available (multiple implementations, at least some of which are portable to other platforms), displays nicely, and provides some basic structure capabitilities to assist in parsing for content or format conversion (e.g. to HTML).</div><div><br></div><div>If you make me install a bunch of new tools, or learn a format that nobody else uses, I probably will be less inclined to write documentation. (That said, I've not written much except a few man pages, and the format of *those* is relatively constrained by the need to be able to display them with the man command. :-)<br><br> -- Garrett D'Amore</div><div><br>On May 30, 2011, at 2:22 AM, "Tobias Famulla" <<a href="mailto:uni@famulla.eu">uni@famulla.eu</a>> wrote:<br><br></div><div></div><blockquote type="cite"><div>
Dear all Developers,<br>
<br>
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.<br>
<br>
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.<br>
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.<br>
<br>
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.<br>
<br>
Sincerely,<br>
<br>
Tobias<br>
<br>
-------- Original-Nachricht --------
<table class="moz-email-headers-table" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<th align="RIGHT" valign="BASELINE" nowrap="nowrap">Betreff: </th>
<td>[OpenIndiana-discuss] Documentation-Project</td>
</tr>
<tr>
<th align="RIGHT" valign="BASELINE" nowrap="nowrap">Datum: </th>
<td>Thu, 26 May 2011 15:54:36 +0200</td>
</tr>
<tr>
<th align="RIGHT" valign="BASELINE" nowrap="nowrap">Von: </th>
<td>Tobias Famulla <a class="moz-txt-link-rfc2396E" href="mailto:ebay@famulla.eu"><<a href="mailto:ebay@famulla.eu">ebay@famulla.eu</a>></a></td>
</tr>
<tr>
<th align="RIGHT" valign="BASELINE" nowrap="nowrap">Antwort
an: </th>
<td>Discussion list for OpenIndiana
<a class="moz-txt-link-rfc2396E" href="mailto:openindiana-discuss@openindiana.org"><<a href="mailto:openindiana-discuss@openindiana.org">openindiana-discuss@openindiana.org</a>></a></td>
</tr>
<tr>
<th align="RIGHT" valign="BASELINE" nowrap="nowrap">An: </th>
<td>Discussion list for OpenIndiana
<a class="moz-txt-link-rfc2396E" href="mailto:openindiana-discuss@openindiana.org"><<a href="mailto:openindiana-discuss@openindiana.org">openindiana-discuss@openindiana.org</a>></a></td>
</tr>
</tbody>
</table>
<br>
<br>
<pre>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
<a class="moz-txt-link-abbreviated" href="mailto:OpenIndiana-discuss@openindiana.org"><a href="mailto:OpenIndiana-discuss@openindiana.org">OpenIndiana-discuss@openindiana.org</a></a>
<a class="moz-txt-link-freetext" href="http://openindiana.org/mailman/listinfo/openindiana-discuss"><a href="http://openindiana.org/mailman/listinfo/openindiana-discuss">http://openindiana.org/mailman/listinfo/openindiana-discuss</a></a>
</pre>
</div></blockquote><blockquote type="cite"><div><uni.vcf></div></blockquote><blockquote type="cite"><div><span>_______________________________________________</span><br><span>oi-dev mailing list</span><br><span><a href="mailto:oi-dev@openindiana.org">oi-dev@openindiana.org</a></span><br><span><a href="http://openindiana.org/mailman/listinfo/oi-dev">http://openindiana.org/mailman/listinfo/oi-dev</a></span><br></div></blockquote></body></html>