View Issue Details
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0027140||mantisbt||documentation||public||2020-08-08 05:49||2023-02-13 05:57|
|Priority||normal||Severity||minor||Reproducibility||have not tried|
|Summary||0027140: tool used for documentation generation (publican) is more or less dead|
Hi! I package mantisbt for Arch Linux.
I realized that I need publican to generate the administrator/developer documentation: https://github.com/mantisbt/mantisbt/tree/master/docbook
Looking at upstream, publican seems rather dead though: https://sourceware.org/publican/en-US/index.html and https://fedoraproject.org/wiki/Infrastructure/Fedorahosted-retirement
Looking at Fedora's own spec file for the publican package (https://src.fedoraproject.org/rpms/publican/blob/master/f/publican.spec) I can download a tarball for release 4.3.2 ("https://fedorahosted.org/released/publican/Publican-v4.3.2.tar.gz") but the tarball is a broken archive... :-/
It would be great to switch to some alternative tool for docbook , that is more widespread and still maintained.
|Tags||No tags attached.|
Meanwhile It's available.
Keep in mind there is not only the missing documentation, but also the missing 3rd party components installed by composer.
I also failed to find Publican binaries after fedorahosted.org was killed, and even reported the issue but never got any response.
As for not being able to download the release tarballs from SourceForge, as an alternative you can always get the nightly build following the release from our own server (https://mantisbt.org/builds.php).
The latest version of the documentation is also available online in different versions including downloadable for offline viewing.
@atrol: Yes, the missing 3rdparty components should be no problem though, as we can use composer to install them in the packaging process.
@dregad: I understand. Do you currently use a Fedora system to generate the docs? Maybe there is an easy alternative solution to publican.
No, I'm on Ubuntu.
@dvzrv FYI, I started using Docker to build documentation on my dev box, see 0031993. Maybe this would be useful for you.
@dregad: Sorry, but that doesn't solve the problem. It only pushes resolving it further into the future. ;-)
From a distribution perspective this is also not feasible and no downstream distribution will use this, as it is not reproducible and does not work with how downstream Linux distributions build packages (in clean chroots, only using other - previously packaged - packages).
I highly recommend porting to something still supported and developed (e.g. sphinx or a static site generator).
I know... Delaying the problem was the point actually ;-)
As a matter of fact this is a task that's been on my to-do list for quite a while. I actually started thinking about it around 2019, and even made some tests to convert our DocBook XML to AsciiDoc, but then there was COVID and other real-life priorities... As always, "too many things to do, to little time"
It will happen, eventually. I just can't tell you when.
Until then, as mentioned before you can always download the built documentation from https://mantisbt.org/documentation.php - it is generated nightly (if there's been changes to it) and available in different formats (pdf, epub, txt, html). It is also bundled with our official releases on SourceForge.
Sorry there's not much more I can do for now.