Bug 54001 – Add documentation about Kelvin REST API app

Bug 54001 - Add documentation about Kelvin REST API app


Summary:	Add documentation about Kelvin REST API 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:32 CEST by Nico Gulden
Modified:	2021-12-17 15:18 CET (History)
CC List:	0 users

See Also:	53420
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?:	3: Will affect average number of 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.103
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 Nico Gulden

2021-10-30 00:32:18 CEST

Bug #53420 just mentions the app in the manual. To provide benefit to the reader the Kelvin REST API documentation should be enhanced more and cover the following aspects.

1. What are the requirements for installation and deployment?

2. What are the steps to check for the correct functionality of the app on the system? Which commands can be used? For the support it is important to show that the API is working as expected and that the problem may be in the client using the API.

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?

The developer documentation for the Kelvin REST API is published at https://docs.software-univention.de/ucsschool-kelvin-rest-api/index.html.