#4005 Improve documentation for pagure upgrades
Opened 6 months ago by wattersmt. Modified 2 months ago

The UPGRADING.rst file does not cover upgrading from Pagure 4 to Pagure 5 very well. For example, the following items need to be addressed.

  • What new dependencies need to be installed? For example, the python2-trololio package is now required.
  • What new services should be enabled?
  • How are existing git hooks affected by the upgrade? Currently pagure prints out a message regarding upgrading legacy hooks to use the plugin infrastructure but there is no link to any documentation on how to accomplish this.
  • How should new hooks be named? I was able to figure this out eventually but the documentation for git hooks needs to be more clear.

Documentation regarding the new themes and how to customize them would also be helpful.


Documentation regarding the new themes and how to customize them would also be helpful.

I'll come back to the others, but the theming doc is already available at: https://docs.pagure.org/pagure/usage/theming.html

Metadata Update from @pingou:
- Issue tagged with: debt, doc, easyfix

6 months ago

Metadata Update from @pingou:
- Issue set to the milestone: 5.4

4 months ago

I've updated the UPGRADING with the change in dependencies.

For the services and the git hook, we should just really update the documentation at docs.pagure.org/pagure. That's a more work than I can do right now so I'm going to postpone it for later :)

Metadata Update from @pingou:
- Issue set to the milestone: Coming 3 months (was: 5.4)

2 months ago

Login to comment on this ticket.

Metadata