[38/38] git commit: Add a page describing how to help writing the documentation

[mg...@apache.org]

Updated Branches:
  refs/heads/reference-guide 4dae90dc9 -> 017e45eb5


Add a page describing how to help writing the documentation


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/017e45eb
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/017e45eb
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/017e45eb

Branch: refs/heads/reference-guide
Commit: 017e45eb52c5907e168da6ee59859c3542225e84
Parents: 1c22664
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Wed Feb 6 09:51:14 2013 +0100
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Wed Feb 6 09:51:14 2013 +0100

----------------------------------------------------------------------
 .../src/documentation/source/events.rst            |    2 +
 .../src/documentation/source/howtohelp.rst         |   60 +++++++++++++++
 .../src/documentation/source/index.rst             |    7 +--
 3 files changed, 63 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/017e45eb/wicket-reference-guide/src/documentation/source/events.rst
----------------------------------------------------------------------
diff --git a/wicket-reference-guide/src/documentation/source/events.rst b/wicket-reference-guide/src/documentation/source/events.rst
new file mode 100644
index 0000000..659d566
--- /dev/null
+++ b/wicket-reference-guide/src/documentation/source/events.rst
@@ -0,0 +1,2 @@
+Event system
+============

http://git-wip-us.apache.org/repos/asf/wicket/blob/017e45eb/wicket-reference-guide/src/documentation/source/howtohelp.rst
----------------------------------------------------------------------
diff --git a/wicket-reference-guide/src/documentation/source/howtohelp.rst b/wicket-reference-guide/src/documentation/source/howtohelp.rst
new file mode 100644
index 0000000..2fe8853
--- /dev/null
+++ b/wicket-reference-guide/src/documentation/source/howtohelp.rst
@@ -0,0 +1,60 @@
+How to contribute to this documentation
+=======================================
+
+If you want to help to improve this documentation here is how to do it:
+
+Get the sources
+---------------
+
+The sources are hosted in the same Git repository as Apache Wicket's code::
+
+    $ git clone http://git-wip-us.apache.org/repos/asf/wicket.git
+    
+At the moment they are in branch with name `reference-guide`::
+
+    $ git checkout reference-guide
+    
+Edit the sources
+----------------
+
+Maven module `wicket-reference-guide` contains few sample applications and the documentation itself::
+
+    $ cd wicket-reference-guide/
+    $ ls
+       helloworld/
+       src/documentation/
+       stateless/
+
+The documentation is build with Sphinx documentation tool (http://sphinx-doc.org/). It uses `reStructured Text` as markup. 
+More about the syntax can be found at `Quick Ref <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ and `Full documentation <http://docutils.sourceforge.net/rst.html>`_.
+
+Improve the documentation in `src/documentation/source/*.rst` files and send us the patch when ready::
+
+    $ git diff > updated-documentation.patch
+
+
+Check the changes
+-----------------
+
+This step is optional. Do it only if you want to see how your changes will look like.
+
+1. Install `Python <http://www.python.org/>`_. This will provide `easy_install` command.
+2. Install `Sphinx <http://sphinx-doc.org/>`_::
+
+    $ easy_install -U Sphinx
+
+3. Build the documentation::
+
+    $ cd wicket-reference-guide/src/documentation/
+    $ make html
+
+4. See your changes in a browser::
+
+    $ google-chrome build/html/index.html
+
+
+Follow the documentation process
+--------------------------------
+
+To follow how this documentation evolves you can subcribe with your feed reader to https://github.com/apache/wicket/commits/reference-guide.atom
+

http://git-wip-us.apache.org/repos/asf/wicket/blob/017e45eb/wicket-reference-guide/src/documentation/source/index.rst
----------------------------------------------------------------------
diff --git a/wicket-reference-guide/src/documentation/source/index.rst b/wicket-reference-guide/src/documentation/source/index.rst
index c91de7e..20a04af 100644
--- a/wicket-reference-guide/src/documentation/source/index.rst
+++ b/wicket-reference-guide/src/documentation/source/index.rst
@@ -1,8 +1,3 @@
-.. Apache Wicket documentation master file, created by
-   sphinx-quickstart on Tue Jan 22 14:43:46 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to Apache Wicket's documentation!
 =========================================
 
@@ -22,7 +17,7 @@ Contents:
    ioc
    websockets
    velocity
-   
+   howtohelp
 
 .. Indices and tables
 .. ==================