|
|
| Line 8: |
Line 8: |
| | For the users HowTos are provided on the platform itself (including an update of the data sharing techniques explained [[Data|here]]). The user, who wants to change or create tables in the [[Database|database]], is especially interested in the style guidelines of the database and the test requirements. In order to be able to trace the origin for the sake of transparency the user must easily find and understand, how to comment and reference a table and table entries correctly. | | For the users HowTos are provided on the platform itself (including an update of the data sharing techniques explained [[Data|here]]). The user, who wants to change or create tables in the [[Database|database]], is especially interested in the style guidelines of the database and the test requirements. In order to be able to trace the origin for the sake of transparency the user must easily find and understand, how to comment and reference a table and table entries correctly. |
| | | | |
| − | Additionally, the user will one day find tutorials in terms of videos or picture stories (like e.g. [[Special:UploadWizard|this one]]) explaining activities such as file uploads into a (media) wiki, the search function, the database importer (GUI) and the bug report. | + | Additionally, the user will one day find tutorials in terms of videos or user stories or picture stories (like e.g. [[Special:UploadWizard|this one]]) explaining activities such as file uploads into a (media) wiki, the search function, the database importer (GUI) and the bug report. |
| | | | |
| | <u>'''Implementation:'''</u> | | <u>'''Implementation:'''</u> |
| | | | |
| | The (developer) documentation is written as restructured text (reSt) and will be displayed on GitHub and Read the Docs. The HowTos and the tutorials will be provided on the website itself, using Django. | | The (developer) documentation is written as restructured text (reSt) and will be displayed on GitHub and Read the Docs. The HowTos and the tutorials will be provided on the website itself, using Django. |
Latest revision as of 13:33, 21 April 2016
(http://platform.openmod-initiative.org/documentation)
In this section the user has access to the documentation of the platform, that includes the user documentation and the developer documentation. The latter consists of texts including tables and figures and will be available on GitHub and Read the Docs.
A user can report bugs and can contribute to the source code development of the platform on GitHub (Django and CKAN). Users that forked and changed the code of the online presence can make a pull request and their code will be tested by the means of pylint, before it might be merged with the branch in the OpenEnergy platform repository and become part of a new release.
For the users HowTos are provided on the platform itself (including an update of the data sharing techniques explained here). The user, who wants to change or create tables in the database, is especially interested in the style guidelines of the database and the test requirements. In order to be able to trace the origin for the sake of transparency the user must easily find and understand, how to comment and reference a table and table entries correctly.
Additionally, the user will one day find tutorials in terms of videos or user stories or picture stories (like e.g. this one) explaining activities such as file uploads into a (media) wiki, the search function, the database importer (GUI) and the bug report.
Implementation:
The (developer) documentation is written as restructured text (reSt) and will be displayed on GitHub and Read the Docs. The HowTos and the tutorials will be provided on the website itself, using Django.
