[SSHD-871] Split README file into several subject-oriented files

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.2.0
• Fix Version/s: 2.3.0
• Labels: documentation wiki
• Flags: Important
• Assignee: Lyor Goldstein
• Reporter: Lyor Goldstein
• Created: 22/Nov/18 05:32
• Updated: 08/Jun/20 13:35
• Resolved: 10/Feb/19 12:03

Description

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:

Use the Github Wiki repository 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), 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.

Try using relative URL links in the markdown code

We need to see if links such as:

[This is a link to an SSHD subject](./wiki/TheSubject.md)

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.

Issue Links

• is related to: SSHD-872 Split CHANGES file into per-version file(s)