One other great doc I'd like to see - maybe you have it already?
Differences between Tomcat and TomEE if you're used to Tomcat.
One big gotcha when I first started using TomEE was that you had turned off
the JSP-recompilation feature which is default in Tomcat. So my JSP test
files weren't being recompiled and I needed to restart the JVM each time. I
had to find the setting myself because it wasn't so clear.
So maybe a list of important changes like that would be helpful.
Even better - major difference docs for each major container. eg: if I am
used to GlassFish or JBoss, what do I need to change for TomEE.
This would be the ideal place to document the JSF/JPA stuff we discussed
earlier (if it's still relevant). If the problem is a large or fundamental
one like the JSF one was, maybe just documenting it for people who are used
to other containers would save a lot of headaches for first-time-users.
Maybe the wiki would be the best format for this sort of stuff?
https://cwiki.apache.org/TOMEE/index.html
Best Regards,
Neale
----- Original Message -----
From: "Neale Rudd" <ne...@metawerx.net>
To: <dev@openejb.apache.org>
Sent: Wednesday, October 10, 2012 6:37 PM
Subject: Re: 1.5 Clarification
Hi David,
Do you mean like this?
- http://tomee.apache.org/tomee-1.5.0-release-notes.html
Or do you want all the release notes from the previous releases? Or did
you mean something else?
Yes that's pretty good, guess I'd like a little more detail in general.
eg: http://tomcat.apache.org/tomcat-7.0-doc/changelog.html
The sentences describe why the change was made a little more whereas the
tomee ones seem to be a copy of the jira title, so it takes a lot longer
to see what and why changed.
Also the tomcat one shows change by version number and the final committer
(just for fun)
Any ideas on how we can improve these to better match what you imagine?
- http://tomee.apache.org/examples-trunk/index.html
These are great examples, but none are bundled with TomEE. I understand
they can't be put into a production folder (like Tomcat does) but maybe
then can be easily moved into webapps to try things out rather than
downloading them. Just an opinion though. I understand you want to keep
download size low.
- upgrade notes (per revision + per major revision) - very important
if used in a production system, I review these personally for every
Tomcat subrelease and make changes to our templates as necessary
We definitely don't have anything there. Wondering how we could
realistically capture that information. Getting something in place and
getting people to use it are always difficult initiatives.
This would include a simple migration guide from 1.0.x to 1.5.x. ie: if
your app runs in 1.0, what is going to break in 1.5? what needs to be
changed? what do we need to be aware of? ie: the /openejb app being
change to /tomee pre the 1.0 release would be a good example of a major
change. Any information available here can be critical for assisting
smooth transitions to newer versions, and that means less time supporting
people on older revisions. Much easier to say "can you try it on 1.5?
the migration docs are here: http...".
And more docs :)
Yes - I'd definitely start with configuration reference stuff. ie: a
description of all non-Tomcat config files and their components
- alpha, beta, rc -> release strategy (this would have avoided the
1.5.0 win issue)
We did have about 3 sets of potential release binaries and another 2-3
sets of preview binaries (not quite ready for voting).
I think Tomcat generally follows this pattern, not sure if it's the Apache
standard way, but it seems to generate pretty stable releases:
- an alpha-release (people start trying out the new version, normal users
never download a snapshot)
- a beta-release (more heavy testing, because it's about to go live)
- a release-candidate (more testing, people have a very last chance to
deploy and test at their workplace, or risk missing all the new features
for another N months)
- release vote (2-3 days or whatever is decided/mandated)
- release
Then you immediately branch whatever branches you want, such as a 1.5.1
for fixes-only, a 1.6.0 for the next main version. Whether or not Tomcat
upgrades go into the 1.5.1 or the 1.6.0 is up to you.
Then within 2 months you release 1.6.0. The 1.5.1 would be released in
the case of important new fixes or deployment problems (eg: the windows
1.5.0 issue), and never include new features.
Something like that?
Best Regards,
Neale
----- Original Message -----
From: "David Blevins" <david.blev...@gmail.com>
To: <dev@openejb.apache.org>
Sent: Tuesday, October 09, 2012 6:42 AM
Subject: Re: 1.5 Clarification
On Oct 8, 2012, at 12:15 PM, Neale Rudd wrote:
Suggest following Tomcat-style change-log. One file which has all 1.x.x
release notes with a one-liner describing the change/feature and a link
to Jira if people want to investigate.
Do you mean like this?
- http://tomee.apache.org/tomee-1.5.0-release-notes.html
Or do you want all the release notes from the previous releases? Or did
you mean something else?
- simple examples (helps get people started, helps to demonstrate why
TomEE is useful to their company)
Any ideas on how we can improve these to better match what you imagine?
- http://tomee.apache.org/examples-trunk/index.html
- easy to navigate docs (avoids ??% of the questions on the user list,
freeing up dev time, which is *so* important for bugfixes and new
features)
And more docs :)
- integration with leading IDE's (TomEE could at least have excellent
docs on how to use Tomcat IDE settings, linked directly from the main web
page for easy transition)
We've got a video and doc for Eclipse. The video isn't linked from the
doc page and the doc ins't linked from the main page. Help welcome
there -- from anyone reading. Here are the bits if someone wants to
improve things:
- http://tomee.apache.org/tomee-and-eclipse.html
- http://www.youtube.com/watch?v=Lr8pxEACVRI
- easy to navigate release notes (easy to see what's changed, in 2
minutes, without browsing dev@ or long jiras)
Any ideas on how to make this easier to navigate?
- http://tomee.apache.org/tomee-1.5.0-release-notes.html
- upgrade notes (per revision + per major revision) - very important if
used in a production system, I review these personally for every Tomcat
subrelease and make changes to our templates as necessary
We definitely don't have anything there. Wondering how we could
realistically capture that information. Getting something in place and
getting people to use it are always difficult initiatives.
- frequent releases (and TomEE should keep-up, like MariaDB does with
MySQL - this is critical IMHO)
Completely agreed.
- alpha, beta, rc -> release strategy (this would have avoided the 1.5.0
win issue)
Can you elaborate on the flow you have in mind? We do have restrictions
on the workflow Apache allows, so we may or may not be able to do that,
but it'll be good to understand.
We did have about 3 sets of potential release binaries and another 2-3
sets of preview binaries (not quite ready for voting).
-David
----- Original Message ----- From: "Neale Rudd" <ne...@metawerx.net>
To: <dev@openejb.apache.org>
Sent: Tuesday, October 09, 2012 6:00 AM
Subject: Re: 1.5 Clarification
You're right - proxy or browser cache - I clicked Reload in Chrome and
got the 1.5.0 release on tomee.apache.org finally.
Some sort of too-long cache time problem? I've checked this every day
and only got 1.5.0 just now after I clicked Reload. Might be a problem
for future releases.
Best Regards,
Neale
----- Original Message ----- From: "David Blevins"
<david.blev...@gmail.com>
To: <dev@openejb.apache.org>
Sent: Tuesday, October 09, 2012 5:55 AM
Subject: Re: 1.5 Clarification
On Oct 8, 2012, at 11:33 AM, Neale Rudd wrote:
- http://tomee.apache.org/downloads.html shows 1.0.0, but
http://openejb.apache.org/downloads.html shows 1.5.0 as latest release,
aren't these the same site?
That's probably a browser caching issue. The tomee.apache.org is just
an alias.
-David
