Bug 45657 - [RESTful Import API] enduser manual
[RESTful Import API] enduser manual
Status: RESOLVED FIXED
Product: UCS@school
Classification: Unclassified
Component: Documentation
UCS@school 4.2
Other Linux
: P5 normal (vote)
: UCS@school 4.2 (HTTP-API-MVP)
Assigned To: Daniel Tröder
Sönke Schwardt-Krummrich
:
Depends on: 45023
Blocks: 45342
  Show dependency treegraph
 
Reported: 2017-11-06 14:04 CET by Sönke Schwardt-Krummrich
Modified: 2017-11-14 12:39 CET (History)
1 user (show)

See Also:
What kind of report is it?: Feature Request
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 Sönke Schwardt-Krummrich univentionstaff 2017-11-06 14:04:15 CET
We need an enduser manual for the new UMC-Import-Module, so teacher/staff user are able to upload new CSV files for upload.

- the manual should be independant from the admin/teacher manual
- the manual should outline the import process steps (select school, select role, 
  upload file, dry-run, actual import)
- step by step instructions with screenshots


Do we need also a seperate installation quickstart guide?
Comment 1 Daniel Tröder univentionstaff 2017-11-06 17:31:28 CET
(In reply to Sönke Schwardt-Krummrich from comment #0)
> Do we need also a seperate installation quickstart guide?
I could address the document to both staff and administrators.
* The first (and longest) part would be for the staff (import process steps, screenshots).
* At the end I would add a short section for administrators with a) installation instructions (1 line: univention-install ucs-school-umc-import) and b) the security concept and how to use the cn=$OU-import-all groups.
Comment 2 Sönke Schwardt-Krummrich univentionstaff 2017-11-07 12:31:25 CET
(In reply to Daniel Tröder from comment #1)
> (In reply to Sönke Schwardt-Krummrich from comment #0)
> > Do we need also a seperate installation quickstart guide?
> I could address the document to both staff and administrators.
> * The first (and longest) part would be for the staff (import process steps,
> screenshots).
> * At the end I would add a short section for administrators with a)
> installation instructions (1 line: univention-install ucs-school-umc-import)
> and b) the security concept and how to use the cn=$OU-import-all groups.

I think, this is ok.
Comment 4 Daniel Tröder univentionstaff 2017-11-07 16:12:30 CET
I added a note about a UCRV → build 24
Comment 5 Daniel Tröder univentionstaff 2017-11-09 08:15:16 CET
Redirected from Bug #45342: Add an example of the CSV format with dummy data.
Comment 6 Daniel Tröder univentionstaff 2017-11-10 13:56:51 CET
[4.2 791d2d8c] Bug #45657: add section about CSV file format
[4.2 d6c2c155] Bug #45657: fix typo and validity error

http://jenkins.knut.univention.de:8080/job/UCSschool%204.2/job/Manual/26/artifact/webroot/ucsschool-umc-import-handbuch-4.2.html