search

DFO-Ocean-Navigator / Ocean-Data-Map-Project

The Ocean Navigator is an online tool that is used to help visualise scientific research data. a users guide is available at https://dfo-ocean-navigator.github.io/Ocean-Navigator-Manual/ and the tool is live at
http://navigator.oceansdata.ca
GNU General Public License v3.0
50 stars 20 forks source link

Beef up technical documentation #610

Open htmlboss opened 4 years ago

htmlboss commented 4 years ago

Intro

This is primarily motivated by the fact all the technical knowledge is in my head which is obviously not going to benefit anyone when I leave in May.

What we need

We need the following documented:

nsoontie commented 4 years ago

@dwayne-hart also has some documentation about deployments.

Do we have a strategy for maintaining/sharing these types of documents? How do we make sure that everyone has the latest copy? Word documents aren't going to cut it...

Take a look at the UBC group's documentation pages: https://salishsea-meopar-docs.readthedocs.io/en/latest/ https://salishsea-meopar-tools.readthedocs.io/en/latest/index.html#salishseatoolsdocs