[Fortress] Release Preparations

[Shawn McKinney <sm...@apache.org>]

Hello,

I am making preparations for the first apache fortress release.  The goal is to accomplish this within the next week or two.  

But before Fortress can be released as an apache project, there are a few items that must be completed.  Each will be added to JIRA for tracking:

1. Fix the installation documentation.  

The following artifacts need work:
a. README.txt
b. README-QUICKSTART-APACHEDS.html
c. Online quickstart pages on website
d. Javadoc

Obviously having similar documentation in three different places is not ideal.  Part of this task will be to reconsider all of these formats and settle on a single format.  I prefer javadoc because it is a single set of artifacts, provides a decent user interface, and can be viewed locally and on a remote web server.  I like the look and feel of our online documentation format (item c above) but it requires a separate cms, and (worse) creates a separate set of artifacts that must be managed outside of the project itself - which means inevitably it will fall out synch.

2. Separate fortress configuration by ldap server implementation.  

Currently fortress works with both openldap and apache directory server.  Eventually support for other servers may be added as well.  This creates a problem because each server impl has slightly different config requirements which will be confusing to users.  Fortress configuration files are seeded by data contained within build.properties.  Thus we can separate into two separate files:

a. build-ol.properties - contains openldap specific parameters
b. build-ads.properties - contains apacheds specific params

One of the steps during setup will be to rename one of the above file, per user's choice, to build.properties.

3. Modify the fortress projects pom.xml for maven staging.  

Comments?

Shawn

Re: [Fortress] Release Preparations

[Emmanuel Lécharny <el...@gmail.com>]

Le 27/01/15 17:41, Shawn McKinney a écrit :
> Hello,
>
> I am making preparations for the first apache fortress release.  The goal is to accomplish this within the next week or two.  
>
> But before Fortress can be released as an apache project, there are a few items that must be completed.  Each will be added to JIRA for tracking:
>
> 1. Fix the installation documentation.  
>
> The following artifacts need work:
> a. README.txt
> b. README-QUICKSTART-APACHEDS.html
> c. Online quickstart pages on website
> d. Javadoc
>
> Obviously having similar documentation in three different places is not ideal.  Part of this task will be to reconsider all of these formats and settle on a single format.  I prefer javadoc because it is a single set of artifacts, provides a decent user interface, and can be viewed locally and on a remote web server.  I like the look and feel of our online documentation format (item c above) but it requires a separate cms, and (worse) creates a separate set of artifacts that must be managed outside of the project itself - which means inevitably it will fall out synch.

You can create a page on the web site that contains what you have in
those files.
>
> 2. Separate fortress configuration by ldap server implementation.  
>
> Currently fortress works with both openldap and apache directory server.  Eventually support for other servers may be added as well.  This creates a problem because each server impl has slightly different config requirements which will be confusing to users.  Fortress configuration files are seeded by data contained within build.properties.  Thus we can separate into two separate files:
>
> a. build-ol.properties - contains openldap specific parameters
> b. build-ads.properties - contains apacheds specific params

>
> One of the steps during setup will be to rename one of the above file, per user's choice, to build.properties.
>
> 3. Modify the fortress projects pom.xml for maven staging. 

We also need a page on the site explaining how to cut a release, as teh
one we have for evry other project.

I can contribute to that part, as I know quite well how to cut a release
(and it's not a pleasant journey, I'm quiet sure we will have many
attemos before getting it correct).