Hi all,
I'm just wondering how we move forward with the docs and the config backend. Should we document examples with both, or only slapd.d or move example config to the appendix and have an appendix for each format so it doesn't clutter the guide.
My feeling is the last option is best. Thoughts?
Gavin.
On Wed, Dec 31, 2008 at 06:07:15PM +0000, Gavin Henry wrote:
I'm just wondering how we move forward with the docs and the config backend. Should we document examples with both, or only slapd.d or move example config to the appendix and have an appendix for each format so it doesn't clutter the guide.
My feeling is the last option is best. Thoughts?
I would certainly prefer to see just one format used in the body of the guide. Less duplication, so less chance of error.
The file format is cleaner than the LDIF necessary to express data for the config backend and there is a simple translation to the other format, so I would suggest sticking with file-based examples. Occasional pointers to the section describing the translation process would be useful.
Andrew
----- "Andrew Findlay" andrew.findlay@skills-1st.co.uk wrote:
On Wed, Dec 31, 2008 at 06:07:15PM +0000, Gavin Henry wrote:
I'm just wondering how we move forward with the docs and the config backend. Should we document examples with both, or only slapd.d or move example config to the appendix and have an appendix for each format so it doesn't clutter the guide.
My feeling is the last option is best. Thoughts?
I would certainly prefer to see just one format used in the body of the guide. Less duplication, so less chance of error.
The file format is cleaner than the LDIF necessary to express data for the config backend and there is a simple translation to the other format, so I would suggest sticking with file-based examples. Occasional pointers to the section describing the translation process would be useful.
OK, thanks. Dev team thoughts?
--On Monday, January 12, 2009 9:14 AM +0000 Gavin Henry ghenry@OpenLDAP.org wrote:
OK, thanks. Dev team thoughts?
I found the doc examples using the LDIF format quite useful when transitioning from the *.conf format to the config format, regardless of the ability to take a slapd.conf and translate it to LDIF. People who are starting fresh may never need/desire to have a *.conf file.
--Quanah
--
Quanah Gibson-Mount Principal Software Engineer Zimbra, Inc -------------------- Zimbra :: the leader in open source messaging and collaboration
Quanah Gibson-Mount wrote:
--On Monday, January 12, 2009 9:14 AM +0000 Gavin Henry ghenry@OpenLDAP.org wrote:
OK, thanks. Dev team thoughts?
I found the doc examples using the LDIF format quite useful when transitioning from the *.conf format to the config format, regardless of the ability to take a slapd.conf and translate it to LDIF. People who are starting fresh may never need/desire to have a *.conf file.
Along those lines ... we've set a policy that all new code (backends, overlays) must support cn=config. I think it makes sense to use the same policy for all newly written documentation. slapd.conf is obsolete.
----- "Howard Chu" hyc@symas.com wrote:
Quanah Gibson-Mount wrote:
--On Monday, January 12, 2009 9:14 AM +0000 Gavin Henry ghenry@OpenLDAP.org wrote:
OK, thanks. Dev team thoughts?
I found the doc examples using the LDIF format quite useful when transitioning from the *.conf format to the config format,
regardless of
the ability to take a slapd.conf and translate it to LDIF. People
who are
starting fresh may never need/desire to have a *.conf file.
Along those lines ... we've set a policy that all new code (backends,
overlays) must support cn=config. I think it makes sense to use the same policy for all newly written documentation. slapd.conf is obsolete.
Right, done.
Thanks all.
-
Andrew Findlay -
Gavin Henry -
Gavin Henry -
Howard Chu -
Quanah Gibson-Mount