You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@incubator.apache.org by Robert Burrell Donkin <ro...@gmail.com> on 2007/12/29 17:01:07 UTC
[doc] Guides verses Policy
recent experience suggests that the incubator documentation does a
poor job of helping podlings understand the difference between guides
and policy
the first section in http://incubator.apache.org/guides/index.html is
terse and obtuse. one possibility would be to expand this. it would
also be possible to create a meta guide (guideance about seeking
guideance).
opinions?
suggestions?
patches?
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] Guides verses Policy
Posted by Matthieu Riou <ma...@offthelip.org>.
On Jan 6, 2008 6:20 AM, Robert Burrell Donkin <ro...@gmail.com>
wrote:
> On Dec 29, 2007 4:39 PM, Roland Weber <os...@dubioso.net> wrote:
> >
> > Robert Burrell Donkin wrote:
> > > recent experience suggests that the incubator documentation does a
> > > poor job of helping podlings understand the difference between guides
> > > and policy
> > >
> > > the first section in http://incubator.apache.org/guides/index.html is
> > > terse and obtuse. one possibility would be to expand this. it would
> > > also be possible to create a meta guide (guideance about seeking
> > > guideance).
> > >
> > > opinions?
> > >
> > > suggestions?
> >
> > The Incubation Guides linked below are descriptive and at times
> > discursive documents. They describe current, but not necessarily
> > best, practices. These guides are informational, to give you
> > something to start from and improve over.
> > Unlike the <a href="/incubation/Incubation_Policy.html">Policy</a>,
> > the guides are <i>not</i> normative. You MAY diverge from a
> > guide whenever it makes sense for your project. Only the
> > <a href="/incubation/Incubation_Policy.html">Policy</a>
> > is normative and MUST be followed by all projects.
> >
> > (and move the Notes section to the bottom of the page)
> > (keywords MAY and MUST used as per RFC 2119 [1])
>
> i've added something along these lines to
> http://incubator.apache.org/guides/index.html. i've also added a note
> explaining that questions on deviations may be expected.
>
> please take a look and either patch improvements or post feedback on list
>
Looks good with your addition.
Matthieu
>
> - robert
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> For additional commands, e-mail: general-help@incubator.apache.org
>
>
Re: [doc] Guides verses Policy
Posted by Roland Weber <os...@dubioso.net>.
Robert Burrell Donkin wrote:
> i've added something along these lines to
> http://incubator.apache.org/guides/index.html. i've also added a note
> explaining that questions on deviations may be expected.
Looks good to me.
cheers,
Roland
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] Guides verses Policy
Posted by Robert Burrell Donkin <ro...@gmail.com>.
On Dec 29, 2007 4:39 PM, Roland Weber <os...@dubioso.net> wrote:
>
> Robert Burrell Donkin wrote:
> > recent experience suggests that the incubator documentation does a
> > poor job of helping podlings understand the difference between guides
> > and policy
> >
> > the first section in http://incubator.apache.org/guides/index.html is
> > terse and obtuse. one possibility would be to expand this. it would
> > also be possible to create a meta guide (guideance about seeking
> > guideance).
> >
> > opinions?
> >
> > suggestions?
>
> The Incubation Guides linked below are descriptive and at times
> discursive documents. They describe current, but not necessarily
> best, practices. These guides are informational, to give you
> something to start from and improve over.
> Unlike the <a href="/incubation/Incubation_Policy.html">Policy</a>,
> the guides are <i>not</i> normative. You MAY diverge from a
> guide whenever it makes sense for your project. Only the
> <a href="/incubation/Incubation_Policy.html">Policy</a>
> is normative and MUST be followed by all projects.
>
> (and move the Notes section to the bottom of the page)
> (keywords MAY and MUST used as per RFC 2119 [1])
i've added something along these lines to
http://incubator.apache.org/guides/index.html. i've also added a note
explaining that questions on deviations may be expected.
please take a look and either patch improvements or post feedback on list
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: [doc] Guides verses Policy
Posted by Roland Weber <os...@dubioso.net>.
Robert Burrell Donkin wrote:
> recent experience suggests that the incubator documentation does a
> poor job of helping podlings understand the difference between guides
> and policy
>
> the first section in http://incubator.apache.org/guides/index.html is
> terse and obtuse. one possibility would be to expand this. it would
> also be possible to create a meta guide (guideance about seeking
> guideance).
>
> opinions?
>
> suggestions?
The Incubation Guides linked below are descriptive and at times
discursive documents. They describe current, but not necessarily
best, practices. These guides are informational, to give you
something to start from and improve over.
Unlike the <a href="/incubation/Incubation_Policy.html">Policy</a>,
the guides are <i>not</i> normative. You MAY diverge from a
guide whenever it makes sense for your project. Only the
<a href="/incubation/Incubation_Policy.html">Policy</a>
is normative and MUST be followed by all projects.
(and move the Notes section to the bottom of the page)
(keywords MAY and MUST used as per RFC 2119 [1])
cheers,
Roland
[1] http://tools.ietf.org/html/rfc2119
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org