ctakes-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From blee...@apache.org
Subject svn commit: r1449181 - /incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext
Date Fri, 22 Feb 2013 19:37:13 GMT
Author: bleeker
Date: Fri Feb 22 19:37:12 2013
New Revision: 1449181

URL: http://svn.apache.org/r1449181
Log:
CMS commit to ctakes by bleeker

Modified:
    incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext

Modified: incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext
URL: http://svn.apache.org/viewvc/incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext?rev=1449181&r1=1449180&r2=1449181&view=diff
==============================================================================
--- incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext (original)
+++ incubator/ctakes/site/trunk/content/ctakes/gettingstarted.mdtext Fri Feb 22 19:37:12 2013
@@ -29,15 +29,18 @@ Downloads and the glossary are best left
 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.
 Use that part of the site to see how you can participate.
 
-Next you will see sections for *Users* and *Developers* and *PPMC* (Apache has their own
[definition of users](http://incubator.apache.org/guides/participation.html) matching these.):
+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.
-  - **Committers** are in the PPMC (Podling Project Management Committee). They check-in
code for cTAKES, develop this web site, help the community produce releases, etc.
+  - **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 this project.
+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.
+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 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
 Users are typically looking for the fastest way to get set up and try out the code. 
@@ -45,9 +48,11 @@ For this use case, cTAKES distributes a 
 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.
+If you would like more of the 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. If you care to, you can download
the source distribution from the downloads page or simply point your browser to the [cTAKES
source code](http://svn.apache.org/viewvc/incubator/ctakes/).
+Being an Apache project, the source code is open to all. 
+If you care to, you can download the source distribution from the downloads page or simply
point your browser to the [cTAKES source code](http://svn.apache.org/viewvc/incubator/ctakes/).
 
 #Getting started as a developer
 Developers can also take a look at the code as a user does, but to do development you are
going to need to checkout the code. Anyone can checkout the code, but you must get involved
as a committer to actually check in code (or work closely with a committer who can).
@@ -61,10 +66,17 @@ You will find an extremely short set of 
 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.
 
 #Running the cTAKES annotators
-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. 
+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. 
 The guides will show how to launch these tools (Developers your guide shows how to launch
from Eclipse) and then how to process some test text. 
 After you understand what is going on you will be able to take out the GUIs and process large
amounts of clinical text to meet your needs.
 In the end that's what this is all about.
 
 #Getting started as a committer
-TBD
+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.



Mime
View raw message