#581 Write websites docs for pagure
Closed: Fixed Opened by robyduck.

As for ticket #374 we could move all our docs to pagure, as there is a nice feature built in pagure. For now I moved there just the release SOP, but we could, as we do not have many wiki pages, move it all to pagure.

To make this and get a nice layout, we should use sphinx, which is automatically rendered by pagure, it permits to make an index and can include all kind of documentation we are using actually.

The real pro here is to have all websites resources in one place :)

If anyone wants to work on this, please ping me to coordinate the work and to get write access.


I pushed a first Sphinx docs tree to the staging repo, just to have something to work on. I added our release SOP, but it still contains some markup errors (I just copied it there). Sphinx will render it better once we rewrite it with the correct markup.

You can look at it here: https://stg.pagure.io/docs/Fedora_Websites_test/

I am in the process of trying to clone this in order to send you a trial PR that fixes some issues like Websites's -> Websites'.

I noticed that the docs are not in a doc/ sub-directory but appear to be in _sources

This means they are not copied over in forks and cannot easily be modified by a PR in a drive-by GUI manner.

Perhaps they should be moved.

The docs have their own repo, pagure is able to render them for each project.

Interesting - that wasn't obvious to me from this layout/setup. Where is the docs repo? It doesn't seem to be in the pagure list.

Yes, I had the same difficulty. In the overview you can click to see more source git URLs, and you will find it. ssh://git@stg.pagure.io/docs/Fedora_Websites_test.git

The test repo doesn not exist anymore, because I have moved all the stuff to production and we are now on https://pagure.io/fedora-websites

It would be very nice to have more docs from the wiki directly in pagure.

'''Note:''' also the wiki needs an update, most informations are now outdated.

We have a good introduction now I think, any more detailled doc is always welcome.
Closing for now.

Metadata