Univention Bugzilla – Bug 50806
SISOPI import has to be documented in *official* manual
Last modified: 2023-05-26 15:40:37 CEST
SISOPI import has to be documented in the *official* manual. Currently it is only available via https://billy/~dtroeder/http-api-doc/sisopi.html
The text from the internal documentation has been transferred to the official UMC-import manual: [4.4] cc3cb7337 Bug #50806: add sisopi documentation [4.4] 6676b088f Bug #50806: fix documentation [4.4] 94a7e1f32 Bug #50806: spelling [4.4] ec1eb2422 Bug #50806: format fixes [4.4] a7c8c86e4 Bug #50806: spelling The built manual can be found at: https://jenkins.knut.univention.de:8181/job/UCSschool-4.4/job/Handbook/47/artifact/doc/manual/ The SiSoPi documentation has been moved from the packages HTML documentation to the official UMC-import manual: [4.4] f4ea6d5ff Bug #50806: remove sisopi section from packaged documentation [4.4] ad3e39207 Bug #50806: update advisory ucs-school-import (17.0.27)
ein Benutzer kann im mehreren Schulen sein -> in mehreren I would also appreciate a section at the end where a short example of the actual usage is shown. Since the usage of the importer is already shown in other sections before this point is debatable.
Eine Datenbasis die alle Benutzer, mit je einem domänenweit eindeutigen Schlüssel (record_uid), enthält. -> Eine Datenbasis, die alle Benutzer mit (...), enthält. or (suggestion): Eine Datenbasis aller Benutzer mit einem domänenweit eindeutigen Schlüssel (record_uid). Da Importe in zufälliger Reihenfolge stattfinden können, (...) Suggestion: Split the sentence. Die Importe können in zufälliger Reihenfolge stattfinden. Es ist möglich, dass beim Verschieben eines Benutzers dieser zuerst in einer Schule gelöscht und in **einer** **Anderen** (?) später angelegt wird. zu erst -> zuerst Benutzerkonten die von ihrer letzten (...) Benutzerkonten, (...) "Zwischenschule" -> why not temporäre Schule? statt dessen -> stattdessen
Thank you for the review. I fixed the errors and added an elaborate example section. [4.4] 0de1654b7 Bug #50806: syntax fixes, wording [4.4] 9150e2cf9 Bug #50806: add detailed example [4.4] 49ba7a08c Bug #50806: improve readability, fix typos https://jenkins.knut.univention.de:8181/job/UCSschool-4.4/job/Handbook/49/artifact/doc/manual/ucsschool-umc-import-handbuch-4.4.pdf
The new example section is easy to understand. I could reproduce the steps without any problem. Please correct the remaining mistakes: Tipp: mit folgendem Befehl -> Tipp: Mit folgendem Befehl zu erst -> zuerst Es ist die Zeit -> Das ist die Zeit statt dessen -> stattdessen wird für den Test aber -> diesen Test (more clear) (Anpassen der Spalte "Schule" nicht vergessen) - > , wobei die Spalte "Schule" angepasst wird keep command format consistent with leading #: # /usr/share/ucs-school-import/scripts/create_ou schuleA Suggestion: Decrease the number of brackets, if you want to increase to the reading flow, e.g.: (...) Soll ein Benutzer während eines Imports (an Schule "B") erstellt werden, (...)
Thanks for the thorough review. [4.4] 2b0d21742 Bug #50806: syntax and style fixes https://jenkins.knut.univention.de:8181/job/UCSschool-4.4/job/Handbook/50/artifact/doc/manual/
You're welcome. ok: remaining mistakes corrected
UCS@school 4.4 v5 has been released. https://docs.software-univention.de/changelog-ucsschool-4.4v5-de.html If this error occurs again, please clone this bug.