From: <am...@us...> - 2006-03-12 23:55:28
|
Revision: 84 Author: amooy Date: 2006-03-12 15:55:16 -0800 (Sun, 12 Mar 2006) ViewCVS: http://svn.sourceforge.net/sensor/?rev=84&view=rev Log Message: ----------- Work in progress on the site documentation Modified Paths: -------------- trunk/sensor-site/xdocs/braindump.xml trunk/sensor-site/xdocs/images/sensor-logo.png trunk/sensor-site/xdocs/index.xml trunk/sensor-site/xdocs/navigation.xml trunk/sensor-site/xdocs/stylesheets/maven-sensor.css Added Paths: ----------- trunk/sensor-site/xdocs/roadmap.xml Modified: trunk/sensor-site/xdocs/braindump.xml =================================================================== --- trunk/sensor-site/xdocs/braindump.xml 2006-03-12 23:28:17 UTC (rev 83) +++ trunk/sensor-site/xdocs/braindump.xml 2006-03-12 23:55:16 UTC (rev 84) @@ -2,7 +2,6 @@ <document> <properties> - <author email="age.mooy AT gmail.com">Age Mooy</author> <title>The Giant TODOs / Ideas / Braindump List</title> </properties> Modified: trunk/sensor-site/xdocs/images/sensor-logo.png =================================================================== (Binary files differ) Modified: trunk/sensor-site/xdocs/index.xml =================================================================== --- trunk/sensor-site/xdocs/index.xml 2006-03-12 23:28:17 UTC (rev 83) +++ trunk/sensor-site/xdocs/index.xml 2006-03-12 23:55:16 UTC (rev 84) @@ -2,7 +2,6 @@ <document> <properties> - <author email="age.mooy AT gmail.com">Age Mooy</author> <title>What is Sensor ?</title> </properties> @@ -12,12 +11,12 @@ Sensor is a tool for monitoring the runtime performance of Java applications with as little overhead as possible. It can perform timing of application code and make other types of low-level measurements. It can be applied to Java - applications in a number of ways, ranging from aspects to hardcoding, whichever - you prefer. + applications in a number of ways, ranging from aspects and interceptors to + hardcoding, whichever you prefer. </p> <p> - Please read the <b><a href="braindump.html">Ideas Braindump</a></b> page to get + Please read the <b><a href="roadmap.html">roadmap</a></b> page to get an idea about the goals, functionality, and scope of the project. </p> Modified: trunk/sensor-site/xdocs/navigation.xml =================================================================== --- trunk/sensor-site/xdocs/navigation.xml 2006-03-12 23:28:17 UTC (rev 83) +++ trunk/sensor-site/xdocs/navigation.xml 2006-03-12 23:55:16 UTC (rev 84) @@ -4,30 +4,39 @@ <title>Sensor</title> <body> <links> - <item name="Home" href="index.html"/> - <item name="Dashboard" href="dashboard-report.html"/> - <item name="Core Module" href="modules/sensor-core/index.html"/> - <item name="Support Module" href="modules/sensor-support/index.html"/> - <item name="Reporting Module" href="modules/sensor-reporting/index.html"/> + <item name="Home" href="index.html"/> + <item name="Downloads" href="http://sourceforge.net/project/showfiles.php?group_id=140895"/> + <item name="Core Module" href="modules/sensor-core/index.html"/> + <item name="Support Module" href="modules/sensor-support/index.html"/> + <item name="Web Console Module" href="modules/sensor-console/index.html"/> </links> <menu name="Sensor"> <item name="Home" href="index.html"/> - <item name="Ideas Braindump" href="braindump.html"/> + <item name="Roadmap" href="roadmap.html"/> </menu> <menu name="Modules"> <item name="Core Module" href="modules/sensor-core/index.html"/> <item name="Support Module" href="modules/sensor-support/index.html"/> - <item name="Reporting Module" href="modules/sensor-reporting/index.html"/> + <item name="WebConsole Module" href="modules/sensor-console/index.html"/> </menu> - + + <menu name="Documentation"> + <item name="Getting Started" href="index.html"/> + <item name="Working With Timers" href="index.html" collapse="true"> + <item name="Basic API" href="index.html"/> + <item name="Applying Timers" href="index.html"/> + <item name="Reporting" href="index.html"/> + </item> + </menu> + <powered-by> <item name="Coverage by Clover" - href="http://www.cenqua.com/clover" + href="http://www.cenqua.com/clover/" img="http://www.cenqua.com/images/clovered1.gif"/> <item name="Hosted by SourceForge" - href="http://www.sourceforge.net" + href="http://www.sourceforge.net/projects/sensor/" img="http://sourceforge.net/sflogo.php?group_id=140895&type=1"/> </powered-by> </body> Added: trunk/sensor-site/xdocs/roadmap.xml =================================================================== --- trunk/sensor-site/xdocs/roadmap.xml (rev 0) +++ trunk/sensor-site/xdocs/roadmap.xml 2006-03-12 23:55:16 UTC (rev 84) @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title>The Giant TODOs / Ideas / Braindump List</title> + </properties> + + <body> + <section name="Roadmap"> + <p> + This page describes the short-term Sensor roadmap for the first few releases + and gives some indications where Sensor might go in the future. + </p> + </section> + + <section name="Alpha 1 Release"> + <p> + The first alpha release should contain the absolute basics. + Its sole purpose it to get something usable out there that people can play with. + </p> + + <subsection name="Functionalily"> + <p> + <ul> + <li>Basic timing API finished and tested</li> + <li>Spring integration support classes (interceptors, filters, etc.) finished and tested.</li> + <li>Basic pluggable web console implemented</li> + <li>Basic documentation ready</li> + </ul> + </p> + </subsection> + + <subsection name="Non-functional Requirements"> + <p> + <ul> + <li>Get JIRA issue tracking setup at http://os.inspiring.nl/jira/</li> + <li>The modules should be buildable for everyone using only maven and public repositories.</li> + <li>The web console should be deployable to any web container supporting it.</li> + </ul> + </p> + </subsection> + </section> + + <section name="Alpha 2 Release"> + <p> + The seconds alpha elease will concentrate on expanding the range of sensors to + non-timing types, better reporting, remoting (JMX, web services, etc). + </p> + + <subsection name="Functionalily"> + <p> + <ul> + <li></li> + <li></li> + </ul> + </p> + </subsection> + </section> + + </body> +</document> Modified: trunk/sensor-site/xdocs/stylesheets/maven-sensor.css =================================================================== --- trunk/sensor-site/xdocs/stylesheets/maven-sensor.css 2006-03-12 23:28:17 UTC (rev 83) +++ trunk/sensor-site/xdocs/stylesheets/maven-sensor.css 2006-03-12 23:55:16 UTC (rev 84) @@ -1,77 +1,199 @@ +/* ============================================================================ + Main body elements +============================================================================ */ + body { padding: 0px 0px 10px 0px; } + +#bodyColumn { + margin-right: 1.5em; + margin-left: 197px; +} + body, td, select, input, li{ font-family: Verdana, Helvetica, Arial, sans-serif; font-size: 13px; } -code{ - font-size: 13px; + +#organizationLogo img { + margin: 8px; } + +#projectLogo img, #projectLogo span { + margin-top: 20px; + margin-right: 10px; + margin-bottom: 10px; +} + +#banner { + border-bottom: 1px solid #fff; +} + +/* ============================================================================ + Navigation areas +============================================================================ */ + +#breadcrumbs { + border-top: 1px solid #aaa; + border-bottom: 1px solid #aaa; + background-color: #e2f3b8; +} + +/*#leftColumn { + margin: 10px 0 0 5px; + border: 1px solid #999; + background-color: #92fa58; +}*/ + +#leftColumn { + margin: 10px 0 10px 0; + border: 1px solid #ccc; + border-top: none; + border-left: none; + padding-right: 0; + padding-left: 0; + width: 180px; + background-color: #e2f3b8; +} + +#navcolumn { + margin: 0 !important; + padding: 0 !important; +} + +/*#navcolumn h5 { + font-size: smaller; + border-bottom: 1px solid #aaaaaa; + padding-top: 2px; +}*/ + +#navcolumn h5 { + font-size: 11px; + padding: 1px 0 1px 12px; + color: #666; + background-position: left 5px; + font-variant: small-caps; + border: none; + border-bottom: 1px solid #ccc; + border-top: 1px solid #ccc; + background-color: #ECFEBC; +} + +#navcolumn ul { + margin: 3px 0 5px -0em; +} + +#navcolumn ul a { + color: #333333; +} + +#navcolumn ul a:hover { + color: red; +} + +#navcolumn ul li { + background-image: url(../images/list.png); + background-position: top left; +} + +#navcolumn ul li.expanded { + background-image: none; + font-weight: bold; + color: #666; +} + +#navcolumn ul li.expanded ul { + margin-top: 0; + margin-bottom: 0; +} + +#navcolumn ul li.expanded ul li { + font-weight: normal; +} + + +/* ============================================================================ + Links +============================================================================ */ + a { text-decoration: none; } + a:link { color:#36a; } + a:visited { color:#47a; } + a:active, a:hover { color:#69c; } + +a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover { + background: url(../images/external.png) right center no-repeat; + padding-right: 18px; +} +a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover { + background: url(../images/newwindow.png) right center no-repeat; + padding-right: 18px; +} + +/* ============================================================================ + Legend area +============================================================================ */ + #legend li.externalLink { background: url(../images/external.png) left top no-repeat; padding-left: 18px; } -a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover { - background: url(../images/external.png) right center no-repeat; - padding-right: 18px; -} #legend li.newWindow { background: url(../images/newwindow.png) left top no-repeat; padding-left: 18px; } -a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover { - background: url(../images/newwindow.png) right center no-repeat; - padding-right: 18px; -} + +/* ============================================================================ + Headers +============================================================================ */ + h2 { - padding: 4px 4px 4px 6px; - border: 1px solid #999; - color: #fff; - background-color: #61a4db; - font-weight:900; - font-size: x-large; + font-family: Arial, Helvetica, sans-serif; + font-size: 28px; + color: #666; + background: none; + font-weight: normal; + padding-left: 0; + border: none; + border-bottom: 1px dotted #ccc; } + h3 { - padding: 4px 4px 4px 6px; - border: 1px solid #aaa; - color: #fff; - background-color: #61a4db; - font-weight:900; - font-size: large; + font-family: Arial, Helvetica, sans-serif; + padding: 4px 4px 4px 0; + color: #999 !important; + background: none; + font-weight: none; + font-size: 20px; + border: none; + border-bottom: 1px dotted #ccc; } + + +/* ============================================================================ + Misc +============================================================================ */ + p { line-height: 1.3em; font-size: small; } -#breadcrumbs { - border-top: 1px solid #aaa; - border-bottom: 1px solid #aaa; - background-color: #ccc; -} -#leftColumn { - margin: 10px 0 0 5px; - border: 1px solid #999; - background-color: #eee; -} -#navcolumn h5 { - font-size: smaller; - border-bottom: 1px solid #aaaaaa; - padding-top: 2px; -} + + + table.bodyTable th { color: white; background-color: #bbb; @@ -91,6 +213,11 @@ background-color: #eee; } + +code{ + font-size: 13px; +} + .source { border: 1px solid #999; } @@ -99,9 +226,4 @@ color: #900; background-color: #eee; } -#organizationLogo img, #projectLogo img, #projectLogo span{ - margin: 8px; -} -#banner { - border-bottom: 1px solid #fff; -} + This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ldi...@us...> - 2006-03-19 17:56:29
|
Revision: 93 Author: ldikmans Date: 2006-03-19 09:56:20 -0800 (Sun, 19 Mar 2006) ViewCVS: http://svn.sourceforge.net/sensor/?rev=93&view=rev Log Message: ----------- Added documentation for developers Modified Paths: -------------- trunk/sensor-site/xdocs/navigation.xml Added Paths: ----------- trunk/sensor-site/xdocs/developersguide.xml trunk/sensor-site/xdocs/eclipsestart.xml trunk/sensor-site/xdocs/mavenbuild.xml Added: trunk/sensor-site/xdocs/developersguide.xml =================================================================== --- trunk/sensor-site/xdocs/developersguide.xml (rev 0) +++ trunk/sensor-site/xdocs/developersguide.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Developers Guide</title> + </properties> + + <body> + This guide is meant for developers who want to contribute to Sensor. + </body> +</document> \ No newline at end of file Added: trunk/sensor-site/xdocs/eclipsestart.xml =================================================================== --- trunk/sensor-site/xdocs/eclipsestart.xml (rev 0) +++ trunk/sensor-site/xdocs/eclipsestart.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Quick start with eclipse </title> + </properties> + + <body> + <section>This quickstart describes the setup for eclipse + + <subsection name="Prerequisites"> + <li>eclipse version 3.1.x or higher</li> + <li>maven 1.0.2 or maven 1.1</li> + </subsection> + + <subsection name="Optional"> + <li>subclipse to download the sources from the subversion repository</li> + <li>WTP </li> + <li>Maviclipse </li> + </subsection> + + <subsection name="Installation in Eclipse"> + <ul> + <li>Create a workspace in eclipse (version 3.1.x or higher)</li> + <li>Preferences: + <ul> + <li>Installed JRE: 1.4.2 or higher.</li> + <li>Create a classpath variable (Java/Build path) in eclipse named: MAVEN_REPO that points to the maven repository.</li> + </ul> + </li> + <li>Use the SVN repository browser and point to https://svn.sourceforge.net/svnroot/sensor </li> + <li>Check out the four (or three) modules into workspace as projects:"</li> + <ul> + <li>sensor-console</li> + <li>sensor-core</li> + <li>sensor-site (if you plan to add documentation) </li> + <li>sensor-support</li> + </ul> + <li> + <links> + <item name="build sensor with maven" href="mavenbuild.html"/> + </links> + </li> + <li>refresh the projects in eclipse</li> + </ul> + Now all the projects should compile in eclipse and you are ready to go! + + </subsection> + </section> + </body> +</document> \ No newline at end of file Added: trunk/sensor-site/xdocs/mavenbuild.xml =================================================================== --- trunk/sensor-site/xdocs/mavenbuild.xml (rev 0) +++ trunk/sensor-site/xdocs/mavenbuild.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="utf-8"?> + +<document> + <properties> + <title> Installation with Maven</title> + </properties> + + <body> + <section> + This paragraph describes building sensor with Maven. + <subsection name="installing the jar files"> + <li>Navigate to the directory of sensor-core and run maven jar:install</li> + <li>Navigate to the directory of sensor-support and run maven jar:install</li> + </subsection> + <subsection name="installing the sensor console"> + Note: this is an unusual situation, usually you would configure the application to run with another application. + <li>Navigate to the directory of sensor-console and run maven war:war</li> + <li>Deploy the application to Tomcat or another J2EE server</li> + <li>Open a browser and point to “http://[host]:[port]/[context-root]/timing/statistics.htm“. For tomcat the URL could be: http://localhost:8080/sensor-console/timing/statistics.htm” </li> + </subsection> + </section> + </body> +</document> \ No newline at end of file Modified: trunk/sensor-site/xdocs/navigation.xml =================================================================== --- trunk/sensor-site/xdocs/navigation.xml 2006-03-19 17:55:54 UTC (rev 92) +++ trunk/sensor-site/xdocs/navigation.xml 2006-03-19 17:56:20 UTC (rev 93) @@ -24,6 +24,10 @@ <menu name="Documentation"> <item name="Getting Started" href="index.html"/> + <item name="Developers Guide" href="developersguide.html" collapse="false"> + <item name="Quick start for Eclipse" href="eclipsestart.html"/> + <item name="Quick start for Maven" href="mavenbuild.html"/> + </item> <item name="Working With Timers" href="index.html" collapse="true"> <item name="Basic API" href="index.html"/> <item name="Applying Timers" href="index.html"/> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |