[jira] [Created] (SSHD-871) Split README file into several subject-oriented files

["Goldstein Lyor (JIRA)" <ji...@apache.org>]

Goldstein Lyor created SSHD-871:
-----------------------------------

             Summary: Split README file into several subject-oriented files
                 Key: SSHD-871
                 URL: https://issues.apache.org/jira/browse/SSHD-871
             Project: MINA SSHD
          Issue Type: Improvement
    Affects Versions: 2.1.1
            Reporter: Goldstein Lyor


The current file is a single "monolithic" text covering many subjects. As it becomes more detailed, we need to split it into several files with a {{Table of contents}} that contains links to each subject. There are several options:

h5. Use the [Github Wiki repository|https://gist.github.com/subfuzion/0d3f19c4f780a7d75ba2] capability

The problem with this capability is that the WIKI pages require a *separate* repository, whereas we would like to have all of the contained in this project (e.g., under the _wiki_ folder). We could have a partial solution by using perhaps [git subtree(s)|https://www.atlassian.com/blog/git/alternatives-to-git-submodule-git-subtree], but it would still require 2 repositories.

Another problem with this solution is that it is tightly coupled with _github_ and thus migrating to another GIT host (e.g., _Bitbucket_) would be much more difficult.

h5. Try using relative URL links in the markdown code

We need to see if links such as:
{code}
[This is a link to an SSHD subject](./wiki/TheSubject.md)
{code}
would work. If so, then we could consider adding a {{src/main/wiki}} folder to each subproject to host wiki pages related to the specific module.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)