Chore: Restructure documentation

[clemens-tolboom]

Problem

It is sometimes hard to find the right document snippet.

Currently we have:

• https://molgenis.github.io/molgenis-service-armadillo/#/
  • https://github.com/molgenis/molgenis-service-armadillo/issues/492
• Project README.md
• Project component specific README.md for ui, scripts, armadillo
  • find . -name "README.*" | grep -v .gradle | grep -v "node_modules"
• some open source project have CONTRIBUTING.md use this for potential developers
• we have no LICENSE
• See also Github Communities for other potential documents

Proposal

We could make this easier by organise by target group: user, ops and developer and task to accomplish.

• Project README.md could be the entry to all other document resources.
• Developer documentation in their component directory
• /docs/ for users and ops

[erikzwart]

For the data-catalogue we have the 'target group' defined as follows: https://data-catalogue.molgeniscloud.org/apps/docs/#/catalogue/ (Researcher, Local data manager, Network data manager). We did find managing these different manual groups tricky and we try to write a general text for all (if possible).

[clemens-tolboom]

This Data Catalogue comes from EMX2 repo which surprised me containing Armadillo stuff (and more).

My idea for this issue was "Keep doc and code together" and XREF related documentation.

• Thus in this repo we have DEV, OPS and USER docs related to Armadillo only.
• The relation to EMX2 and Catalogue are just links.

[erikzwart]

So in other words you would move https://github.com/molgenis/molgenis-emx2/tree/master/docs/armadillo to https://github.com/molgenis/molgenis-service-armadillo/tree/master/docs ?

[clemens-tolboom]

Idea: move EXMS https://github.com/molgenis/molgenis-emx2/tree/master/docs/armadillo into here

[clemens-tolboom]

Checking with https://github.com/molgenis/molgenis-emx2/commits/master/docs/armadillo there are just 2 commits there so an easy move?

└── docs
    └── armadillo
         ├── README.md
         ├── _sidebar.md
         ├── data_cohort-data-manager.md
         └── data_researcher.md