search

fli-iam / shanoir-ng

Shanoir (SHAring iN vivO Imaging Resources)
GNU General Public License v3.0
21 stars 21 forks source link

Documentation overview #2454

Open alexpron opened 5 days ago

alexpron commented 5 days ago

This issue aims at providing an overview of the available documentation(s) and their content.

alexpron commented 5 days ago

List of available sources of documentation

  1. Github repository (https://github.com/fli-iam/shanoir-ng)
  2. Shanoir website (https://project.inria.fr/shanoir/)
  3. Github Wiki (https://github.com/fli-iam/shanoir-ng/wiki)
  4. Shanoir REST API (see links in the Github README)
  5. Shanoir beginner tutorial in french (google doc)
  6. Shanoir Youtube Channel (http://www.youtube.com/@shanoir-sharingneuroimagin1969)

[!NOTE] Introduction of the wiki explicitly mention that the github wiki is THE main source /entry point of documentation regarding Shanoir and that wiki contains link towards the other sources when accurate.

[!NOTE] Shanoir instances list sources of documentation (i.e. github wiki, github, beginer tutorial and rest api) in a resources tab

alexpron commented 3 days ago

1. Github Repository

1.1. /docs

Topics Status Public Documents formats
Anonymization
Shanoir Architecture
Microservices
Shanoir Imports
Shanoir Uploader		 Deprecated
(last modification except a Shanoir Uploader GUI picture is 2020)		 Users
Developpers		 .docx, .xlsx, .json, .png

1.2 README

Topics Status Public Documents formats
Shanoir Architecture
REST-API
Installation (Configure, Build, Deploy)		 Conflicts with wiki on installation instructions ? Developpers
Maintainers		 .md

[!WARNING] README states that Github repository is targeting Shanoir developpers and redirect users to the Shanoir project website There is no mention of the Github wiki that is the main documentation entry point

alexpron commented 3 days ago

2. Shanoir Website

Shanoir project website served by Wordpress with independant content (website not built from github repository) Topics Status Public Documents formats
General Presentation
Shanoir Consortium
Dev Roadmap
News about features
Technical keywords		 Up to date People Interested in Shanoir Wordpress website

[!WARNING] The Shanoir project website does not contain any user information strictly speaking

alexpron commented 3 days ago

3. Shanoir Github Wiki

Shanoir Github Wiki (https://github.com/fli-iam/shanoir-ng/wiki) is described as the main and most up to date source of documentation available about Shanoir.