Re: how to contribute docs

Alexander Limi <limi-z4DKO/[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On Fri, Jan 15, 2010 at 12:58 PM, David Hostetler <[email protected]>wrote:

> I'm dismayed by that.  Some of the most invaluable nuggets of info I've
> ever found when dealing with Plone were comments added to documents on
> plone.org.   I might suggest that the problem isn't that comments are
> 'hard to maintain' but rather that frequently the documents themselves were
> utterly abandoned, and people other than the original author were the ones
> keeping the information relevant via the comment thread.
>

Right. The new approach is:

   - If it's in the Knowledge Base, you can edit it directly to fix things
   (or contact the author, of course — your choice)
   - If it's in the official manuals, you file a ticket, and the editors
   will fix it.

It's not to discourage comments, but if you look around on other open source
projects, they have the same problem — comments always turn into ad-hoc
support and/or discussion. This confuses people that are new, and annoys
people that know better. For what it's worth, several other open source
projects are moving in the same direction (I think jQuery just did the same
thing to avoid the same issue).

What good is a dynamic CMS if not for allowing documentation to be refined
> over time and remain germane to its intended audience?
>

Totally agree, and that's why we'll have a more open editing policy in the
KB area once the transition is complete. As Veda mentioned, it still needs
some work, and I'm as guilty as any in not finishing my redesign tasks yet
on the UI side of things. But it's a priority, right now I'm head down in
Plone 4, but hope to get to it ASAP.

-- 
Alexander Limi · http://limi.net

------------------------------------------------------------------------------
Throughout its 18-year history, RSA Conference consistently attracts the
world's best and brightest in the field, creating opportunities for Conference
attendees to learn about information security's most important issues through
interactions with peers, luminaries and emerging and established companies.
http://p.sf.net/sfu/rsaconf-dev2dev

_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.