[Grok-dev] Community Documentation

[Thibaud Morel l'Horset]

I think one big area where there is a crucial need for more / better
documentation is around authentication. Nowadays every site needs to have a
robust login system with user registration, e-mail confirmation, etc. If
you're using Grok on its own, as I am, to do your project then it takes a
whole lot of work just to understand how to get a basic login system going
and that can be a big enough problem to make you consider alternatives...

megrok.login is a huge step in the right direction and I am in the process
of writing a doc about how to use it to set up a grok authentication / user
registration system "with batteries". I still need to work out issues I'm
having with modifying the session timeout of the auth cookies though...

In my humble opinion, how a framework handles authentication will be a huge
deal breaker when it comes to new users trying to adopt the framework.

Anyway like I said I'm working on a doc about this myself, but I figured I'd
mention this since we're talking about community docs as a whole.

- Thibaud

On Fri, May 22, 2009 at 9:27 AM, Paul Wilson <paulalexwilson at gmail.com>wrote:

> 2009/5/22 Tim Cook <timothywayne.cook at gmail.com>
> >
> > I want to volunteer to help review community documentation on the Grok
> > site.
> >
> > I need to get up to speed on some things as far as editing goes but I'm
> > happy to do that if the team can use some help.
>
> I know that the following documentation is outdated or contains
> inaccuracies:
>  * Annotations - (what is ISerialBranding? And perhaps a note about
> registering IAnnotations during testing)
>  * REST support (grok.RESTProtocol is used when grok.restskin(name) is
> favoured)
>  * Grok Templates (multiple issues arising from the spin-out of
> grokcore.component)
>
> I think an action needs to be taken to update the appropriate
> documentation whenever a component / interface has changed.
>
> Thanks,
> Paul
> _______________________________________________
> Grok-dev mailing list
> Grok-dev at zope.org
> http://mail.zope.org/mailman/listinfo/grok-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.zope.org/pipermail/grok-dev/attachments/20090522/e70c38b3/attachment-0001.html