update documentation - Githubissues

openego / data_processing

(geo)data processing, database setup, data validation

GNU Affero General Public License v3.0

7 stars 5 forks source link

update documentation #92

Open wolfbunke opened 7 years ago

wolfbunke commented 7 years ago

The data processing and the sum of all used tables in the database is quite huge. The question is how the finale public documentation of our ego data processing and results tables should look like?

should we use readthedocs with rst files in order to get all documentation together (bpmn, Metadata on table, methods description, other table and data relations ?)
or is an update of the documentation as metadata plus bpmn enough?

lukasol commented 7 years ago

Can you elaborate on the aims for this issue and assign a milestone?

IlkaCu commented 7 years ago

@wolfbunke: Could you please specify what you aim at by introducing this issue?

wolfbunke commented 7 years ago

I meant a general documentation update on bpmn, Readme, etc. as description of all methods. I will remove the Milestone.

Ludee commented 6 years ago

New header style for readthedocs documentation: https://github.com/openego/data_processing/wiki/Header-and-License

Ludee commented 6 years ago

Did we decide on a license for the documentation yet? The RTD version says:

© Copyright 2015-2017, open_eGo-Team. Revision 1db70b3d.

I suggest CC BY 4.0 because it is well known and we take the copyright statement:

It is a collaborative work with several copyright owners. Please cite as: "eGo DataProcessing Documentation © Flensburg University of Applied Sciences, Centre for Sustainable Energy Systems © Europa-Universität Flensburg, Centre for Sustainable Energy Systems © Reiner Lemoine Institut © DLR Institute for Networked Energy Systems"