Bug 54705 – The Kelvin API changelog should be readable without installing and locatable from the Kelvin docs

Bug 54705 - The Kelvin API changelog should be readable without installing and locatable from the Kelvin docs


Summary:	The Kelvin API changelog should be readable without installing and locatable ...

Status:	NEW

Product:	UCS@school
Classification:	Unclassified
Component:	Documentation
Version:	unspecified
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:	2022-05-02 10:53 CEST by Jan-Luca Kiok
Modified:	2023-08-23 10:20 CEST (History)
CC List:	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?:	Yes
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):	bitesize, Workaround is available
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 Jan-Luca Kiok

2022-05-02 10:53:31 CEST

Every now and then I want to take a look at the Kelvin changelog at least before updating or even without a proper installation at hand.
My starting point in this case is the Kelvin API documentation at https://docs.software-univention.de/ucsschool-kelvin-rest-api/#, however there is no changelog provided or linked, so the only way to read the changelog seems to be an app update.
I would propose to include the latest changelog in the Kelvin API documentation or to host the changelog openly at docs.software-univention with a link from the Kelvin Docs.

Comment 1 Daniel Tröder

2022-05-02 11:33:54 CEST

The Kelvin docs are updated with each new app version. The change there would thus be always up2date.

Move kelvin-api/changelog.rst to doc/kelvin/docs/, include in toc and beautify.

Comment 2 Jan-Luca Kiok

2023-06-12 15:07:30 CEST

While I agree that the place is inconvenient they are indeed published with the appcenter: https://appcenter.software-univention.de/univention-repository/4.4/maintained/component/ucsschool-kelvin-rest-api_20230330115604/README_UPDATE_EN