[grizzly~git:c63ed5c7] [2.3.x] Add simple documentation reference page.

  • From: rlubke@...
  • To: commits@...
  • Subject: [grizzly~git:c63ed5c7] [2.3.x] Add simple documentation reference page.
  • Date: Fri, 26 Apr 2013 22:29:35 +0000

Project:    grizzly
Repository: git
Revision:   c63ed5c732783e67030754d1b03da2e87cf977de
Author:     rlubke
Date:       2013-04-26 22:26:15 UTC
Link:       

Log Message:
------------
[2.3.x] Add simple documentation reference page.



Revisions:
----------
c63ed5c732783e67030754d1b03da2e87cf977de


Modified Paths:
---------------
site/src/site/markdown/contribute.md
site/src/site/markdown/index.md
site/src/site/site.xml


Added Paths:
------------
site/src/site/markdown/documentation.md
site/src/site/resources/images/docs.png


Diffs:
------
--- a/site/src/site/markdown/contribute.md
+++ b/site/src/site/markdown/contribute.md
@@ -2,7 +2,7 @@
 
 ---
 
-## !["bug"][bug] Report Issues
+## ![bug][bug] Report Issues
 
 Issue reporting is central to OSS projects.  If the issue isn't reported,
 we can't fix it.  Please report any bugs, feature, and/or improvment 
requests on the
@@ -11,14 +11,14 @@ we can't fix it.  Please report any bugs, feature, and/or 
improvment requests on
 [grizzly-jira]: https://java.net/jira/browse/GRIZZLY
 [bug]: images/bug.png
 
-## !["git"][git] Submit Patches
+## ![git][git] Submit Patches
 
 Have a fix or a feature you\'d like to share?  Open an issue and attach your
 patch with details on what you\'re resolving and how you\'re resolving it.
 
 [git]: images/git.png
 
-## !["pen"][pen] Documentation
+## ![pen][pen] Documentation
 
 Good documentation is an important aspect of any software project.  We\'ve
 taken several strides in improving our documentation, but there\'s always 
room
@@ -27,21 +27,21 @@ let us [know][grizzly-jira] or submit a patch.
 
 [pen]: images/pen.png
 
-## !["blog"][blog] Write a Blog
+## ![blog][blog] Write a Blog
 
 Are you using Grizzly?  We\'d love to hear how you\'re using it in your 
projects.
 Write a blog and drop us a note.
 
 [blog]: images/blog.png
 
-## !["reviews"][search] Code Review
+## ![reviews][search] Code Review
 
 More eyes on the code means better quality.  Review our code for style 
issues,
 potential issues, or glaring bugs.  Anything helps!
 
 [search]: images/search.png
 
-## !["support"][support] Support the Community
+## ![support][support] Support the Community
 
 Have insight on an issue another is having?  Speak up!  Join our mailing
 lists or follow questions tagged with `grizzly` on 
[StackOverflow][stack].--- /dev/null
+++ b/site/src/site/markdown/documentation.md
@@ -0,0 +1,45 @@
+## Project Grizzly Documentation
+
+## Core Framework
+
+* [Memory Management][mm]
+* [I/O Strategies][io]
+* [Transports and Connections][tac]
+* [FilterChain and Filters][faf]
+* [Core Configuration][cc]
+* [Port Unification][pu]
+* [Monitoring][mon]
+* [Best Practices][bp]
+* [Quick Start][qs]
+* [Samples][cs]
+
+[mm]: memory.html
+[io]: iostrategies.html
+[tac]: transportsconnections.html
+[faf]: filterchainfilters.html
+[cc]: coreconfig.html
+[pu]: portunification.html
+[mon]: monitoring.html
+[bp]: bestpractices.html
+[qs]: quickstart.html
+[cs]: samples.html
+
+## HTTP Components
+
+* [Core HTTP Framework][http]
+* [HTTP Server Framework][https]
+* [HTTP Server Framework Extras][httpse]
+* [Comet][c]
+* [JAXWS][jax]
+* [WebSockets][ws]
+* [AJP][ajp]
+* [SPDY][spdy]
+
+[http]: httpframework.html
+[https]: httpserverframework.html
+[httpse]: httpserverframeworkextras.html
+[c]: comet.html
+[jax]: jaxws.html
+[ws]: websockets.html
+[ajp]: ajp.html
+[spdy]: spdy.html
\ No newline at end of file--- a/site/src/site/markdown/index.md
+++ b/site/src/site/markdown/index.md
@@ -1,19 +1,26 @@
-## !["Get Started"][started] Get Started
+## ![Get Started][started] Get Started
 
-[Learn][learn] what it takes to get started using Grizzly for your projects.
+[Learn][quick] what it takes to get started using Grizzly in your projects.
 
-## !["Download"][download] Download
+## ![Documentation][docs] Documentation
+
+[Read][full] Grizzly\'s complete documentation online.
+
+## ![Download][download] Download
 
 Grizzly offers several modules that may be of interest for your projects.
 See our list of [dependencies][deps] for details.
 
-## !["Contribute"][contribute] Contribute
+## ![Contribute][contribute] Contribute
 
 Learn how you can [contribute][contpage] to the project.
 
 [contpage]: contribute.html
-[learn]: documentation/quickstart.html
-[deps]: documentation/dependencies.html
+[quick]: quickstart.html
+[deps]: dependencies.html
+[full]: documentation.html
+
 [started]: images/compass.png
 [download]: images/download.png
-[contribute]: images/settings.png
\ No newline at end of file
+[contribute]: images/settings.png
+[docs]: images/docs.pngBinary files /dev/null and 
b/site/src/site/resources/images/docs.png differ--- a/site/src/site/site.xml
+++ b/site/src/site/site.xml
@@ -32,7 +32,7 @@
                 <name>
                     <![CDATA[Project <span 
class="color-brown">Grizzly</span>]]>
                 </name>
-                <href>./</href>
+                <href>index.html</href>
             </brand>
 
             <!-- Slogan appears under the Grizzly Head logo -->
@@ -68,7 +68,7 @@
                 <!-- index.html -->
                 <index project="site">
                     <sections>
-                        <columns>3</columns>
+                        <columns>2</columns>
                     </sections>
                     <toc>false</toc>
                     <titleTemplate>Project Grizzly</titleTemplate>
@@ -103,13 +103,18 @@
                     </sections>
                     <toc>false</toc>
                 </mailing>
+
+                <!-- documentation.html -->
+                <documentation>
+                    <toc>false</toc>
+                </documentation>
             </pages>
         </reflowSkin>
     </custom>
 
     <body>
         <menu name="Main">
-            <item name="Home" href="https://grizzly.java.net"/>
+            <item name="Home" href="index.html"/>
             <item name="License" href="license.html"/>
         </menu>
         <menu name="Download">





[grizzly~git:c63ed5c7] [2.3.x] Add simple documentation reference page.

rlubke 04/26/2013
Terms of Use; Privacy Policy; Copyright ©2013-2017 (revision 20160708.bf2ac18)
 
 
Close
loading
Please Confirm
Close