On Dec 6, 2007 11:53 AM, Chris C. <[EMAIL PROTECTED]> wrote:
>
> On 6 Dez., 01:30, jm <[EMAIL PROTECTED]> wrote:
> > maddiin wrote:
> > > This way no accounts are needed and everyone could contribute on the
> > > mailing list. The last word would be up to Yariv leading the way, so
> > > it would be something official. Also spam and moderating in general
> > > would be less time consuming.
> >
> > Could you elaborate on this (no accounts)?
> >
> > Jeff.
>
> I'll do, as I am his brother. :-)
> A free-for-all wiki will soon end up in maintenance hell, or otherwise
> with
> lovely spam of all sorts. Forcing registration here would be a not-so-
> cool
> solution to this problem.
>
> I had the idea to use the same development model which is used for
> erlware's
> code base.
> For more information on that one, read the section "The Development
> Model"
> under: 
> http://erlangish.blogspot.com/2007/10/erlware-and-git-development-model.html
> In short: Contributors clone the documentation-repo, make local
> changes until they're
> happy and then send a patch to a separate erlyweb-docs-mailinglist.
>
> I'd like to give some more info on what maddiin wrote here:
> > What we are thinking of instead of a wiki is building a tutorials
> > section using ReST-documents pulled off a control versioning system,
> > might it be git, mercurial or svn.
>
> Take a look at the docs of the djangoproject, where they use such an
> approach.
> Here's an example:
> http://www.djangoproject.com/documentation/cache/
>
> This is the corresponding source code of this piece of documentation
> (written in restructured text):
> http://code.djangoproject.com/svn/django/trunk/docs/cache.txt
>
> And here's the code they use for building web pages from the source
> code:
> http://code.djangoproject.com/svn/djangoproject.com/django_website/apps/docs/
>
> Kind Regards,
> Chris

So patches would be sent to the mailing list, and merged into the
documentation repository from which the documentation would be
generated?

I think this is a good idea in principle. My only concern is that the
current documentation is embedded in the source code, so this new
system could be used for new tutorials but I don't know if it will
work for the bulk of the docs.

Btw I don't mind giving svn access to anyone who wants to improve the
API docs -- just send me your proposed revisions first just so I can
make sure they look good.

Yariv

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"erlyweb" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/erlyweb?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to