Mailing-List: contact dev-help@geronimo.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@geronimo.apache.org
Received-SPF: pass (nike.apache.org: local policy)
Message-ID: <4E0377D6.8070904@cait.org>
Date: Thu, 23 Jun 2011 12:28:54 -0500
From: Russell E Glaue <rglaue@cait.org>
User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US;
 rv:1.9.1.9) Gecko/20100317 Lightning/1.0b1 Thunderbird/3.0.4
MIME-Version: 1.0
To: dev@geronimo.apache.org
Subject: Re: two-track build docs, old 2.1 info on GMOxDEV
References: <4E037664.3090909@cait.org>
In-Reply-To: <4E037664.3090909@cait.org>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit


On 06/23/2011 12:22 PM, Russell E Glaue wrote:
> We have two tracks for our build docs.
> 
> One is the GMOxDEV Building Apache Geronimo, which documents whatever is in trunk
> Then we have the GMOxNN Building Geronimo with Maven, which documents whatever
> is in version NN (e.g. GMOx22 for branches/2.2)
> 
> So this means we have a two-track build doc:
> 1. GMOxDEV Building Apache Geronimo
> 2. GMOx30 Building Geronimo with Maven
> 
> These both document how to build from trunk, which is currently G3.0.
> Once we branch G3.0 the GMOx30 doc is going to leave and live its own life,
> while the GMOxDEV doc will change to reflect the next version being built in trunk.
> 
> However, we should make sure that we keep these docs updated in parallel.
> 
> Furthermore, I have added references to the GMOx30 and GMOx22 build docs on the
> GMOxDEV build doc page. And I put the info from the GMOx30 build doc in the
> GMOxDEV build doc so they contain the same information now.
> 
> With the reference links added, hopefully users will figure out what they need
> to do if there are differences because we update one and forget to update the other.
> 
> 
> In the GMOxDEV build doc, I have moved non-trunk build information under a
> version-specific identification. However, we may want to remove all non-trunk
> information all together.
> 
> The only negative to this is that the GMOxDEV doc also contains build
> information on G2.1. And there is no associated GMOx21 build doc.
> 
> Should we remove the G2.1 build information on the GMOxDEV doc?
> 
> 
> -RG

If we continue to branch the GMOxNN build document with every new code branch,
does that make the GMOxDEV build document obsolete?

Perhaps we put all the information into the GMOxNN documents, remove everything
from the GMOxDEV document, and only maintain links from the GMOxDEV to the
associated GMOxNN documents?

-RG