incubator-kitty-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From msa...@apache.org
Subject svn commit: r1058310 - in /incubator/kitty/site/trunk/content/kitty: getting-Started.mdtext index.mdtext
Date Wed, 12 Jan 2011 20:54:14 GMT
Author: msacks
Date: Wed Jan 12 20:54:14 2011
New Revision: 1058310

URL: http://svn.apache.org/viewvc?rev=1058310&view=rev
Log:
added getting started guide and updated main homepage

Added:
    incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext   (with props)
Modified:
    incubator/kitty/site/trunk/content/kitty/index.mdtext

Added: incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext
URL: http://svn.apache.org/viewvc/incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext?rev=1058310&view=auto
==============================================================================
--- incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext (added)
+++ incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext Wed Jan 12 20:54:14 2011
@@ -0,0 +1,88 @@
+Title: Getting Started Developing for Apache Kitty
+Notice:    Licensed to the Apache Software Foundation (ASF) under one
+           or more contributor license agreements.  See the NOTICE file
+           distributed with this work for additional information
+           regarding copyright ownership.  The ASF licenses this file
+           to you under the Apache License, Version 2.0 (the
+           "License"); you may not use this file except in compliance
+           with the License.  You may obtain a copy of the License at
+           .
+             http://www.apache.org/licenses/LICENSE-2.0
+           .
+           Unless required by applicable law or agreed to in writing,
+           software distributed under the License is distributed on an
+           "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+           KIND, either express or implied.  See the License for the
+           specific language governing permissions and limitations
+           under the License.
+
+Kitty is a command line JMX Client written in Groovy. 
+Kitty is currently an Apache Incubator project, and is growing as a JMX administration utility
for applications which support JMX. Kitty is an excellent project to begin contributing to
an open source project, and filing a need amongst Java developers for a handy utility for
managing and monitoring applications through JMX in a way that is intuitive and user friendly.

+<br />
+<h3>What you will learn in this document</h3>
+<br />
+In this document you will learn how to set up your development environment so that you can
begin developing for Kitty. Kitty is currently a very simple project to work on, it is written
in Groovy, which is a fun language to write code in, and a great opportunity for those looking
to begin contributing to an open source project which has immediate usefulness.
+<br />
+<h3>Finding something to work on</h3>
+<br /><br />
+
+There are many things to be worked on for the Kitty project. The best way to find out what
needs to be done on the project (or any other ASF Incubator project), is to send a message
out to the dev mailing list. You can subscribe to the Kitty-dev mailing list by sending a
blank email to kitty-dev-subscribe@incubator.apache.org. Then you will receive a confirmation
message once you are subscribed to the list. If you don't want to subscribe, but want to send
a message to the list, you can simply send a message to kitty-dev@incbuator.apache.org and
it will be moderated by the mailing list administrators.
+<br />
+If you are interested in being a committer for the project, see http://www.apache.org/dev/new-committers-guide.html.

+<br />
+Also, you may investigate the open issues for Kitty in the ASF JIRA to find out which tasks
and bugs need to be worked on. This is also a great starting point for getting involved and
contributing to the project. https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12311202&status=1
+<br /><br />
+<h3>Setting up your IDE</h3>
+<br /><br />
+It is suggested to download the Eclipse IDE to begin working on Kitty. This allows you to
keep better track of the source code of the project and integrates with Subversion. You may
use any editor or IDE you choose, in this example, Eclipse is used. 
+<br />
+Step 1) Download Eclipse from http://www.eclipse.org/downloads/. I have chosen the "Eclipse
IDE for Java Developers"
+Step 2) Install the Subversive Plugin for Subversion integration by following the instructions
at http://www.eclipse.org/subversive/documentation/gettingStarted/aboutSubversive/install.php
+<br />
+NOTE: You should now see a "SVN Repositories" button on the top right view, or by navigating
to Window->Show View->SVN Repositories
+<br />
+NOTE: You will need to change the update site for the Subversive connectors, if you don't
do this it is likely that the connector installation will fail. You should use http://download.eclipse.org/technology/subversive/0.7/update-site/
fro the connectors update site. See http://www.eclipse.org/subversive/downloads.php "Is it
right that version 0.7 is newer than versions 1.1.0 and 1.0.0, which I previously used?" in
the FAQs for a further explanation. If you run into trouble here, send a message to the mailing
list and someone will help you.
+
+Step 3) Append or use the following .subversion/config file to properly set your Subversion
configuration for ASF/Kitty use. 
+
+Step 4) Download Groovy from http://groovy.codehaus.org/Download
+Step 5) Install the Groovy-Eclipse plugin by following the instructions at http://groovy.codehaus.org/Eclipse+Plugin
under "How to Install"
+
+Step 6) Navigate to SVN Repositories by clicking the SVN Repositories button in the top right-hand
corner or by going to the menu: "Window->Show View->SVN Repositories"
+
+Step 7) Click the menu: "New->Repository Location"
+Step 8) Enter https://svn.apache.org/repos/asf/incubator/kitty/ for the URL. Leave all other
fields blank, unless you are a commuter. 
+<br />
+NOTE: Unless you are a committer, you will be unable to commit changes through SVN. If you'd
like to be a committer, send a message out to the kitty-dev@incubator.apache.org mailing list,
our simply attach a patch to the mailing list and one of the committers will check it in.
For guidelines on submitting a patch: see http://subversion.apache.org/docs/community-guide/general.html#patches.

+<br />
+Now you will have set up your development environment for working with Kitty. You will now
need to set up and configure Apache Ant to build the project. 
+<br /><br />
+<h3>Building and running Kitty</h3>
+<br /><br />
+To build the project, you will need to do update your build patch to include the location
of the Groovy binaries. Switch that he Navigator view by going to the menu "Window->Show
View->Navigator".
+
+
+Step 1) Change the line in the Ant build.xml which shows: 
+		<fileset dir="/Users/msacks/groovy-1.7.4/lib"><br />
+to point to the properly installed path of your Groovy ./lib directory. 
+
+Step 2) Right click the buid.xml file and select "Run As->Ant build"
+<br /><br />
+
+You should now see a message in the Eclipse console stating: "BUILD SUCCESSFUL"
+
+To run Kitty:
+<br /><br />
+Step 1) Navigate to src/org/apache/kitty/
+Step 2) Right click on CmdShell.groovy
+Step 3) Select "Run As->Groovy script"
+<br /><br />
+
+Now you will see Kitty running in the Eclipse Console. Type help to see a list of available
commands. Now you may use and test Kitty!
+
+<br /><br />
+NOTE: This document is continuously being improved. For suggestions on updating this document,
send a message to the kitty-dev mailing list. Patches are welcome for the site as well.
+
+<br /><br />
+
+<a href="http://incubator.apache.org/kitty/">Kitty Home</a>
\ No newline at end of file

Propchange: incubator/kitty/site/trunk/content/kitty/getting-Started.mdtext
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/kitty/site/trunk/content/kitty/index.mdtext
URL: http://svn.apache.org/viewvc/incubator/kitty/site/trunk/content/kitty/index.mdtext?rev=1058310&r1=1058309&r2=1058310&view=diff
==============================================================================
--- incubator/kitty/site/trunk/content/kitty/index.mdtext (original)
+++ incubator/kitty/site/trunk/content/kitty/index.mdtext Wed Jan 12 20:54:14 2011
@@ -1,4 +1,4 @@
-Title: Kitty Home Page
+Title: Apache Kitty Home Page
 Notice:    Licensed to the Apache Software Foundation (ASF) under one
            or more contributor license agreements.  See the NOTICE file
            distributed with this work for additional information
@@ -16,16 +16,22 @@ Notice:    Licensed to the Apache Softwa
            specific language governing permissions and limitations
            under the License.
 
-<h2>Kitty is a lightweight, production focused, Java-based application server performance
diagnostic and management utility designed specifically for Apache Tomcat.</h2>
+<h2>Kitty is a lightweight, production focused, command-line JMX Client</h2>
 <br />
 Quick Links: 
 <a href="https://issues.apache.org/jira/browse/KITTY">Kitty JIRA</a>
 <a href="http://incubator.apache.org/projects/kitty.html">Incubation Status</a>
 <a href="http://www.scribd.com/doc/41349990/Kitty-Apachecon-2010">Kitty ApacheCon 2010</a>
 
+Getting Started in Developing for Apache Kitty: 
+<a href="http://incubator.apache.org/kitty/">Getting Started</a>
+
 <br /><br />
 Mailing List: <a href="mailto:kitty-dev@incubator.apache.org>kitty-dev@incubator.apache.org</a>
 To subscribe: <a href="mailto:kitty-dev-subscribe@incubator.apache.org>kitty-dev-subscribe@incubator.apache.org</a>
 <br /><br />
 <strong>History:</strong>
-Originally, kitty was written to provide a simple utility for managing and diagnosting Tomcat
servers in production. It was originally written in Jython, but has since been ported to Groovy
for ease of compilation to Java classes. 
+Originally, kitty was written to provide a simple utility for managing and diagnosing Tomcat
servers in production. It was originally written in Jython, but has since been ported to Groovy
for ease of compilation to Java classes. 
+<br /><br />
+<strong>Roadmap</strong>
+Coming soon



Mime
View raw message