[documentation] Proposal to open up editing rights

[Mike Parisi]

I am sitting here looking at my PDD, the API doc, and Google like mad trying 
to find examples on how to use the hook_form_alter().  One thing that WORKS 
and that I have purposed in the past is the PHP.org type system where there 
are comments to the API.

The problem with this PHP.org is that some comments are incorrect and have 
to be corrected, no one has permissions to do this so the comments become 
replies after replies after replies.  Maybe we should just give everyone 
permission to write and edit comments to the documentation.  Even give them 
the ability to edit other peoples comments.  I know there is some 
restriction to the API that prevents this so maybe we should just link each 
API and Document to an open WIKI page.

Mike

--------------------------------------------------
From: "Addison Berry" <drupal at rocktreesky.com>
Sent: Saturday, August 30, 2008 8:44 AM
To: "A list for documentation writers" <documentation at drupal.org>
Subject: Re: [documentation] Proposal to open up editing rights

> We can agree to disagree on the freelinking. :-) As for the Getting
> started guide, that will be restricted already in the current
> proposal. The theme handbook could be too, but probably not wholesale.
> Keep in mind that any page with images will not be editable by regular
> users. So, that said, it sounds like what you want is what the current
> proposal would achieve.
>
> - Addi (add1sun)
>
> On Aug 30, 2008, at 1:06 PM, Victor Kane wrote:
>
>> Well, I think personally that the freelinking aspect could be a big
>> boost, although it is not necessary to include it.
>>
>> My main concept about wiki and crowdsourcing is that you can maintain
>> a "wiki" area where a given set of authorized users (could be any
>> registered user) can create and edit and link, and that the actual
>> usefulness is something that can be proven in time. You don't have to
>> draw up any complicated set of rules and procedures. The value comes
>> from the crowd actually doing it.
>>
>> At the same time the more classic "Getting started" and generally
>> acknowledged high quality stuff like the theming overview can be set
>> apart in a more controlled area.
>>
>> Just my two cents. Keep up the great work, documentation team!
>>
>> Victor Kane
>>
>> On Sat, Aug 30, 2008 at 7:43 AM, Addison Berry
>> <drupal at rocktreesky.com> wrote:
>>> Uh, well opening up edit rights is pretty much the wiki concept.
>>> Everyone can already create new pages right now. This proposal is to
>>> let them edit it too. Beyond that, I hate the idea of wiki formats
>>> and
>>> don't think that will be a big boost and most likely leads to more
>>> confusion. I also think that the freelinking aspect that is often
>>> associated with a wiki is bad for structured information. The
>>> semantics or the terminology used doesn't matter, it's the use of the
>>> thing. So what exactly do you mean by wiki that isn't what we are
>>> proposing already?
>>>
>>> Addi (add1sun)
>>>
>>> On Aug 30, 2008, at 10:18 AM, Victor Kane wrote:
>>>
>>>> I hear what Michelle is saying...
>>>>
>>>> This calls for an industry standard. I think there are traditional
>>>> tools for crowdsourcing documentation, which is a great idea.
>>>>
>>>> It's called a wiki.
>>>>
>>>> On the other hand, the existing documentation as docs can still
>>>> stand,
>>>> which can be either open / closed according to the discussion of
>>>> those
>>>> most active (meritocracy rights).
>>>>
>>>> On the other... a Drupal Wiki section!
>>>>
>>>> Then the result can be voted by people's legs (i.e. concrete
>>>> results)
>>>> and not our abstract speculation here.
>>>>
>>>> Maybe the wiki will be a disaster... most aren't :)
>>>>
>>>> Victor Kane
>>>> http://awebfactory.com.ar
>>>>
>>>> On Fri, Aug 29, 2008 at 11:53 PM, Cathy Theys (Yes! Training and
>>>> Education) <cathy.theys at yestrainingandeducation.com> wrote:
>>>>> 1) what if *anyone* could submit a revision
>>>>> 2) (with a simple, simple cvs like change log/note
>>>>> 3) [provide example/check box like: fixed typo, corrected
>>>>> information,
>>>>> clarified wording, major update]),
>>>>> 4) but it had to be approved... by a member of the doc group.
>>>>> 5) and *anyone* could join the doc group (like it is now, request -
>>>>>> welcome!)
>>>>> -Cathy
>>>>>
>>>>> On Fri, Aug 29, 2008 at 6:11 PM, Wolf Zirbs <wolf.zirbs at gmail.com>
>>>>> wrote:
>>>>>> In consideration that we all have responsability to provide exact
>>>>>> and easy
>>>>>> documentation it should also take care of a standard of quality
>>>>>> and security
>>>>>> on who is going to cooperate.
>>>>> --
>>>>> Pending work: http://drupal.org/project/issues/documentation/
>>>>> List archives: http://lists.drupal.org/pipermail/documentation/
>>>>>
>>>> --
>>>> Pending work: http://drupal.org/project/issues/documentation/
>>>> List archives: http://lists.drupal.org/pipermail/documentation/
>>>
>>> --
>>> Pending work: http://drupal.org/project/issues/documentation/
>>> List archives: http://lists.drupal.org/pipermail/documentation/
>>>
>> --
>> Pending work: http://drupal.org/project/issues/documentation/
>> List archives: http://lists.drupal.org/pipermail/documentation/
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/