[Grok-dev] Re: towards a release

Kevin Teague kevin at bud.ca
Sun Mar 9 17:09:49 EDT 2008


Documentation on the Grok web site can be associated with one or more  
releases. Most documentation right now is associated with "Any  
release" - which should be the default for new docs. Otherwise if you  
write docs based on release 0.11 and associate it with that release,  
when 0.12 comes out and the global "Latest Release Version" is  
updated, then all the 0.11 docs will be marked as "outdated". Instead,  
we just want to mark documents as outdated when we deprecate  
functionality - fortunately Grok is building on a lot of stable Zope 3  
packages, so for a 0.* framework it's relatively stable :)

This doesn't allow us to copy a "snapshot" or "Grok 0.12 release"  
frozen set of documents on the web site though. However, Uli has been  
doing work on the Grok Reference docs, which we can do release  
snapshots for. Over time we hope to grow out a "core" set of reviewed,  
official documents that gets snapshotted with each releaese, and the  
web site can host both these docs and the Plone Help Center content  
that serves as the "long tail" of documentation.

I said that I would help out with the Reference docs, but the weather  
has been unusually sunny  in BC these last couple weeks, so I've been  
working at "being a ski bum" instead :) I should get some rainy  
weekends eventually, as I do live on the "wet coast" ...

... so +1 for 0.12 as the next release, and +1 to having more complete  
docs for a 1.0 release.




More information about the Grok-dev mailing list