Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation of odmf #16

Open
8 of 10 tasks
philippkraft opened this issue Jun 13, 2018 · 1 comment
Open
8 of 10 tasks

Documentation of odmf #16

philippkraft opened this issue Jun 13, 2018 · 1 comment
Assignees
@cpwnd @philippkraft
Labels
documentation
Milestone
v1.0

Comments

@philippkraft
Copy link
Member

philippkraft commented Jun 13, 2018 •
edited by cpwnd
Loading

As .md in /docs

@cpwnd:

  • Documentation structure / TOC
  • Which part of odmf does what? On source dir level, and functionality (webserver, database, automated import)
  • conf.py
  • WOF link
    • How does it work
    • Implementation
    • Configuration

Björn

  • How to customize odmf

As .wiki in /datafiles/wiki

(will be moved to own issue later)
@cpwnd

  • What can be done with .conf - files

@thouska

  • find someone who writes more odmf usage tips
@cpwnd cpwnd added this to the v1.0 milestone Jun 21, 2018
@cpwnd
Copy link
Collaborator

cpwnd commented Jun 22, 2018

TOC:

  1. About

    • What is the purpose of ODMF

  2. Installation

    • ODMF-Server
    • CUAHSI-WOF Interface

  3. Usage

    • UI
    • Administrative

  4. Development

    • Source Code
    • Database schemas

cpwnd added a commit that referenced this issue Dec 27, 2018
@cpwnd
Moves docs and adds sphinx sources #16
0d89d2c
cpwnd added a commit to cpwnd/odmf that referenced this issue Dec 29, 2018
@cpwnd
Adds diagrams jlu-ilr-hydro#16
5e57091
cpwnd added a commit that referenced this issue Jan 1, 2019
@cpwnd
Updates documentation #16 (#27)
c162bb1 
* Updates general code description

* Adds wateroneflow chapter

* Adds diagrams

* Adds wiki 

* Adds conf.py keywords and readme update

* Adds conf file attributes and code documentation

Issue #16
cpwnd added a commit to cpwnd/odmf that referenced this issue Mar 12, 2019
@cpwnd
Finalizes jlu-ilr-hydro#16
6cdede5
cpwnd added a commit that referenced this issue Mar 12, 2019
@cpwnd
Feaure 16 docs (#29)
6c7119b 
* Updates schema mapping and wof implementation

* latest

* latest

* Updates intro

* Adds old files

* Adds old files

* Finalizes #16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cpwnd cpwnd

@philippkraft philippkraft

Labels
documentation
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
2 participants
@cpwnd @philippkraft