Bug 54000 – Add documentation about Apple School Manager app

Bug 54000 - Add documentation about Apple School Manager app


Summary:	Add documentation about Apple School Manager app

Status:	NEW

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

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

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2021-10-30 00:28 CEST by Nico Gulden
Modified:	2023-08-22 15:07 CEST (History)
CC List:	2 users (show)

See Also:	53420 56192
What kind of report is it?:	Bug Report
What type of bug is this?:	3: Simply Wrong: The implementation doesn't match the docu
Who will be affected by this bug?:	1: Will affect a very few installed domains
How will those affected feel about the bug?:	2: A Pain – users won’t like this once they notice it
User Pain:	0.034
Enterprise Customer affected?:
School Customer affected?:	Yes
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:	2023071421000334
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 Nico Gulden

2021-10-30 00:28:01 CEST

Bug #53419 just mentions the app in the manual. To provide benefit to the reader the Apple School Manager Connector documentation should be enhanced more and cover the following aspects.

1. What are the requirements for installation and deployment?

  * What parameters are needed?
  * Where can the values for the parameters be found?

2. What are the steps to check for the correct functionality of the app on the system?

3. Where are relevant logfiles? And what to look for in it?

4. How are the relevant UCR variables called and what's their purpose? What values are allowed?

5. How and where can the app be debugged?

6. What information is needed for the configuration and where can be obtained?

7. What system roles are recommended for the installation?

8. What data is written where and how do they look like?


Transfer point is the SFTP interface from Apple School Manager.

Comment 1 Nico Gulden

2021-10-30 00:29:12 CEST

The bug adding the mentioning for Apple School Manager is Bug #53420.

Comment 3 Wolfgang Bayrhof

2023-07-19 11:47:18 CEST

Customer explicitly asked for documentation.

Comment 4 Stefanie Schneider

2023-08-22 15:07:13 CEST

I installed the app with a school customer and it was quite hard without a documentation.