MINA User Guide 2.0

[Tom Hunter <cu...@gmail.com>]

Folks,
   First of all, thank you for all your hard work on MINA. It is
appreciated.

   While learning this new technology, a new User Guide 2.0 appeared here:
http://mina.apache.org/mina-project/userguide/user-guide-toc.html

    I am glad that someone has been willing to do some documentation.
However, the currently released version is a mess, in terms of typos and
grammar. I would be happy to correct those if someone there could show me
how to make those changes. But as it stands, the current User Guide 2.0 is
almost unreadable because of the pervasive grammar and usage problems.

   If you want help, I am offering.

                thank you,
                              Tom

Re: MINA User Guide 2.0

[Emmanuel Lécharny <el...@gmail.com>]

Le 7/5/13 8:53 PM, Tom Hunter a écrit :
> Folks,
>    First of all, thank you for all your hard work on MINA. It is
> appreciated.
>
>    While learning this new technology, a new User Guide 2.0 appeared here:
> http://mina.apache.org/mina-project/userguide/user-guide-toc.html
>
>     I am glad that someone has been willing to do some documentation.
> However, the currently released version is a mess, in terms of typos and
> grammar. 
What could you expect from people who are mostly french ? ;-)


> I would be happy to correct those if someone there could show me
> how to make those changes. 
Sure ! In fact, it's pretty easy.

All the pages are avaiblable in subversion at this place :

http://svn.apache.org/repos/asf/mina/site/trunk/

I don't know how comfy you are with subversion, but just in case, to get
the site pages, it's just a matter of doing :

svn co http://svn.apache.org/repos/asf/mina/site/trunk/ mina-site

All the content will be stored in the mina-site directory

The structure of this directory will be :

mina-site
  cgi-bin
  content
    ...
    css
    ...
    mina-project
      ...
      userguide
    ...
    staticresources
      images
        mina
  lib
  templates


All the (rotten) meat is in mina-project/userguide


We are using a syntax called markdown. You can get some info about it on
http://daringfireball.net/projects/markdown/syntax. Be aware that it's
pretty simplistic.

When you have modified a page, you just have to run this command to get
the diff :
svn diff > blah.diff

and send us back this file (the way to do it is to create a JIRA and to
attach the changes to it).

Aok at this point, if you feel like it's too complicated, or if you need
more information, the best would be to have a quick chat on IRC (channel
#mina-dev on irc://irc.freenode.net
<irc://irc.freenode.net/apache-directory>)


>
>    If you want help, I am offering.
We buy such an help ! (well, all we cn offer at the end is yoru name
somwhere on eh wall of fame, and potentially commit access :-) Plus our
warm consideration for fixing a work we are not good at...

Many thanks for the proposal ! We accept !

-- 
Regards,
Cordialement,
Emmanuel Lécharny
www.iktek.com