Am 17.01.2011 13:52 schrieb Niklas Hambüchen:
I guess a possible improvement (and also a cool feature for Pyramid) is
a documentation system that is usable online for everyone, but still
integrates with the DVCS approach: A website that displays the docs, but
enables editing each paragraph in-place. It has its own hg repo behind,
so if somebody starts editing, a new hg branch is created and if editing
is done, a pull request is automatically filed on bitbucket.
Merged by a docs maintainer afterwards, the new docs are shown instantly.

But editing docs is not so simple if you have a sophisticated doc system like Sphinx. It involves properly formatting code (inline and sections), adding links (to pages or the API referenec), maybe tables or images, subheadings, bullet points etc. So if you let everyone contribute, we would even more need a documentation manager/supervisor who would do the quality assurance, spelling, grammar, overall style and filter out spam or misinformation. And then of course somebody who implements and maintains the system you describe. That could be simple and fun, but the admin and janitor work is what is important and both underestimated and unpopular.

-- Christoph

--
You received this message because you are subscribed to the Google Groups 
"TurboGears" 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/turbogears?hl=en.

Reply via email to