Mailing-List: contact api-help@directory.apache.org; run by ezmlm
Precedence: bulk
Reply-To: api@directory.apache.org
MIME-Version: 1.0
In-Reply-To: <7A5EF10D-3D28-4B52-87BB-169AB513A273@apache.org>
References: <434d7ff9-b793-7f83-a9f1-c93101163246@symas.com>
 <E3BED28E-10EE-4576-8278-5A8496DFA786@apache.org> <6bc997d4-07ed-b5a4-a9ca-da2861c584c5@gmail.com>
 <EE8442C4-1F81-42F6-B8EC-0CFF34037B61@apache.org> <8cdbd610-ef37-a5e1-92fd-9efc24cdba28@gmail.com>
 <6F577D83-ED5F-4687-952A-7F9B3E14595F@apache.org> <b399580f-44db-3ed3-a699-9f60c6b1da01@gmail.com>
 <7A5EF10D-3D28-4B52-87BB-169AB513A273@apache.org>
From: Pierre Smits <pierre.smits@gmail.com>
Date: Sun, 1 Jan 2017 10:47:33 +0100
Message-ID: <CADPkm85OeFQRkRZzLjp=0hVwgAZ-cB9=_X=i-WnXkFZ4B69CYA@mail.gmail.com>
Subject: Re: LDAP API 1.0-GA preparation
To: api@directory.apache.org
Content-Type: multipart/alternative; boundary=94eb2c1147fa097c3e05450553b7
archived-at: Sun, 01 Jan 2017 09:47:50 -0000

--94eb2c1147fa097c3e05450553b7
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

Great work, Shawn,

First of all: Happy New Year. May it be an exciting and interesting one!

It seems to me that having user guides as static pages we create the
impression that they are applicable to any version available to the
adopters of our products (old, superseded versions and the latest
available). We know that that isn't true. As our products evolve, so do our
user guides.

Would it not be better to recreate the pages in our wiki and per page state
to which page they are applicable?

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Sat, Dec 31, 2016 at 7:00 PM, Shawn McKinney <smckinney@apache.org>
wrote:

>
> > On Dec 18, 2016, at 11:54 AM, Emmanuel L=C3=A9charny <elecharny@gmail.c=
om>
> wrote:
> >
> > Obviously, there is a lot of thing to add... I think the structure migh=
t
> > also be improved. Anyway, we have something to start with...
> >
> > If you feel like to start reviewing the completed pages, please do so !
>
> Hello,
>
> I have completed a first-pass over our LDAP API=E2=80=99s user guide.  Th=
e goal
> was to cleanup grammar, spelling, description semantics, and broken links=
.
> I didn=E2=80=99t add new content, nor did I alter the structure of any of=
 existing
> documents.
>
> There are many sections not yet completed but I believe we=E2=80=99re OK =
for a 1.0
> GA (although the security sections should be completed soon for obvious
> reasons).
>
> You can review the updated user=E2=80=99s guide here:
> http://directory.staging.apache.org/api/user-guide.html
>
> I really like the story.  It should be emphasized once this release
> becomes public:
> http://directory.staging.apache.org/api/user-guide/1.3-
> apache-ldap-api-rational.html
>
> At the very least we should create a wikipedia page with this as its
> history.
>
> Let me know if you see any errors that need correcting.
>
> Thanks,
> Shawn

--94eb2c1147fa097c3e05450553b7--