[Grok-dev] Re: towards a release

[Tim Knapp]

Hi Martijn/Justin et al,

Just a thought, in previous version of PHC you could specify a relevant
Plone version that the document applies to (hopefully this feature is
still there). Couldn't we just repurpose this feature for Grok?

HTH,
Tim

On Fri, 2008-03-07 at 17:49 +0100, Martijn Faassen wrote:
> Hey Justin,
> 
> Thanks for your comment on the documentation, I think that's a valuable 
> point.
> 
> We need to see how to organize the website to do this. I'm looking at 
> Kevin Teague now for advice on whether plone help center would allow 
> such a thing.
> 
> The way we could work is to have the documentation in the present 
> location always reflect the most recent release.
> 
> Then, as we make a release, we copy all that documentation into its own 
> section named after the release. The hardest part will be to fix up all 
> the internally pointing URLs to be consistent...
> 
> This way, we could keep a record of the state of the documentation at 
> release. We need to couple this with clear guidelines concerning the 
> main flow of documentation: it should only contain documents relevant to 
> the most recent release, and not anything that won't work anymore or not 
> yet.
> 
> There is a need to develop documentation ahead of time for a new 
> release. This could be done in SVN trunk, or in some special area on the 
> website. Upon release, *before* we shift the documentation off into its 
> own section, we should integrate all this into the main section.
> 
> There is enough to watch and work out here to need someone who shepherds 
> this process. Without a plausible volunteer I don't think we have enough 
> resources to afford this right now. Instead we should then just focus on 
> maintaining the current set of documentation to be up to date.
> 
> Regards,
> 
> Martijn
> 
> _______________________________________________
> Grok-dev mailing list
> Grok-dev at zope.org
> http://mail.zope.org/mailman/listinfo/grok-dev