Bug 31269 - Developer Documentation for UMC
Developer Documentation for UMC
Status: NEW
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 normal (vote)
: ---
Assigned To: Docu maintainers
:
: 23198 26275 (view as bug list)
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-05-02 14:04 CEST by Philipp Hahn
Modified: 2018-01-12 11:56 CET (History)
5 users (show)

See Also:
What kind of report is it?: Development Internal
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:
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 Philipp Hahn univentionstaff 2013-05-02 14:04:20 CEST
Show how to use branches/ucs-3.1/ucs-3.1-2/management/univention-management-console/umc-module-templates/

How to add "flavour" for new UDM modules.
- i18n
- disable modules

Check if branches/ucs-3.1/ucs-3.1-2/packaging/univention-directory-manager-module-example/ is releavtn and/or integrate with UDM/LDAP chapter

http://wiki.univention.de/index.php?title=UCS_3.0_UMC_API_for_Modules
http://wiki.univention.de/index.php?title=UCS_3.0_UMC_Architecture_and_Protocol

see doku-3.1/developer-reference/umc.xml for a start
Comment 1 Philipp Hahn univentionstaff 2013-05-03 11:38:11 CEST
Also see Bug #26275
Comment 2 Stefan Gohmann univentionstaff 2013-06-06 09:13:10 CEST
*** Bug 23198 has been marked as a duplicate of this bug. ***
Comment 3 Stefan Gohmann univentionstaff 2014-06-11 07:25:38 CEST
*** Bug 26275 has been marked as a duplicate of this bug. ***
Comment 4 Florian Best univentionstaff 2014-06-13 11:12:51 CEST
I am suggesting the following structure:

1. Architecture (short)
* UMC-Server
** UMCP
* UMC-Webserver
* UMC-Moduleprocesses

2. Creating UMC modules
* Generating module skeleton structure
* Overview of files
** XML module/flavor definition
** XML category definition
* Module icons
* 2.1 …
* 2.2 …
* Translating Modules
* Configuring permissions
* Debugging, Logging

2.1 Writing the Python-Module
* API-doc(s)
* useful utilities:
** decorators
** sanitizers
** progress-bars
** logging
** exceptions
** UCR
* example

2.2 Writing the Javascript Module (GUI)
* API-doc(s)
* Dojo
* useful utilities:
** UMC store, grid, […]
* example

3. Extending existing modules
* Disable modules / flavors
* UDM…

4. Creating the debian package

What do you think about this, Alex? Anything missing? Anything too detailed?
Comment 5 Alexander Kläser univentionstaff 2014-06-19 11:54:20 CEST
(In reply to Florian Best from comment #4)
> ...
> What do you think about this, Alex? Anything missing? Anything too detailed?

Your structure seems very complete and also quite a bit of work. I am not sure whether this is what we want with this bug.

As a first step, I would suggest to merge the Wiki pages + the existing UMC part in the developer documentation. Then, add information about i18n, disabling modules, flavours, how to generate UMC modules from templates. Then let us recap what is missing.
Comment 6 Stefan Gohmann univentionstaff 2015-01-23 10:28:51 CET
As discussed, we will move it to a later point.
Comment 7 Philipp Hahn univentionstaff 2016-08-18 09:08:47 CEST
r71700 | Bug #31269 devdoc: Include UMC Wiki documentation
r71699 | Bug #31269 devdoc: Move UMC documentation
 WIP to convert the deleted Wiki pages to DocBook.
 Some informations (.umc-module) are now duplicated.
 Feel free to improve.
Comment 8 Florian Best univentionstaff 2016-08-18 13:24:53 CEST
r71715 | Bug #31269: fix syntax error in XML
r71714 | Bug #31269: add a more modern example of python code
r71713 | Bug #31269: remove information about wrong categories
r71712 | Bug #31269: remove obsolete information about XML syntax validation
Comment 9 Stefan Gohmann univentionstaff 2018-01-11 20:27:59 CET
The documentation about UMC is already online and part of our official UCS 4.2 documentation. Did anyone check it?
Comment 10 Florian Best univentionstaff 2018-01-12 11:56:51 CET
We should remove chapter 7.3 and 7.4.