Mailing-List: contact general-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: general@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of gary.martin@wandisco.com
 designates 209.85.215.175 as permitted sender)
Message-ID: <502235CB.2000002@wandisco.com>
Date: Wed, 08 Aug 2012 10:47:55 +0100
From: Gary Martin <gary.martin@wandisco.com>
User-Agent: Mozilla/5.0 (X11; Linux x86_64;
 rv:14.0) Gecko/20120714 Thunderbird/14.0
MIME-Version: 1.0
To: general@incubator.apache.org
Subject: Re: [RT] a minimal set of docs for incubator.apache.org
References: 
 <CAEWfVJk_AxrzmbM=8g8kvwrr8w_=k4soXUfdEhXP2qh4y5Db4Q@mail.gmail.com>
 <CABD8fLU1rAYFFKReN7jxWVn6jE_UxJW3VBrDsgfn=JXo_iUfpw@mail.gmail.com>
In-Reply-To: 
 <CABD8fLU1rAYFFKReN7jxWVn6jE_UxJW3VBrDsgfn=JXo_iUfpw@mail.gmail.com>
Content-Type: multipart/alternative;
 boundary="------------000305030408010301080804"

--------------000305030408010301080804
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

Committing somewhere would be good as otherwise I don't know whether I 
need to suggest the following (I wasn't sure of the best thread for this 
to go in anyway):

    May I suggest that, where appropriate, the documentation is backed
    up with pointers to examples of existing projects that are
    considered to represent the current best practice on various
    aspects. Whilst clear documentation is fantastic, there is nothing
    like good examples for building confidence that one is doing things
    in the right way.

Cheers,
     Gary


On 08/08/2012 10:42 AM, Greg Stein wrote:
> Commit the content. Otherwise, we're just hand-waving.
> On Aug 8, 2012 5:29 AM, "Bertrand Delacretaz" <bdelacretaz@apache.org>
> wrote:
>
>> Hi,
>>
>> Like others, I'm not too happy with the current
>> http://incubator.apache.org/ content.
>>
>> How about starting a new, minimal set of docs that are more
>> maintainable and understandable?
>>
>> IMO, the following would be sufficient, with one page per topic:
>>
>> 1. What's the Apache Incubator? (homepage)
>> 2. Lifecycle of a podling, from proposal to graduation, with many
>> links to existing examples (proposals, committer votes, graduation
>> threads, etc.)
>> 3. Release checklist: criteria for approving a release
>> 4. Previously asked questions (a la
>> http://www.apache.org/legal/resolved.html, includes IP clearance info)
>> 6. Glossary of terms (though that might belong to the top-level
>> apache.org site instead)
>>
>> I'm just considering the narrative info, not the podling status pages
>> or clutch stuff in this refactoring. That status info might move to
>> podlings.incubator.apache.org to better separate it and keep the main
>> site minimal.
>>
>> I've got some draft content for 2. and 3., that I've been collecting
>> in my mentoring activities.
>>
>> WDYT?
>>
>> -Bertrand
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
>> For additional commands, e-mail: general-help@incubator.apache.org
>>
>>


--------------000305030408010301080804--