Univention Bugzilla – Bug 31226
App Center documentation
Last modified: 2015-05-28 08:28:04 CEST
The App Center documentation should be part of the developer guide. The following things should be documented: - what are the app requirements - ini file format - how to test an app - Links to the different integration chapters (UCR, Join/unjoin) See also: http://wiki.univention.de/index.php?title=App_Center/en http://wiki.univention.de/index.php?title=App_Center_-_.ini_file
> The App Center documentation should be part of the developer guide. > > The following things should be documented: > > - what are the app requirements Done (briefly) > > - ini file format Included > > - how to test an app Not yet, as we are still working on that > > - Links to the different integration chapters (UCR, Join/unjoin) Done. I am missing a chapter about ucs_registerSchema > > See also: > http://wiki.univention.de/index.php?title=App_Center/en Not yet done > http://wiki.univention.de/index.php?title=App_Center_-_.ini_file Done
I am missing some words about the icon file. If of importance, maybe also that the .ini file, icon file and screenshot file reside in the same directory?
I split section 8.2 into two sections as the description of parameters and the additional files (READMEs) could not be recongnized directly. I adjusted some text in the beginning of the chapter (revision 43026).
It should be noted that the LongDescription field is in HTML → Bug 31185.
When this chapter has been published, the corresponding wiki page should also be removed as it is not up to date anymore: http://wiki.univention.de/index.php?title=App_Center_-_.ini_file
(In reply to Alexander Kläser from comment #5) > When this chapter has been published, the corresponding wiki page should > also be removed as it is not up to date anymore: > > http://wiki.univention.de/index.php?title=App_Center_-_.ini_file Please add a redirection or a link to the dev guide chapter.
(In reply to Stefan Gohmann from comment #6) > (In reply to Alexander Kläser from comment #5) > > When this chapter has been published, the corresponding wiki page should > > also be removed as it is not up to date anymore: > > > > http://wiki.univention.de/index.php?title=App_Center_-_.ini_file > > Please add a redirection or a link to the dev guide chapter. I meant don't delete the wiki page but you can remove the content and add a link to the dev guide chapter.
(In reply to Stefan Gohmann from comment #7) > (In reply to Stefan Gohmann from comment #6) > > (In reply to Alexander Kläser from comment #5) > > > When this chapter has been published, the corresponding wiki page should > > > also be removed as it is not up to date anymore: > > > > > > http://wiki.univention.de/index.php?title=App_Center_-_.ini_file > > > > Please add a redirection or a link to the dev guide chapter. > > I meant don't delete the wiki page but you can remove the content and add a > link to the dev guide chapter. I removed the content of that wiki page and redirect the user to the developer reference. Furthermore, I revised both App Center wiki articles, shortened them a lot and refer to the developer reference.
Dirk, is here anything open or can this bug be closed?
This is fine at least for 4.0-1-errata. New variables / enhanced documentation needed because of an extended App Center will go into their own bugs
OK