diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000000000000000000000000000000000..f7ab6fb3cf36816e88e20cc2aeff5602b519b997 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "src/site/markdown/wiki"] + path = src/site/markdown/wiki + url = gitlab@build.se.informatik.uni-kiel.de:chw/teetime.wiki.git diff --git a/pom.xml b/pom.xml index 7354b67771a257fa131e00fba908704523014a16..aa3233a6d322c89551cb9d37e9fcf316d9566273 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,16 @@ <java.version>1.6</java.version> </properties> + <issueManagement> + <system>GitLab</system> + <url>https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/issues/</url> + </issueManagement> + <distributionManagement> + <site> + <id>teetime.sf.net</id> + <url>scp://shell.sourceforge.net/home/project-web/teetime/htdocs</url> + </site> <snapshotRepository> <id>teetime-deployment</id> <url>https://oss.sonatype.org/content/repositories/snapshots</url> @@ -55,8 +64,14 @@ <connection>scm:git:https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime.git</connection> <developerConnection>scm:git:ssh://gitlab@build.se.informatik.uni-kiel.de:chw/teetime.git</developerConnection> <url>https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/</url> + <tag>teetime-1.0</tag> </scm> + <ciManagement> + <system>Jenkins</system> + <url>https://build.se.informatik.uni-kiel.de/jenkins/view/TeeTime/</url> + </ciManagement> + <dependencies> <dependency> <groupId>junit</groupId> @@ -101,7 +116,12 @@ <build> <plugins> - + <!-- Release plugin --> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-release-plugin</artifactId> + <version>2.5.1</version> + </plugin> <!-- we want JDK 1.6 source and binary compatibility --> <plugin> <groupId>org.apache.maven.plugins</groupId> @@ -194,7 +214,9 @@ <executions> <execution> <phase>test</phase> - <goals><goal>check</goal></goals> + <goals> + <goal>check</goal> + </goals> <configuration> <configLocation>${project.basedir}/conf/quality-config/cs-conf.xml</configLocation> <includeTestSourceDirectory>true</includeTestSourceDirectory> @@ -254,12 +276,59 @@ </execution> </executions> </plugin> - + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.3</version> + <dependencies> + <!-- for using markdown syntax --> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-module-markdown</artifactId> + <version>1.3</version> + </dependency> + <!-- add support for ssh/scp --> + <dependency> + <groupId>org.apache.maven.wagon</groupId> + <artifactId>wagon-ssh</artifactId> + <version>1.0</version> + </dependency> + <!-- skin --> + <dependency> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-velocity-tools</artifactId> + <version>1.1.1</version> + </dependency> + <!-- Reflow skin requires Velocity >= 1.7 --> + <dependency> + <groupId>org.apache.velocity</groupId> + <artifactId>velocity</artifactId> + <version>1.7</version> + </dependency> + </dependencies> + </plugin> </plugins> </build> <reporting> <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-changes-plugin</artifactId> + <version>2.11</version> + <configuration> + <issueLinkTemplatePerSystem> + <Gitlab>%URL%/%ISSUE%</Gitlab> + </issueLinkTemplatePerSystem> + </configuration> + <reportSets> + <reportSet> + <reports> + <report>changes-report</report> + </reports> + </reportSet> + </reportSets> + </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> @@ -273,6 +342,19 @@ </reportSets> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.10.1</version> + <configuration> + <links> + <link>${basedir}/src/site/index.html</link> + </links> + <!-- <stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile> --> + <!-- <show>public</show> --> + </configuration> + </plugin> + <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> @@ -345,4 +427,5 @@ </profile> </profiles> + </project> diff --git a/run-configurations/Generate Homepage.launch b/run-configurations/Generate Homepage.launch new file mode 100644 index 0000000000000000000000000000000000000000..f00803dc1c4bfca7c0c3b09bf50d9431d7df71bb --- /dev/null +++ b/run-configurations/Generate Homepage.launch @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<launchConfiguration type="org.eclipse.m2e.Maven2LaunchConfigurationType"> +<booleanAttribute key="M2_DEBUG_OUTPUT" value="false"/> +<stringAttribute key="M2_GOALS" value="site"/> +<booleanAttribute key="M2_NON_RECURSIVE" value="false"/> +<booleanAttribute key="M2_OFFLINE" value="false"/> +<stringAttribute key="M2_PROFILES" value=""/> +<listAttribute key="M2_PROPERTIES"/> +<stringAttribute key="M2_RUNTIME" value="EMBEDDED"/> +<booleanAttribute key="M2_SKIP_TESTS" value="false"/> +<intAttribute key="M2_THREADS" value="1"/> +<booleanAttribute key="M2_UPDATE_SNAPSHOTS" value="false"/> +<stringAttribute key="M2_USER_SETTINGS" value=""/> +<booleanAttribute key="M2_WORKSPACE_RESOLUTION" value="false"/> +<booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_START_ON_FIRST_THREAD" value="true"/> +<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="/Users/nel/git/teetime"/> +</launchConfiguration> diff --git a/src/changes/changes.xml b/src/changes/changes.xml new file mode 100644 index 0000000000000000000000000000000000000000..7ca35aac704dbc8c86577ed4ea1c7f7a1ae8cf9c --- /dev/null +++ b/src/changes/changes.xml @@ -0,0 +1,19 @@ +<document xmlns="http://maven.apache.org/changes/1.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/changes/1.0.0 http://maven.apache.org/xsd/changes-1.0.0.xsd"> + <properties> + <title>Release notes</title> + </properties> + <body> + <release version="Snapshot" date="Daily basis" description="Unstable preview of oncoming versions"> + <action dev="ntd" type="add" issue="66"> + Created a new site to promote TeeTime. + </action> + </release> + <release version="1.0" date="Soon" description="Initial release"> + <action type="add"> + Initial release of TeeTime + </action> + </release> + </body> +</document> \ No newline at end of file diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml new file mode 100644 index 0000000000000000000000000000000000000000..d27c88e4e1a568d9f247199c5d48350ebc0264df --- /dev/null +++ b/src/site/fml/faq.fml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> +<faqs xmlns="http://maven.apache.org/FML/1.0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd" + title="Frequently Asked Questions" + toplink="false"> + + <part id="general"> + <title>General</title> + + <faq id="whats-foo"> + <question> + What is Foo? + </question> + <answer> + <p>some markup goes here</p> + + <source>some source code</source> + + <p>some markup goes here</p> + </answer> + </faq> + + <faq id="whats-bar"> + <question> + What is Bar? + </question> + <answer> + <p>some markup goes here</p> + </answer> + </faq> + </part> + + <part id="install"> + + <title>Installation</title> + + <faq id="how-install"> + <question> + How do I install Foo? + </question> + <answer> + <p>some markup goes here</p> + </answer> + </faq> + + </part> + +</faqs> \ No newline at end of file diff --git a/src/site/markdown/contribute.md b/src/site/markdown/contribute.md new file mode 100644 index 0000000000000000000000000000000000000000..76638b02f4f4becb199e62f461d2eefcd5c0da91 --- /dev/null +++ b/src/site/markdown/contribute.md @@ -0,0 +1,51 @@ +## Contribute + +If you want to participate in the development, feel free to [contact us](team-list.html). + + +### Access to source code + +You can also download the source code from our Git repository. +Following URL's will give you read-only access to our server: + +```xml +ssh://gitlab@build.se.informatik.uni-kiel.de:chw/teetime.git +``` + +or + +```xml +http://build.se.informatik.uni-kiel.de/gitlab/chw/teetime.git +``` + +### Workflow + +If you contribute, please follow our guidelines to comply to our quality standards. + + + +#### Git guidelines + +- To update a branch, use the code commands ``fetch`` and ``rebase`` in this order. + +- Create a new branch for every code modification you want to perform. + +- Contribute your changes and fixes by using the [merge request](https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/merge_requests) function in GitLab. + +- Last, but not least, participate in discussions within our issue tracking system. + +#### Issue tracking + +- Create a ticket for every major bug. + +- Comment on tickets you are working on and let others know what you are doing. + +- Describe the issue in a short but understandable way. + +- Use Tags for tickets, which fit the issue and mark bugs as ``solved``. + +### Support + +If you are using TeeTime and run into problems, consider to report the issue or [contact us](team-list.html). Every reported issue can help to improve TeeTime. + +We really appreciate any ideas or suggestions. \ No newline at end of file diff --git a/src/site/markdown/download.md b/src/site/markdown/download.md new file mode 100644 index 0000000000000000000000000000000000000000..22f1d6b3175d601857e5022208bbcfebeff5c19b --- /dev/null +++ b/src/site/markdown/download.md @@ -0,0 +1,71 @@ +# Download + +There are several ways to get TeeTime. Choose the best one for you. + +## Latest stable + +There are two simple ways to add TeeTime to your own project. + +>Please note, that TeeTime's first official release isn't published yet. You can switch to the snapshot release or wait a couple of days. We are looking forward, to release 1.0 still this month. + +#### As dependency + +TeeTime is available through Maven's central repository. + +If you use Maven, simply add following lines to your ``pom.xml``: + +```xml +<dependency> + <groupId>net.sourceforge.teetime</groupId> + <artifactId>teetime</artifactId> + <version>1.0</version> +</dependency> +``` + +<!--- Dependency informations for other project management tools can be found [here](dependency-info.html). --> +Please make sure, your project management tool uses Maven's central repository. Help on how to add it, can be found [here](http://central.sonatype.org/pages/consumers.html). + +#### Binaries and sources + +The latest TeeTime release can be downloaded directly from [Sourceforge](https://sourceforge.net/projects/teetime/files/latest/download). If you also want to download the source and/or JavaDoc, you can also get a summary of available files on [Sourceforge](https://sourceforge.net/projects/teetime/files/). + +## Snapshot + +TeeTime is built upon a daily basis. All these nightly builds are accessible to the public. + +Please do not forget, that this releases are not intended for daily use. These builds may be unstable. + +#### As dependency + +All snapshot builds will be deployed to Sonatype's snapshot repository. + +To download these builds, add following lines to your project's ``pom.xml``: + +```xml +<dependency> + <groupId>net.sourceforge.teetime</groupId> + <artifactId>teetime</artifactId> + <version>1.0-SNAPSHOT</version> +</dependency> +``` + +If you did not add the Sonatype snapshot repository yet to your ``pom.xml``, add also following lines to it, as otherwise Maven will not be able to find the needed artifacts: + +```xml +<repositories> + <repository> + <id>sonatype.oss.snapshots</id> + <url>https://oss.sonatype.org/content/repositories/snapshots/</url> + </repository> +</repositories> +``` + + +#### Binaries and sources + +All nightly builds can be found on [Sonatype's repository](https://oss.sonatype.org/content/repositories/snapshots/net/sourceforge/teetime/teetime/) or our [CI Server](https://build.se.informatik.uni-kiel.de/jenkins/view/TeeTime/job/teetime-nighly-release/lastSuccessfulBuild/artifact/target/). + +## Release notes + +All changes can be found on our [release notes](changes-report.html) page. + diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md new file mode 100644 index 0000000000000000000000000000000000000000..6a783594467f610639545b860f7eeca66cc399a8 --- /dev/null +++ b/src/site/markdown/index.md @@ -0,0 +1,63 @@ +#### TeeTime + + + +Implement your analysis or filters in a new, easy and fast way. + +#### Simple & Fast + + + +The main focus is on fast execution and easy usage. + +#### Start today + + + +Predefined stages are provided within the source code. You can immediatly start to write your own analysis. + +--- + + +## What is it? + +<!---  TeeTime Logo --> +TeeTime is a Pipes-And-Filters-Framework for Java. + +It provides various features, which will bring you to the next level of analysis programming, such like: + +- Concurrent execution of stages + +- Flexible connection between stages + +- Typed ports + +- Pre-defined stages and pipelines + +## Where to get it + +TeeTime is available in many ways. If your projects use Maven, just add following dependency to your ``pom.xml``: + +```xml +<dependency> + <groupId>net.sourceforge.teetime</groupId> + <artifactId>teetime</artifactId> + <version>1.0</version> +</dependency> +``` + +>TeeTime's first official release is not published yet. For more information, see [download](download.html). + +To get the source code or the plain jar, take a look at the [download](download.html) section. + +## How to use it + +To make working with TeeTime as pleasant and efficient as possible, this homepage provides various tools for you, which explain TeeTime's functions. + +You can take a closer look at: + +- [TeeTime's Wiki](https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/wikis/home). + +- [API Documentation](apidocs/index.html). + + \ No newline at end of file diff --git a/src/site/markdown/wiki b/src/site/markdown/wiki new file mode 160000 index 0000000000000000000000000000000000000000..0e4474577e1f49bc96e734c286b2d9e0363895e8 --- /dev/null +++ b/src/site/markdown/wiki @@ -0,0 +1 @@ +Subproject commit 0e4474577e1f49bc96e734c286b2d9e0363895e8 diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css new file mode 100644 index 0000000000000000000000000000000000000000..4e65c7ea59bc23e6cf1ed2f43aaabe2f334004e4 --- /dev/null +++ b/src/site/resources/css/site.css @@ -0,0 +1,7 @@ +body { + background-image:url(../images/bg.png); +} + +.slogan { + color: #7E7E7E; +} \ No newline at end of file diff --git a/src/site/resources/images/bg.png b/src/site/resources/images/bg.png new file mode 100644 index 0000000000000000000000000000000000000000..dc6adc76f2823b22c3323e09932935987a688638 Binary files /dev/null and b/src/site/resources/images/bg.png differ diff --git a/src/site/resources/images/code_screenshot.jpg b/src/site/resources/images/code_screenshot.jpg new file mode 100644 index 0000000000000000000000000000000000000000..22faa31f8dd4b3d533321c83e8ac72a5a2a57b5a Binary files /dev/null and b/src/site/resources/images/code_screenshot.jpg differ diff --git a/src/site/resources/images/code_screenshot.png b/src/site/resources/images/code_screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..ff9efb0fa7c1b1a5232bb50abefe1015a989ecb7 Binary files /dev/null and b/src/site/resources/images/code_screenshot.png differ diff --git a/src/site/resources/images/teetime-logo-url.txt b/src/site/resources/images/teetime-logo-url.txt new file mode 100644 index 0000000000000000000000000000000000000000..719f383d57d9b9eddaa8984f32374561f8c7fa26 --- /dev/null +++ b/src/site/resources/images/teetime-logo-url.txt @@ -0,0 +1 @@ +https://www.iconfinder.com/icons/56268/clock_time_wait_watch_icon \ No newline at end of file diff --git a/src/site/resources/images/teetime-w-arrows.png b/src/site/resources/images/teetime-w-arrows.png new file mode 100644 index 0000000000000000000000000000000000000000..24ff16a31980acbd48b66c8536076c50a96015fe Binary files /dev/null and b/src/site/resources/images/teetime-w-arrows.png differ diff --git a/src/site/resources/images/teetime-wo-arrows-shrinked.png b/src/site/resources/images/teetime-wo-arrows-shrinked.png new file mode 100644 index 0000000000000000000000000000000000000000..47beaccb282e6d1532f98f4f07f5ac4275fdb1a0 Binary files /dev/null and b/src/site/resources/images/teetime-wo-arrows-shrinked.png differ diff --git a/src/site/resources/images/teetime-wo-arrows-text-small.png b/src/site/resources/images/teetime-wo-arrows-text-small.png new file mode 100644 index 0000000000000000000000000000000000000000..447488e3dc47ed45e31e4817fe1eb2ba09299bba Binary files /dev/null and b/src/site/resources/images/teetime-wo-arrows-text-small.png differ diff --git a/src/site/resources/images/teetime-wo-arrows-text.png b/src/site/resources/images/teetime-wo-arrows-text.png new file mode 100644 index 0000000000000000000000000000000000000000..79c8395bc1e9eafba9ff130d97822cfdb52a86a4 Binary files /dev/null and b/src/site/resources/images/teetime-wo-arrows-text.png differ diff --git a/src/site/resources/images/teetime-wo-text-25.png b/src/site/resources/images/teetime-wo-text-25.png new file mode 100644 index 0000000000000000000000000000000000000000..4eeb9f740ee83cf051d390d534760f3abc25fb7f Binary files /dev/null and b/src/site/resources/images/teetime-wo-text-25.png differ diff --git a/src/site/resources/images/teetime-wo-text-small.png b/src/site/resources/images/teetime-wo-text-small.png new file mode 100644 index 0000000000000000000000000000000000000000..6420860c8e4c2cd291c4b1bcd02dcf41e6cda59d Binary files /dev/null and b/src/site/resources/images/teetime-wo-text-small.png differ diff --git a/src/site/resources/images/teetime-wo-text-smaller-scaled.png b/src/site/resources/images/teetime-wo-text-smaller-scaled.png new file mode 100644 index 0000000000000000000000000000000000000000..8692f3ff57f0e9015fe15eea3f1afaf34f27492f Binary files /dev/null and b/src/site/resources/images/teetime-wo-text-smaller-scaled.png differ diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 0000000000000000000000000000000000000000..60022d6d4069383ca500b641418c6b7e6e7b3c2a --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,118 @@ +<project name="TeeTime"> + <skin> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-maven-skin</artifactId> + <version>1.1.1</version> + </skin> + + <bannerLeft> + <name> + TeeTime + </name> + <href>http://teetime.sourceforge.net</href> + </bannerLeft> + + <body> + + + <links> + <item name="Download" href="download.html" /> + <item name="Wiki" + href="https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/wikis/home" /> + </links> + <menu name="Documentation"> + <item name="JavaDoc" href="apidocs/index.html" /> + <item name="Project Dependencies" href="dependencies.html" /> + <item name="License" href="license.html" /> + </menu> + <menu name="Get Involved"> + <item name="Contribute" href="contribute.html" /> + <item name="SourceForge Project Site" href="https://sourceforge.net/projects/teetime/" /> + <item name="Issue Tracking" + href="https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/issues" /> + <item name="Team" href="team-list.html" /> + </menu> + <menu name="Main"> + <item name="Home" href="index.html" /> + <item name="Download" href="download.html" /> + <item name="Wiki" + href="https://build.se.informatik.uni-kiel.de/gitlab/chw/teetime/wikis/home" /> + <item name="Release notes" href="changes-report.html" /> + </menu> + <!-- <menu ref="modules"/> --> + <!-- <menu ref="reports"/> --> + </body> + <publishDate position="navigation-bottom" /> + <version position="navigation-bottom" /> + <custom> + <reflowSkin> + <topNav>Download|Wiki|Documentation|Get Involved</topNav> + <!-- <toc>sidebar</toc> --> + <!-- <tocTopMax>4</tocTopMax> --> + <absoluteResourceURL>http://teetime.sourceforge.net + </absoluteResourceURL> + <theme>default</theme> + <highlightJs>true</highlightJs> + <highlightJsTheme>github</highlightJsTheme> + <brand> + <name> + TeeTime + </name> + <href>http://teetime.sourceforge.net</href> + </brand> + <slogan> + <![CDATA[ + <span class="slogan">The next level Pipes-And-Filters-Framework for Java</span> + ]]> + </slogan> + <titleTemplate>%2$s | %1$s</titleTemplate> + <bottomNav maxSpan="9"> + <column>Main</column> + <column>Wiki|Documentation</column> + <column>Get Involved</column> + </bottomNav> + <bottomDescription> + TeeTime is a Pipes-And-Filters-Framework for Java. + It provides a simple way + of analysis tooling. + </bottomDescription> + <pages> + <index> + <breadcrumbs>false</breadcrumbs> + <sections> + <carousel /> + <columns>3</columns> + </sections> + <shortTitle>Welcome</shortTitle> + </index> + <license> + <highlightJs>false</highlightJs> + </license> + <release> + <toc>sidebar</toc> + <tocTopMax>4</tocTopMax> + <breadcrumbs>false</breadcrumbs> + </release> + <download> + <toc>top</toc> + <tocTopMax>4</tocTopMax> + </download> + <dependencies> + <toc>top</toc> + <tocTopMax>5</tocTopMax> + </dependencies> + <contribute> + <highlightJs>false</highlightJs> + </contribute> + <wiki-home> + <breadcrumbs> + <item name="TeeTime" href="/" /> + <item name="Wiki" href="wiki/home.html" /> + </breadcrumbs> + <toc>sidebar</toc> + <tocTopMax>4</tocTopMax> + </wiki-home> + </pages> + </reflowSkin> + </custom> +</project> diff --git a/target/site/images/code_screenshot.jpg b/target/site/images/code_screenshot.jpg new file mode 100644 index 0000000000000000000000000000000000000000..22faa31f8dd4b3d533321c83e8ac72a5a2a57b5a Binary files /dev/null and b/target/site/images/code_screenshot.jpg differ