You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Felix Knecht <fe...@otego.com> on 2010/08/16 17:31:07 UTC

User Guide documentation

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Heads up!

I migrated the Basic-/Advanced User Guide from confluence into the
apacheds/user-guides module (svn). We're moving to docbook documenting
for user guides [1].
So from now on please switch from confluence to the user-guide module
for this kind of documentation.

Thanks and regards
Felix

[1] http://directory.markmail.org/message/dp2jhvopfxp463f6
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkxpWbsACgkQ2lZVCB08qHFfuQCfXHllX5RGZCL+u58qwkz6AkGH
Mh8AoJFawnAy/YOnHo2c11fwPR7iK5Ks
=lgLN
-----END PGP SIGNATURE-----

Re: [Documentation] Version in pom.xml (Re: User Guide documentation)

Posted by Felix Knecht <fe...@apache.org>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 08/29/10 21:18, Stefan Zoerner wrote:
> Felix Knecht wrote:
>> If so I wonder why we can't have it in the apacheds module - if it's the
>> same version. How to release a bug fixed documentation for a specific
>> apacheds release?
> 
> Yes, currently it is side by side
> 
> https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk
> https://svn.apache.org/repos/asf/directory/apacheds/trunk

Yes, that's because Emmanuel and Pierre-Arnaud suggested to have it in a
separate module
http://markmail.org/message/vgxphabg4sshqcfn

> 
> which is not very helpful w.r.t. documentation of both 1.5 (server.xml /
> Spring) and 2.0 (DIT) configuration style.
> 
> 
>> I suggest having the major.minor version the same like apacheds and the
>> bugfix version a sequence.
>> For ads 1.5.x documentation version would start at 1.5.0.
> 
> Anyway, I will use
> 
> https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk

That's what it's for and why it's there :-)


> to document the 1.5.7 situation for the Basic User's Guide. Most of the
> content is probably the same for 2.0 (Exception: the configuration).
> 
> Should I change the version in pom.xml for apacheds-manuals simply to
> 1.5.8.SNAPSHOT?

Just do it if you think it's better. I just put the 1.0.0 in the
beginning to have a version there.

Regards
Felix
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkx6uCIACgkQ2lZVCB08qHFCfwCeOEJjCVc2Pwc0rafmP0xABkJN
ZlIAnjxDQ32jXAeK2bOKGxeJY/Ncas+L
=m6KV
-----END PGP SIGNATURE-----

Re: [Documentation] Version in pom.xml (Re: User Guide documentation)

Posted by Stefan Zoerner <st...@labeo.de>.
Felix Knecht wrote:
> If so I wonder why we can't have it in the apacheds module - if it's the
> same version. How to release a bug fixed documentation for a specific
> apacheds release?

Yes, currently it is side by side

https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk
https://svn.apache.org/repos/asf/directory/apacheds/trunk

which is not very helpful w.r.t. documentation of both 1.5 (server.xml / 
Spring) and 2.0 (DIT) configuration style.


> I suggest having the major.minor version the same like apacheds and the
> bugfix version a sequence.
> For ads 1.5.x documentation version would start at 1.5.0.

Anyway, I will use

https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk

to document the 1.5.7 situation for the Basic User's Guide. Most of the 
content is probably the same for 2.0 (Exception: the configuration).

Should I change the version in pom.xml for apacheds-manuals simply to 
1.5.8.SNAPSHOT?

Greetings from Hamburg,
     StefanZ



Re: [Documentation] Version in pom.xml (Re: User Guide documentation)

Posted by Felix Knecht <fe...@apache.org>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


>> currently, in the pom.xml it states version 1.0.0-SNAPSHOT. How about
>> replacing it with the ApacheDS server version, in order to reflect for which
>> version it belongs to?
> having the current server version is best

If so I wonder why we can't have it in the apacheds module - if it's the
same version. How to release a bug fixed documentation for a specific
apacheds release?

I suggest having the major.minor version the same like apacheds and the
bugfix version a sequence.
For ads 1.5.x documentation version would start at 1.5.0.

Felix
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkx6qk4ACgkQ2lZVCB08qHEb6wCgv71sZVUwW2lgFYu3DLp+j6Ex
R9IAoKDw1FbQpmtmclKolQ7SF/C0jeGU
=hrRA
-----END PGP SIGNATURE-----

Re: [Documentation] Version in pom.xml (Re: User Guide documentation)

Posted by Kiran Ayyagari <ka...@apache.org>.
hi StefanZ,

On Sun, Aug 29, 2010 at 11:59 PM, Stefan Zoerner <st...@labeo.de> wrote:
> Felix Knecht wrote:
>>
>> I migrated the Basic-/Advanced User Guide from confluence into the
>> apacheds/user-guides module (svn). We're moving to docbook documenting
>> for user guides [1].
>
> Congratulations and thanks for this work!
>
>> So from now on please switch from confluence to the user-guide module
>> for this kind of documentation.
>
> I have started to add/move content to
>
> https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk
>
> currently, in the pom.xml it states version 1.0.0-SNAPSHOT. How about
> replacing it with the ApacheDS server version, in order to reflect for which
> version it belongs to?
having the current server version is best
>
> I have started to rework the ApacheDS Basic User Guide for the current
> released version (which is 1.5.7).
>
> Are there major changes in the upcoming 2.0? Especially w.r.t. the
> configuration of the server? In 1.5.7, we still have server.xml etc. It ism
> planned in 2.0 to replace it with configuration i the DIT. If so, we could
> perhaps branch the documentation in order to reflect both the current and
> the future configuration ...
yeah 2.0 contains configuration in DIT, I like this idea of having
different branches of doco for
different server versions
>
> Greetings from Hamburg,
>    StefanZ
>
>

thanks Stefan

Kiran Ayyagari

[Documentation] Version in pom.xml (Re: User Guide documentation)

Posted by Stefan Zoerner <st...@labeo.de>.
Felix Knecht wrote:
> I migrated the Basic-/Advanced User Guide from confluence into the
> apacheds/user-guides module (svn). We're moving to docbook documenting
> for user guides [1].

Congratulations and thanks for this work!

> So from now on please switch from confluence to the user-guide module
> for this kind of documentation.

I have started to add/move content to

https://svn.apache.org/repos/asf/directory/apacheds-manuals/trunk

currently, in the pom.xml it states version 1.0.0-SNAPSHOT. How about 
replacing it with the ApacheDS server version, in order to reflect for 
which version it belongs to?

I have started to rework the ApacheDS Basic User Guide for the current 
released version (which is 1.5.7).

Are there major changes in the upcoming 2.0? Especially w.r.t. the 
configuration of the server? In 1.5.7, we still have server.xml etc. It 
ism planned in 2.0 to replace it with configuration i the DIT. If so, we 
could perhaps branch the documentation in order to reflect both the 
current and the future configuration ...

Greetings from Hamburg,
     StefanZ