Forwarding since Fred is having some issue getting his mail through to the list...<br><br><div class="gmail_quote">---------- Forwarded message ----------<br>From: <b class="gmail_sendername">Fred van Dijk</b> <<a href="mailto:fredvd@gmail.com">fredvd@gmail.com</a>><br>
Date: Thu, May 1, 2008 at 4:11 PM<br>Subject: Fwd: Reference documentation and workflow<br>To: <a href="mailto:kamon.ayeva@gmail.com">kamon.ayeva@gmail.com</a><br><br><br>---------- Forwarded message ----------<br>
From: Fred van Dijk <<a href="mailto:fredvd@gmail.com">fredvd@gmail.com</a>><br>
Date: Thu, May 1, 2008 at 4:08 PM<br>
Subject: Reference documentation and workflow<br>
To: <a href="mailto:Grok-dev@zope.org">Grok-dev@zope.org</a><br>
<br>
<br>
Hello Grokkers,<br>
<br>
At the sprint Uli Fouqet has finished and checked into trunk the<br>
autogeneration of the documentation in Grok to html. It would be great<br>
toto have this documentation on the Grok website.<br>
<br>
However, there's already a Plone Help Center (PHC) documentation<br>
section on the website with howto's and tutorials. We (Kamon & me at<br>
the Grokkerdam sprint) feel that both have a place in the<br>
documentation story and would like to suggest the following<br>
'workflow':<br>
<br>
The svn generated documentation will be the official reference manual.<br>
You need svn access for it and the grok core developers can maintain<br>
this part, include suggestions from others and keep it sane. The<br>
reference manual contains the grok reference and the official<br>
'beginners' tutorial, but no other tutorials or howto's.<br>
<br>
Hopefully a rewrite rule can be set up on the website and make<br>
<a href="http://grok.zope.org/reference" target="_blank">http://grok.zope.org/reference</a> a link to the reference manual. Maybe<br>
even <a href="http://grok.zope.org/reference/0.12" target="_blank">http://grok.zope.org/reference/0.12</a> and a /latest to accomodate<br>
for multiple versions.<br>
<br>
The PHC on the <a href="http://grok.zope.org" target="_blank">grok.zope.org</a> can contain tutorials, howto's and other<br>
user contributed content. If people want to help out with<br>
documentation we can give them access to the PHC, without them needing<br>
svn access to <a href="http://svn.zope.org" target="_blank">svn.zope.org</a>. If material on the PHC is deemed genenal<br>
enough, those with svn access can include it in the reference<br>
documentation.<br>
<br>
One thing we should be cautious about though is that half finished or<br>
'in progress' documentation should not show up in the autogenerated<br>
html on the website. Either there could be a separate 'in progres'<br>
directory in svn, writers can put their stuff on the PHC first, or we<br>
only put the 0.1X and further official released versions on the<br>
website.<br>
<br>
Your feedback & suggestions please.<br>
<br>
Greetings,<br>
<font color="#888888"><br>
Fred van Dijk<br>
</font></div><br>