Bug 51666 – documentation for active and available hooks in ../hooks and ../pyhooks-available is missing

Bug 51666 - documentation for active and available hooks in ../hooks and ../pyhooks-available is missing


Summary:	documentation for active and available hooks in ../hooks and ../pyhooks-avail...

Status:	NEW

Product:	UCS@school
Classification:	Unclassified
Component:	Documentation
Version:	UCS@school 4.4
Hardware:	Other Linux

Importance:	P5 normal (vote)
Target Milestone:	---
Assigned To:	UCS@school maintainers
QA Contact:

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2020-07-13 18:00 CEST by Dirk Ahrnke
Modified:	2023-06-23 13:41 CEST (History)
CC List:	2 users (show)

See Also:
What kind of report is it?:	Bug Report
What type of bug is this?:	2: Improvement: Would be a product improvement
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
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Dirk Ahrnke

2020-07-13 18:00:22 CEST

It appears as if the enhancement introduced with Bug 49267 is not documented. 
At least I could not find it in https://docs.software-univention.de/ucsschool-import-handbuch-4.4.html or https://docs.software-univention.de/ucsschool-kelvin-rest-api/.

Comment 1 Daniel Tröder

2020-07-14 08:53:45 CEST

All hooks that are delivered with the ucs-school-import package should be documented in the import manual ("ucsschool-import-handbuch").
The documentation should include the information whether the hooks are enabled by default or not and how to enable them.

Comment 2 Daniel Tröder

2020-07-14 08:55:35 CEST

BTW: most hooks include the documentation inside the hook file itself.
This is also the case with 'configuration hook "by_role"':
https://github.com/univention/ucs-school/blob/4.4/ucs-school-import/usr/share/ucs-school-import/pyhooks-available/ext_config_dep_on_role.py#L31