Infrastructure

If no work has been done on this already, I can take care of it.

The if statement mentioned above starts at line 1043 of Bugzilla/Template.pm

Thanks a lot for looking into this, Jean!
Can you provide a patch/diff we can apply to the code? Let me know, when we can proceed that way :)

I've no problem to do a patch. However, I need to know whether the docs are needed on the server (in reality they seem to be outdated) or whether it's good to lead users to an external site for them (the Bugzilla Docs site). Removing the if statement is a workaround, I'd think is better to avoid.

There is indeed a "Help" link for each bug pointing to an invalid URL

What's also still in place is the big "?" link at the main page pointing to https://bugs.documentfoundation.org/docs/en/html/using/index.html

For the moment, let's use https://bugzilla.readthedocs.io/en/5.0/using/index.html as external source

Our Bugzilla source for the patch is at git://gerrit.libreoffice.org/bugzilla

I have submitted a patch to Gerrit https://gerrit.libreoffice.org/#/c/31950/ that removes the whole docs/ folder. If this is merged and the server is updated, then the docs/ folder on the server should be checked again to make sure that it is empty (the docs/ folder could contain files that are ignored by git). The lack of docs should redirect the user to the external source.

Otherwise, the current docs can be updated by running docs/makedocs.pl. I do not have any access so I don't know if this can be done or not.

Let me know if I can help further.

I know this is not the best time to submit this but everyone can see this at the time he wants to, so I'll submit it. I've done another patch that adds the generated docs to the repository. This adds quite some files to the repository but don't think that it should be a problem because these files are already on the server, it seems. The Gerrit patch request can be found on https://gerrit.libreoffice.org/#/c/32232/. This avoids the need to delete anything and avoids also the need for an external source of documentation.

If someone can review this issue and patches and tell me which one is more suitable, I'd be very grateful. Please note that these patches can't be applied both since they do opposite things. If the latter patch is applied, I can try to create a git hook that automatically updates the docs, if requested.

Let me know if anything else is needed. Thanks.

Thanks a lot - asked Xisco to have a look!

Thanks for the pointer to `docs/makedocs.pl`, Jean. Quoting myself on [[https://gerrit.libreoffice.org/#/c/32232]],

files under the docs/en/{html,txt,xml} directories can be automatically generated using
`docs/makedocs.pl`, so I think it's a bit counter intuitive to store them in the VCS.

I just (manually) ran the above command to build the docs, but of course if we go down that
path, the proper way would be to use a git hook in order to run it automatically after each
merge/rebase touching files under `docs/en/rst`.

I leave the bug open as someone might object and prefer to delete the directory altogether
(to redirect users outside of TDF infra); and until a proper git hook is installed on
`bugs.documentation.org` the docs will diverge again next time a file under `docs/en/rst`
is modified.

Guilhem Moulin wrote:

I just (manually) ran the above command to build the docs, but of course if we go down that
path, the proper way would be to use a git hook in order to run it automatically after each
merge/rebase touching files under `docs/en/rst`.

So, just to check if I understood well, the bug mentioned here is fixed. However, the suggestion now is that a git hook is installed to run on every merge/rebase right?

Thanks for checking the requests and sorry for the interruption.

Jean Spiteri wrote:

So, just to check if I understood well, the bug mentioned here is fixed.
However, the suggestion now is that a git hook is installed to run on
every merge/rebase right?

Correct

I've prepared a script that can run as the git hook. I've tested it and it should work but of course, it should be tested on the test bugzilla first. How should I send it to you? Should I send it through email or upload to the repo, please?

Email is fine, but as you prefer. You'll find my address by clicking on my name in this page. Thanks for working on this!

Sent it. Thanks for your quick reply.