Kube & Sink docs at api.kde.org/doc still wanted/needed?

[Ingo Klöcker]

On Freitag, 22. Mai 2020 12:23:20 CEST Friedrich W. H. Kossebau wrote:
> Hi Christian,
> 
> doing some housekeeping on the server behind api.kde.org it was found to
> surprise to some that the nightly script is spending cpu, i/o & storage
> resources each day on generating some documentation for Kube & Sink, with
> the result available on
>     https://api.kde.org/doc/kube
>     https://api.kde.org/doc/sink
> 
> At least for Kube the official documentaion as linked from kube-project.com
> seems to be on https://kube.readthedocs.io though, not api.kde.org/doc.
>
> So is that documentation generated and made available on api.kde.org/doc
> still wanted, or could we remove it already?

I think the documentation on api.kde.org needs to stay, as long as Kube is a 
KDE project. One of the commitments of a KDE project [1] is:
===
* The project stays true to established practices common to similar KDE 
projects
===

As far as I know, one established practice among KDE projects is hosting of 
their API documentation on api.kde.org. This ensures that contributors to KDE 
projects don't need to look for the API documentation of different KDE 
projects in different places.

Of course, it's okay to host the (identical) documentation *additionally* on 
kube.readthedocs.io (similar to our source code being mirrored on GitHub).

Regards,
Ingo

[1] https://manifesto.kde.org/commitments.html
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 195 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-pim/attachments/20200522/0cefae4f/attachment.sig>