Bug 29398 - UCS Developer Manual
UCS Developer Manual
Status: CLOSED FIXED
Product: UCS extended documentation
Classification: Unclassified
Component: Developer documentation
unspecified
Other Linux
: P5 enhancement (vote)
: UCS 3.1
Assigned To: Philipp Hahn
Arvid Requate
: interim-5
: 20741 22102 24142 24775 (view as bug list)
Depends on: 20206 29420
Blocks: 31511
  Show dependency treegraph
 
Reported: 2012-11-26 16:51 CET by Stefan Gohmann
Modified: 2015-04-01 13:28 CEST (History)
4 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 2012-11-26 16:51:11 CET
We need an UCS Developer Manual as extended documentation, in the same way as the Performance Guide: http://docs.univention.de/performance-guide.html

The manual should include the following issues:

 - Differences to a Debian system

 - Create a new Debian package, based on the example packages:
   http://wiki.univention.de/index.php?title=Paketierung_von_Software_f%C3%BCr_UCS
   https://forge.univention.org/websvn/listing.php?repname=dev&path=%2Fbranches%2Fucs-3.1%2Fucs%2Fpackaging%2F&#a2683d62321b2c7c4360f6bbfc2022f9c
 
 - Using UCR

 - Create a join script using the join script lib:
   http://wiki.univention.de/index.php?title=Joinskript
   http://wiki.univention.de/index.php?title=Join-Skript-Bibliothek

 - Create a listener module

 - Using extended attributes
 
 - Using LDAP schema extensions

 - Using LDAP ACLs

 - Create UDM and UMC modules (maybe reference only to other documents)
Comment 1 Moritz Muehlenhoff univentionstaff 2012-11-28 11:44:14 CET
*** Bug 24142 has been marked as a duplicate of this bug. ***
Comment 2 Moritz Muehlenhoff univentionstaff 2012-11-29 17:29:29 CET
*** Bug 20741 has been marked as a duplicate of this bug. ***
Comment 3 Moritz Muehlenhoff univentionstaff 2012-11-29 17:36:30 CET
*** Bug 22102 has been marked as a duplicate of this bug. ***
Comment 4 Moritz Muehlenhoff univentionstaff 2012-12-04 14:00:29 CET
Die Dokumentation zu den Join-Skripten sollte die Hinweise zur Reihenfolge der Join-Skripte aus Bug 24775 beinhalten.
Comment 5 Moritz Muehlenhoff univentionstaff 2012-12-04 14:00:38 CET
*** Bug 24775 has been marked as a duplicate of this bug. ***
Comment 6 Philipp Hahn univentionstaff 2013-05-03 17:33:32 CEST
Here: <svn+ssh://billy.knut.univention.de/var/svn/doku/developer-reference>

All other things are done through individual other bugs:
Bug #21912 - Dokumentation zur Erstellung eigener Optionen für UDM-Objekte
Bug #24236 - Dokumentation zu Erstellung eigener Syntax-Definitionen
Bug #25053 - SDB-Artikel zu Hooks in Entwickler-Doku integrieren
Bug #26275 - Dokumentation zur Erstellung eines UMC-Moduls
Bug #27670 - Bibliothek für das Verwalten von AT-Jobs
Bug #29420 - Entwicklung eines Listener-Moduls
Bug #29471 - Entwickler-Doku für Integration in Univention Configuration Registry
Bug #29525 - Dokumentation zur Entwicklung eigener UDM-Module
Bug #31226 - App Center documentation
Bug #31268 - Developer documentation for unjoin scripts
Bug #31269 - Developer Documentation for UMC

Other issues identified while documenting:
Bug #18497 - invoke-rc.d verwenden
Bug #31151 - dh-umc-module-* can be used for LDAP-only modules
Bug #31252 - cn=backup,$ldap_base ?
Bug #31281 - machine secret hard-coded to 8 characters (or less)

QA:
1, please fix minor (spelling) things directly.
2. Add <remark>QA: ...</remark> directly in the files. (or your initials)
3. For big issues talk to me or write them here.

Known issues:
1. Index needs more work ...
2. The sample files will be available though Subversion in the future. Currently the doku-SVN is not mirrors to our public SVN. The details are still discussed.
3. Line breaks in verbatim environments is not optimal. Needs newer FOP.
4. Several chapters are still stubs, need more work.
Comment 8 Philipp Hahn univentionstaff 2013-05-13 20:39:10 CEST
Changes from QA were applied: svn40461
A first draft was published.
Everything else with separate bugs.