Mailing-List: contact ctakes-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ctakes-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: local policy)
From: "Masanz, James J." <Masanz.James@mayo.edu>
To: "'ctakes-dev@incubator.apache.org'" <ctakes-dev@incubator.apache.org>
Subject: RE: 3.0 doc summary; one failing test
Thread-Topic: 3.0 doc summary; one failing test
Thread-Index: Ac4V7vCCZavMDgRWQyyd83q37LL5kAAlh+KwAAbkKSA=
Date: Fri, 1 Mar 2013 17:20:44 +0000
Message-ID: 
 <996FC801C05DF64A84246A106FACACD0081D75@MSGPEXCHA08A.mfad.mfroot.org>
References: 
 <B1D5DE3F00E17F458CC1B5158EA798B308E2EE@MSGPEXCEI10A.mfad.mfroot.org>
 <924DE05C19409B438EB81DE683A942D9104B9BA9@CHEXMBX1A.CHBOSTON.ORG>
In-Reply-To: <924DE05C19409B438EB81DE683A942D9104B9BA9@CHEXMBX1A.CHBOSTON.ORG>
Accept-Language: en-US
Content-Language: en-US
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0


As far as user vs. developer guide.
There have been people who want to just download a binary and run without c=
ompiling or even without an IDE - to 'kick the tires' a bit.

As far as the structures of binary vs source, at least one difference is th=
e way XML descriptors are bundled together under one master desc directory =
 rather than in within the separate components. Not sure if there was more =
that Troy was referring to.

-- James

> -----Original Message-----
> From: ctakes-dev-return-1307-Masanz.James=3Dmayo.edu@incubator.apache.org
> [mailto:ctakes-dev-return-1307-
> Masanz.James=3Dmayo.edu@incubator.apache.org] On Behalf Of Chen, Pei
> Sent: Friday, March 01, 2013 8:20 AM
> To: ctakes-dev@incubator.apache.org
> Subject: RE: 3.0 doc summary; one failing test
>=20
> Do we need to differentiate between cTAKES developer guide and user
> guide? I think in its current state,  cTAKES users are probably
> developers.  Perhaps we should just combine them and just call it a
> guide/manual just like UIMA?
> I think once we have a tool that runs in the 3 steps that Andy referred
> to, then I think that would be something an end-user would use...
> (Probably not the current UIMA CPE/CVD GUI's.)  Just to manage some of
> the expectations for those end-users.
>=20
> http://incubator.apache.org/ctakes/roadmap.html looks good, but will
> need to be maintained manually vs: the roadman from Jira which is
> automatically generated:
> https://issues.apache.org/jira/browse/CTAKES#selectedTab=3Dcom.atlassian.=
j
> ira.plugin.system.project%3Aroadmap-panel ?
>=20
> > - Agree on one structure for cTAKES projects. The binary distribution
> > is in a different form that the developer source. We decided a long
> > time ago to try something new. It never caught on in the developer
> > ranks. We should either complete the transformation in dev or return
> > the user binary structure to match dev.
> I'm not quite sure what you mean here.  Each component is a separate
> module in the source code. In the distribution binary, each component is
> distributed with it's own jar in /lib now.  For example: ctakes-
> assertion.jar, ctakes-core.jar.
>=20
>=20
> > -----Original Message-----
> > From: Bleeker, Troy C. [mailto:Bleeker.Troy@mayo.edu]
> > Sent: Thursday, February 28, 2013 3:06 PM
> > To: ctakes-dev@incubator.apache.org
> > Subject: 3.0 doc summary; one failing test
> >
> > I think I've done as much as I can do on the doc at this point. I was
> > able to run the Linux install/tests for both dev and user. For user,
> > the results of the CVD run were basically nothing. There was but 1
> > annotation for all the text pasted in. No concepts. Nothing. If
> > someone wants to verify this we could create a JIRA item. I may have
> missed something.
> >
> > Otherwise (with completed items left out) here is what could still be
> done:
> >
> > - The examples, as described by Andy, would be more than a readme
> > should have. This would be great for a how-to guide. The Developer
> > Guide and User Guide have been renamed to Install Guides. I don't
> > think a how-to guide should be incorporated into these but should be
> > its own document. Making one would be great and as you say should
> > include things like 1) pointers to where to find basic information 2)
> > very high level overview of the components in the context of using
> > them to do a very basic task 3) I think it was suggested that the
> > Getting Started page might be something like this in very short form.
> > If we did that then it would point to a more comprehensive how-to
> > guide. [The Getting Started page is a short start now.]
> >
> > - Project history page of all cTAKES releases placed on Apache sites
> > somewhere. Good plan if short. I would not copy readmes there but have
> > links to them. This was done in the past but removed from the bottom
> > of the downloads page. This page exists now but is not linked to from
> > the Apache cTAKES site. Here is a direct link:
> > http://incubator.apache.org/ctakes/roadmap.html. Decide if you want to
> > go forward with something like this. An archive page will be needed
> > when we have more releases under our belt.
> >
> > - Creating a single download for a newcomer. We should revisit this at
> > some point in order to make the best first impression. A new user
> > should be able to get from nothing to running cTAKES in three steps:
> > download, uncompress, run (like 2.5).
> >
> > - Agree on one structure for cTAKES projects. The binary distribution
> > is in a different form that the developer source. We decided a long
> > time ago to try something new. It never caught on in the developer
> > ranks. We should either complete the transformation in dev or return
> > the user binary structure to match dev. New users are potential new
> developers of cTAKES in the future.
> > It's confusing when those two structures are not the same for that
> > person. If you want to attract contributions well ... this does not
> help.
> >
> > Perhaps these could all be made JIRA items.
> >
> > Thanks
> > Troy Bleeker * Senior Business Analyst CBAP(r) * Biomedical Statistics
> > and Informatics
> > Phone: 507-293-1574 * Fax: 507-284-0360 * bleeker.troy@mayo.edu Mayo
> > Clinic * 200 First Street SW * Rochester, MN 55905 *
> www.mayoclinic.org