Misleading Developer Guide for ADS 1.5

[Emmanuel Lecharny <el...@gmail.com>]

Hi guys,

I just realized that what we call Developer Guide in ADS 1.5 is really
misleading : it's pretty much an internal documentation we are using
while developping the server itself than a documentation targeting
users who want to use ADS to do unit tests or to embed the server.

I would suggest that we get all the developpement dopco into the
http://cwiki.apache.org/confluence/display/DIRxDEV/Index pages, and
organized the Developer Guide differently.

WDYT ?

-- 
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com

Re: Misleading Developer Guide for ADS 1.5

[Alex Karasulu <ak...@apache.org>]

On 10/22/07, Emmanuel Lecharny <el...@gmail.com> wrote:
>
> Forget about my initial mail.
>
> I could have stated that the dev guide is not exactly well organized,
> but this is our fault, so it's mine too ;)


NP I am guilty here for sure especially in the 1.5 branch.  We seriously
needs some organization.
I just wanted to make sure we documented everything about the features in
the developer doco first
then we can start some passes on cleaning it up.

Alex, you are plain right. The AUG is the place for Embedding the
> server or using it for unit test.
>
> I may have been confused by the 1.5 developper's guide page which is
> really less organized than the 1.0 one.


Yes for sure.  We just need a few cleanup passes after the actual work on
this branch
settles.  Perhaps until a feature freeze is announced (which leads to some
2.0-RCs)
cleaning up may not be so easy of beneficial.  It's like trying to cleanup
my house
when the kids are playing :).

Alex



> On 10/22/07, Alex Karasulu <ak...@apache.org> wrote:
> > On 10/22/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > > Hi guys,
> > >
> > > I just realized that what we call Developer Guide in ADS 1.5 is really
> > > misleading : it's pretty much an internal documentation we are using
> > > while developping the server itself than a documentation targeting
> > > users who want to use ADS to do unit tests or to embed the server.
> >
> >
> > Actually this is exactly what I intended the developer guide to be:
> > documentation
> > for us and those that want to get involved with developing code for
> > ApacheDS.  It's
> > not there for people to use ADS for unit tests.  Using ADS for unit
> tests
> > and/or
> > for embedding should be in advanced sections of the UG no?
> >
> > > I would suggest that we get all the developpement dopco into the
> > >
> > http://cwiki.apache.org/confluence/display/DIRxDEV/Index
> > pages, and
> > > organized the Developer Guide differently.
> > >
> > > WDYT ?
> >
> >
> > We could do that.  However DIRxDEV is there for general information on
> how
> > to check out and build the projects to get started.  And this is good
> where
> > it
> > is since it does not change much and describes how we do things across
> > projects
> > here at Directory.  This is idea content to be exposed on the site.
> >
> > Architectural details and the design of features introduced in specific
> > branches are
> > better off being put into the individual branch spaces. Like the dynamic
> > schema feature
> > which was introduced in 1.5.x.  How this was designed, why and various
> > implementation details and problems should not be put into DIRxDEV.
> >
> > Alex
> >
> >
> >
> >
>
>
> --
> Regards,
> Cordialement,
> Emmanuel Lécharny
> www.iktek.com
>

Re: Misleading Developer Guide for ADS 1.5

[Emmanuel Lecharny <el...@gmail.com>]

Forget about my initial mail.

I could have stated that the dev guide is not exactly well organized,
but this is our fault, so it's mine too ;)

Alex, you are plain right. The AUG is the place for Embedding the
server or using it for unit test.

I may have been confused by the 1.5 developper's guide page which is
really less organized than the 1.0 one.

On 10/22/07, Alex Karasulu <ak...@apache.org> wrote:
> On 10/22/07, Emmanuel Lecharny <el...@gmail.com> wrote:
> > Hi guys,
> >
> > I just realized that what we call Developer Guide in ADS 1.5 is really
> > misleading : it's pretty much an internal documentation we are using
> > while developping the server itself than a documentation targeting
> > users who want to use ADS to do unit tests or to embed the server.
>
>
> Actually this is exactly what I intended the developer guide to be:
> documentation
> for us and those that want to get involved with developing code for
> ApacheDS.  It's
> not there for people to use ADS for unit tests.  Using ADS for unit tests
> and/or
> for embedding should be in advanced sections of the UG no?
>
> > I would suggest that we get all the developpement dopco into the
> >
> http://cwiki.apache.org/confluence/display/DIRxDEV/Index
> pages, and
> > organized the Developer Guide differently.
> >
> > WDYT ?
>
>
> We could do that.  However DIRxDEV is there for general information on how
> to check out and build the projects to get started.  And this is good where
> it
> is since it does not change much and describes how we do things across
> projects
> here at Directory.  This is idea content to be exposed on the site.
>
> Architectural details and the design of features introduced in specific
> branches are
> better off being put into the individual branch spaces. Like the dynamic
> schema feature
> which was introduced in 1.5.x.  How this was designed, why and various
> implementation details and problems should not be put into DIRxDEV.
>
> Alex
>
>
>
>


-- 
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com

Re: Misleading Developer Guide for ADS 1.5

[Alex Karasulu <ak...@apache.org>]

On 10/22/07, Emmanuel Lecharny <el...@gmail.com> wrote:
>
> Hi guys,
>
> I just realized that what we call Developer Guide in ADS 1.5 is really
> misleading : it's pretty much an internal documentation we are using
> while developping the server itself than a documentation targeting
> users who want to use ADS to do unit tests or to embed the server.


Actually this is exactly what I intended the developer guide to be:
documentation
for us and those that want to get involved with developing code for
ApacheDS.  It's
not there for people to use ADS for unit tests.  Using ADS for unit tests
and/or
for embedding should be in advanced sections of the UG no?

I would suggest that we get all the developpement dopco into the
> http://cwiki.apache.org/confluence/display/DIRxDEV/Index pages, and
> organized the Developer Guide differently.
>
> WDYT ?


We could do that.  However DIRxDEV is there for general information on how
to check out and build the projects to get started.  And this is good where
it
is since it does not change much and describes how we do things across
projects
here at Directory.  This is idea content to be exposed on the site.

Architectural details and the design of features introduced in specific
branches are
better off being put into the individual branch spaces. Like the dynamic
schema feature
which was introduced in 1.5.x.  How this was designed, why and various
implementation details and problems should not be put into DIRxDEV.

Alex