[OBM Admin] obm documentations

Bán Miklós banm at vocs.unideb.hu
Fri Dec 23 11:21:02 CET 2016


Hi all,

We have created a repository for the documentations here:

https://github.com/OpenBioMaps/documentation

There are two docs:
- Attila's tutorial about the virtualbox installation. I converted it
from doc to markdown
- Robi's user manual (it is under construction)


Currently we have three independent doc sources:
http://openbiomaps.org/obwiki - a wiki by Bán Miki
translatable wiki pages

https://github.com/OpenBioMaps/documentation - user contributed
documents (Attila Ferenc, Róbert Veres and Miki Bán)
markdown text files in Hungarian and in English

http://openbirdmaps.ro/wiki - wiki for the openbirdmaps 
Romanian documentation about OBM basic usage and about the OpenBirdMaps
project.

I would prefer, if we would have a collaborative documentation system.
The google docs is a simple solution and very easy to write
documentations and share them however for online reading is not too
simple.

The github and markdown combination is more convenient for online
readers and complicated to write and github accounts needed to join
editing them. 

I think the WIKIMEDIA is a very effective solution to write translatable
documentations especially if the documentation should be editable.
However managing our wiki sites takes some extra energy.

I'm thinking on a combination of github and markdown and an independent
static online page such like the mapserver documentary works.

http://mapserver.org/documentation.html
https://github.com/mapserver/docs

They are using the Sphinx documentation generator:
http://www.sphinx-doc.org

What is your opinion?


Best wishes, Miki

-- 
Miklós Bán, PhD
MTA-DE "Lendület" Behavioural Ecology Research Group
Department of Evolutionary Zoology, University of Debrecen
H-4010 Debrecen, Egyetem tér 1.
Phone:  +36 52 512-900 ext. 62356
http://zoology.unideb.hu/?m=Miklos_Ban
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


More information about the Administrator mailing list