Clone URL (Committers only): https://cms.apache.org/redirect?new=anonymous;action=diff;uri=http://ctakes.apache.org/ctakes%2Fgettingstarted.mdtext
James Masanz Index: trunk/content/ctakes/gettingstarted.mdtext =================================================================== --- trunk/content/ctakes/gettingstarted.mdtext (revision 1449975) +++ trunk/content/ctakes/gettingstarted.mdtext (working copy) @@ -24,22 +24,22 @@ <<< Those right over there. If you need to know what cTAKES is, the About page in the *General* section will give you a cursory look at what cTAKES can do. -Downloads and the glossary are best left alone until you are directed there by the documentation or you need a definition. +Downloads is best left alone until you are directed there by the documentation. -The *Community* section is all about interacting with the group of people who contribute to the code base and who use it in projects at their own place of business. +The *Community* section is where you can interact with other people who use cTAKES as well as the people who contribute to the documentation and the code base. Use that part of the site to see how you can participate. Next you will see sections for *Users* and *Developers* and *PPMC* (which includes Committers). Apache has their own [definition of users](http://incubator.apache.org/guides/participation.html) matching these: - **Users** is for people who want to take a binary distribution of cTAKES and try it out or perhaps configure it for a run at annotating text in their enterprise. - - **Developers** is for those looking to change or extend the code, compile the code, deploy, and annotate text for their enterprise. Developers are encouraged to contribute changes and fixes back to the community through a committer or by becoming a committer. + - **Developers** is for those looking to change or extend the code, compile and deploy the code, and annotate text for their enterprise. Developers are encouraged to contribute changes and fixes back to the community through a committer or by becoming a committer. - **Committers** are in the PPMC (Podling Project Management Committee). They check-in code for cTAKES, write documentation including this web site, help the community produce releases, vote as a community member, and more. -The ASF (Apache Software Foundation) section has to do with administrating Apache projects in general. +The *ASF* (Apache Software Foundation) section has to do with administrating Apache projects in general. -cTAKES has one other site used to house the bulk of the documentation. -You will eventually be directed to the [cTAKES documentation](https://cwiki.apache.org/confluence/x/PRjVAQ) as you begin. +The bulk of the cTAKES documentation is on the [Apache cTAKES wiki](https://cwiki.apache.org/confluence/x/PRjVAQ). +You will eventually be directed there when you begin. The following sections will help you begin depending on how you see yourself interacting with the cTAKES code and the community. #Getting started as a user @@ -48,7 +48,7 @@ The downloads page is where you will go to find the latest stable binary distribution. If you feel comfortable installing from README text then you can go right to the downloads page and get started. -If you would like more of the step-by-step instructions then look to the [User Guide](http://incubator.apache.org/ctakes/userguide.html). +If you would like step-by-step instructions then look to the [User Guide](http://incubator.apache.org/ctakes/userguide.html). The [FAQs](http://incubator.apache.org/ctakes/user-faqs.html) are very helpful for initial questions. Being an Apache project, the source code is open to all. @@ -61,9 +61,9 @@ Eclipse is popular, but your favorite command line tools or other IDEs will also work just fine. cTAKES builds are based on [maven](http://maven.apache.org/) (another Apache project), so your IDE must support maven. -The [Developer Guide](http://incubator.apache.org/ctakes/developerguide.html) and [FAQs](http://incubator.apache.org/ctakes/developer-faqs.html) is where you want to start. +The [Developer Guide](http://incubator.apache.org/ctakes/developerguide.html) and [FAQs](http://incubator.apache.org/ctakes/developer-faqs.html) are where you want to start. You will find an extremely short set of install and build instructions, for those that have been through this many times, as well as step-by-step install and build instructions. -One thing you'll need before you get started is the knowledge of how the SVN cTAKES code [trunk, branches, and tags](http://incubator.apache.org/ctakes/developer-faqs.html#how-does-the-ctakes-project-manage-the-trunk-tags-and-branches-in-svn) are used. +Before you get started you'll want to know the conventions of how the Apache cTAKES committers use [the trunk, branches, and tags](http://incubator.apache.org/ctakes/developer-faqs.html#how-does-the-ctakes-project-manage-the-trunk-tags-and-branches-in-svn). #Running the cTAKES annotators So how do you get use out of cTAKES, in a nutshell? cTAKES is based on [UIMA](http://uima.apache.org/) (another Apache project). UIMA brings a couple of GUI tools to the table for you to start getting an understanding of what the annotators do. @@ -72,11 +72,11 @@ In the end that's what this is all about. #Getting started as a committer -Before you are authorized to check-in code or modify web pages you must go through a short process. +Before you are authorized to check in code or modify web pages you must go through a short process. This process is defined in the [FAQs](http://incubator.apache.org/ctakes/ppmc-faqs.html) for the PPMC. For each part of cTAKES you will need some experience or be able to learn it. Code is maintained in subversion and built using maven. The documentation is maintained and served via Confluence. This web site is build from Apache's CMS which is a markdown syntax and build process. -Issues are tracked via Jira. -Communication is done via unique email distribution lists. +Issues are tracked via JIRA. +Communication is done via unique [email distribution lists](http://incubator.apache.org/ctakes/mailing-lists.html). \ No newline at end of file
