[Grok-dev] Re: [website] Let's do content!
noah.gift at gmail.com
Thu Jan 3 21:18:46 EST 2008
On Jan 3, 2008, at 2:12 PM, Martijn Faassen wrote:
> Noah Gift wrote:
>> On Jan 2, 2008, at 1:47 PM, Martijn Faassen wrote:
>> There is nothing like getting free help on documentation! This was
>> a brilliant idea for Django, who regardless of your feelings about
>> their framework, did documentation at a level that should be
>> aspired to.
> The reason we want to get to a Plone-based website is to get more
> help on documentation. :)
> Does Django allow online commenting or editing? I see a comment
> feature, but please tell us more!
I noticed that Django had a great strategy, as I mentioned in another
email, of documenting a book first, publicly. People could comment on
the book, but not edit the book. Since I am writing a book currently
for O'Reilly, I know that we are using docbook. I have no idea how an
author would proceed on trying to do a write once open book though, as
that seems tricky, especially with Plone. I guess it might have to be
cut and pasted, but still giving people the ability to at least
comment is a great idea. I suppose having some wikipedia style system
to allow people to edit would be very helpful too, as you could get
some great real world tricks.
The first impression for people new to Django of having a complete,
and extremely accurate book online for people is tremendous to say the
least. This is a model to follow for Open Source Projects, and flips
traditional book writing on its head. I think it also leads to a
better incentive for authors to document their project, as they are
finally getting paid for their work as they do it.
> I agree that an online commenting feature would be extremely useful
> for the tutorial and the other documents. I'm just saying we should
> get it online as simply as possible right now as we don't want to
> delay the website work with more complicated requirements. We should
> continue to work on getting it easy for people to contribute to our
> documentation, including the tutorial.
> Grok-dev mailing list
> Grok-dev at zope.org
More information about the Grok-dev