You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2012/11/21 16:37:50 UTC
svn commit: r1412152 - in /mina/site/trunk/content/mina-project: ./
resources/ userguide/
Author: elecharny
Date: Wed Nov 21 15:37:44 2012
New Revision: 1412152
URL: http://svn.apache.org/viewvc?rev=1412152&view=rev
Log:
Added the documentation page, and some associated resources
Added:
mina/site/trunk/content/mina-project/documentation.mdtext
mina/site/trunk/content/mina-project/resources/
mina/site/trunk/content/mina-project/resources/ACAsia2006.pdf (with props)
mina/site/trunk/content/mina-project/resources/ACEU2006.pdf (with props)
mina/site/trunk/content/mina-project/resources/ACEU2007.pdf
mina/site/trunk/content/mina-project/resources/ACUS2005.pdf (with props)
mina/site/trunk/content/mina-project/resources/ACUS2005.swf (with props)
mina/site/trunk/content/mina-project/resources/ACUS2007.pdf (with props)
mina/site/trunk/content/mina-project/resources/JavaOne2008.pdf (with props)
mina/site/trunk/content/mina-project/resources/Mina_in_real_life_ASEU-2009.pdf
Modified:
mina/site/trunk/content/mina-project/performances.mdtext
mina/site/trunk/content/mina-project/userguide/user-guide-toc.mdtext
Added: mina/site/trunk/content/mina-project/documentation.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/documentation.mdtext?rev=1412152&view=auto
==============================================================================
--- mina/site/trunk/content/mina-project/documentation.mdtext (added)
+++ mina/site/trunk/content/mina-project/documentation.mdtext Wed Nov 21 15:37:44 2012
@@ -0,0 +1,92 @@
+Title: Documentation
+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.
+
+<H1>Documentation</H1>
+
+<DIV class="note" markdown="1">
+The MINA 2.0 User Guide can be found here : [User Guide](userguide/user-guide-toc.html)
+</DIV>
+
+[TOC]
+
+## Presentation Materials
+
+These presentation materials will help you understand the overall architecture and core constructs of MINA
+
+* [MINA in real life (ApacheCon EU 2009)](resources/Mina_in_real_life_ASEU-2009.pdf) by Emmanuel Lécharny
+* [Rapid Network Application Development with Apache MINA (JavaOne 2008)](resources/JavaOne2008.pdf) by Trustin Lee
+* [Apache MINA - The High Performance Protocol Construction Toolkit (ApacheCon US 2007)](resources/ACUS2007.pdf) by Peter Royal
+* [Introduction to MINA (ApacheCon Asia 2006)](^ACAsia2006.pdf) by Trustin Lee
+
+## Versions & References
+
+There are currently two branches in MINA:
+
+|JavaDoc|Source Code|Description|
+|---|---|---|
+| [2.0](http://http://mina.apache.org/mina-project/javadocs/index.html]|[main|http://mina.apache.org/report/1.0/xref/], [test|http://mina.apache.org/report/1.0/xref-test/]|The officially recommended production-ready branch|
+| [3.0](http://mina.apache.org/report/trunk/apidocs/]*|[main|http://mina.apache.org/report/trunk/xref/], [test|http://mina.apache.org/report/trunk/xref-test/]|The version we are currently working on|
+
+You might also want to read the [frequently asked questions](faq.html] and learn how to [contact us](../contact.html) before getting started.
+
+## Tutorials
+
+
+* [MINA v2.0 Quick Start Guide] \- Create your first MINA based program using MINA version 2.0
+* [Application Architecture|MINA based Application Architecture] \- Describes Architecture of MINA based Applications
+* [Logging Configuration] \- Configuring your MINA-based application for logging
+* Transport-specific Configuration
+ * [Serial Tutorial] \- Serial communications with MINA trunk
+ * [UDP Tutorial] \- Writing a User Datagram Protocol (UDP) client and server using MINA
+ * [APR Transport] \- Describes use of APR Transport with MINA
+* [Integrating with Spring] \- Demonstrates how to integrate MINA application with Spring
+* [Codec Repository|MINA:Codec Repository] - Links to available codec implementations for MINA
+* Advanced Topic
+ * [Writing IoFilter|IoFilter] \- Writing your own {{IoFilter}} implementation to deal with cross-cutting concerns
+ * [Writing Protocol Codec for MINA 2.x|Tutorial on ProtocolCodecFilter (for Mina 2.x)] \- Implementing a protocol codec for separation of concern
+ * [Using an Executor Filter] \- Controlling the size of thread pool and choosing the right thread model
+ * [JMX Integration] \- Making your network application manageable
+ * [Introduction to mina-statemachine] \- Implementing state machine based MINA applications using Java5 annotations
+ * [ErrorGeneratingFilter Tutorial] \- Simulating network error by adding a ErrorGeneratingFiler.
+ * [Handling Packet Fragmentation|Handling Packet Fragementation] \- Describes Packet fragmentation and its handling in MINA application
+* [User Guide](userguide/user-guide-toc.html] - The new draft MINA User Guide.
+
+### For Developers
+
+* [Developer Guide](developper-guide.html) \- Building & deploying MINA, Coding Standard, and more
+
+## Examples
+
+You can browse all examples [here](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/).
+| Name | Feature it demonstrates | Side |
+|---|---|---|
+| [Reverser](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/reverser/) | Text protocol based on a protocol codec | Server |
+| [SumUp server](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/sumup/) | Complex binary protocol based on a protocol codec | Both |
+| [Echo server](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/echoserver/) | Low-level I/O and SSL | Server |
+| [NetCat](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/netcat/) | Client programming | Client |
+| [HTTP server](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/httpserver/) | Stream-based synchronous I/O | Server |
+| [Tennis](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/tennis/) | In-VM pipe communication | Both |
+| [Chat server](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/chat/) | Spring integration | Both |
+| [Proxy](http://mina.apache.org/report/trunk/xref/org/apache/mina/example/proxy/) | Resending received bytes on another session. | Both |
+
+## Older Presentation Materials
+
+* [Building TCP/IP Servers with Apache MINA (ApacheCon EU 2007)](resources/ACEU2007.pdf] by Peter Royal
+* [Building TCP/IP Servers with Apache MINA (ApacheCon EU 2006)](resources/ACEU2006.pdf] by Peter Royal
+* [Introduction to MINA (ApacheCon US 2005)](resources/ACUS2005.pdf] by Trustin Lee ([Demo movie](resources/ACUS2005.swf))
+
Modified: mina/site/trunk/content/mina-project/performances.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/performances.mdtext?rev=1412152&r1=1412151&r2=1412152&view=diff
==============================================================================
--- mina/site/trunk/content/mina-project/performances.mdtext (original)
+++ mina/site/trunk/content/mina-project/performances.mdtext Wed Nov 21 15:37:44 2012
@@ -26,7 +26,7 @@ The following performance test results m
## Apache MINA 2.0.0-M1-SNAPSHOT + AsyncWeb 0.9.0-SNAPSHOT
-[Trustin Lee](http://gleamynode.net/) ran a HTTP performance test with the latest snapshot of Apache MINA and [AsyncWeb](http://asyncweb.safehaus.org/) combo, using [the AsyncWeb lightweight HTTP server example](https://svn.safehaus.org/repos/asyncweb/trunk/example/src/main/java/org/safehaus/asyncweb/example/lightweight/).
+[Trustin Lee](http://gleamynode.net/) ran a HTTP performance test with the latest snapshot of Apache MINA and [AsyncWeb](https://svn.apache.org/repos/asf/mina/asyncweb/trunk/) combo, using [the AsyncWeb lightweight HTTP server example](https://svn.apache.org/repos/asf/mina/asyncweb/trunk/examples/src/main/java/org/apache/asyncweb/examples/lightweight/).
* Protocol
* HTTP
Added: mina/site/trunk/content/mina-project/resources/ACAsia2006.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACAsia2006.pdf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/ACAsia2006.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/ACEU2006.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACEU2006.pdf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/ACEU2006.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/ACEU2007.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACEU2007.pdf?rev=1412152&view=auto
==============================================================================
Files mina/site/trunk/content/mina-project/resources/ACEU2007.pdf (added) and mina/site/trunk/content/mina-project/resources/ACEU2007.pdf Wed Nov 21 15:37:44 2012 differ
Added: mina/site/trunk/content/mina-project/resources/ACUS2005.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACUS2005.pdf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/ACUS2005.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/ACUS2005.swf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACUS2005.swf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/ACUS2005.swf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/ACUS2007.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/ACUS2007.pdf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/ACUS2007.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/JavaOne2008.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/JavaOne2008.pdf?rev=1412152&view=auto
==============================================================================
Binary file - no diff available.
Propchange: mina/site/trunk/content/mina-project/resources/JavaOne2008.pdf
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: mina/site/trunk/content/mina-project/resources/Mina_in_real_life_ASEU-2009.pdf
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/resources/Mina_in_real_life_ASEU-2009.pdf?rev=1412152&view=auto
==============================================================================
--- mina/site/trunk/content/mina-project/resources/Mina_in_real_life_ASEU-2009.pdf (added)
+++ mina/site/trunk/content/mina-project/resources/Mina_in_real_life_ASEU-2009.pdf Wed Nov 21 15:37:44 2012
@@ -0,0 +1,9 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<html><head>
+<title>404 Not Found</title>
+</head><body>
+<h1>Not Found</h1>
+<p>The requested URL /conferences.data/Mina_in_real_life_ASEU-2009.pdf was not found on this server.</p>
+<hr>
+<address>Apache/2.4.1 (Unix) OpenSSL/1.0.0g Server at mina.apache.org Port 80</address>
+</body></html>
Modified: mina/site/trunk/content/mina-project/userguide/user-guide-toc.mdtext
URL: http://svn.apache.org/viewvc/mina/site/trunk/content/mina-project/userguide/user-guide-toc.mdtext?rev=1412152&r1=1412151&r2=1412152&view=diff
==============================================================================
--- mina/site/trunk/content/mina-project/userguide/user-guide-toc.mdtext (original)
+++ mina/site/trunk/content/mina-project/userguide/user-guide-toc.mdtext Wed Nov 21 15:37:44 2012
@@ -42,4 +42,4 @@ Part III - MINA Advanced
* [Chapter 14 - State Machine](ch14-state-machine/ch14-state-machine.html)
* [Chapter 15 - Proxy](ch15-proxy/ch15-proxy.html)
* [Chapter 16 - JMX Integration](ch16-jmx-support/ch16-jmx-support.html)
-* [Chapter 17 - Spring Integration](ch17-integration/ch17-spring-integration.html)
+* [Chapter 17 - Spring Integration](ch17-spring-integration/ch17-spring-integration.html)