Description Ole Schwiegert 2021-05-19 08:51:01 CEST

The documentation source can be found in the git repo under docs/source

This Bug is for improving the documentation with feedback from devs, support and professional service. The following feedback was already given and should be included:


QA Documentation

Create a working directory, and check out the *UCS@School API* code and the
example plugin code
-> Create a working directory and check out the *UCS@School API* code, as well as the
example plugin code

we check that the api server as such will run. 
-> in the future? Why not "runs"?

   mv ${MYPLUGIN}-plugin/echo_plugin ${MYPLUGIN}-plugin/${MYPLUGIN}_plugin
   mv ${MYPLUGIN}-plugin/${MYPLUGIN}_plugin/echo_plugin.py ${MYPLUGIN}-plugin/${MYPLUGIN}_plugin/${MYPLUGIN}_plugin.py
   mv ${MYPLUGIN}-plugin/tests/unittests/test_echo_plugin.py ${MYPLUGIN}-plugin/tests/unittests/test_${MYPLUGIN}_plugin.py

-> Do we need this to be so explicit? This is hard to read (but correct).


this where you can define models that describe what
-> this is where you can define models that describe what


In theory, if you go to http://localhost:8080/ucsschool/apis/docs, you
-> why in theory? 

All the best with writing your plugins, and don't hesitate to contact the UCS@school team if you
have questions!
-> Who is supposed to read this? If profS then this is OK. If not I'm not so sure.