[request-tracker-maintainers] Expose docs via web interface?

[Dominic Hargreaves]

On Sun, Jun 18, 2023 at 12:13:46AM +1200, Andrew Ruthven wrote:
> Hey,
> 
> I noted this in my bug report about adding 5.0.3+dfsg-2+deb12u1 to
> Bookworm[0], the following, just in case someone objected.
> 
> On Sat, 2023-06-17 at 21:26 +1200, Andrew Ruthven wrote:
> > [ Other info ]
> > I acknowledge that it would be preferable to link to documentation
> > contained within the running system, but our packages don't currently
> > configure the generated documentation to be accessible via the web.
> 
> Should we expose the documentation within the authenticated area of RT and
> modify the internal links to use the local copy of the docs?

Yeah, ideally.

> I do like the idea of using the local docs, but there are a couple of
> problems:
> 
> 1. Currently they're only a Suggests. This means that we'd need to have a
> place holder page if they aren't installed saying "Say, install this".
> 2. They're ugly, there is no CSS provided.

This is https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=704773 FWIW

> 3. It feels to big a change to put into bookworm unless someone complains.

Agree, this isn't a change for bookworm.

> With a bit of effort I think they could be styled in a similar way as the
> running RT.

The other consideration might be whether the docs might be more up to
date online compared to the shipped stuff. Probably not a big deal.

Cheers
Dominic