Bug 31226 - App Center documentation
App Center documentation
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 enhancement (vote)
: UCS 4.0-1-errata
Assigned To: Dirk Wiesenthal
Stefan Gohmann
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-04-29 09:32 CEST by Stefan Gohmann
Modified: 2015-05-28 08:28 CEST (History)
3 users (show)

See Also:
What kind of report is it?: ---
What type of bug is this?: ---
Who will be affected by this bug?: ---
How will those affected feel about the bug?: ---
User Pain:
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Stefan Gohmann univentionstaff 2013-04-29 09:32:14 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
Comment 1 Dirk Wiesenthal univentionstaff 2013-05-22 22:52:22 CEST
> 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
Comment 2 Alexander Kläser univentionstaff 2013-08-06 18:54:16 CEST
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?
Comment 3 Alexander Kläser univentionstaff 2013-08-06 19:07:21 CEST
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).
Comment 4 Alexander Kläser univentionstaff 2013-08-07 10:29:21 CEST
It should be noted that the LongDescription field is in HTML → Bug 31185.
Comment 5 Alexander Kläser univentionstaff 2013-08-07 10:52:40 CEST
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
Comment 6 Stefan Gohmann univentionstaff 2013-08-07 11:04:55 CEST
(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.
Comment 7 Stefan Gohmann univentionstaff 2013-08-07 11:09:37 CEST
(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.
Comment 8 Nico Gulden univentionstaff 2013-11-27 09:56:06 CET
(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.
Comment 9 Stefan Gohmann univentionstaff 2014-08-29 06:32:41 CEST
Dirk, is here anything open or can this bug be closed?
Comment 10 Dirk Wiesenthal univentionstaff 2015-05-19 15:35:17 CEST
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
Comment 11 Stefan Gohmann univentionstaff 2015-05-19 15:38:59 CEST
OK