#1562 Project documentation is confusing and not explained properly
Closed: Fixed 7 years ago Opened 7 years ago by kparal.

In project settings I can check Activate project documentation. After that, a new Docs tab appears, and when I click it, it shows Project not found error. I'm utterly confused how project documentation works. I can't find any setting that would allow me to specify which URL should be used for the Docs tab.

Eventually, I found pagure documentation (which was quite difficult, see #1408). But that doesn't explain it either. It says:

Activate project documentation
Pagure offers the option to have a git repository specific for the documentation of the project.
This repository is then accessible under the Docs tab in the menu of the project.
If you prefer to store your documentation elsewhere or maybe even within the sources of the project, you can disable the Docs tab by un-checking this option.

It says I can have a specific git repository for documentation, but it does not say how to configure it. What should I do in order to have documentation in Pagure? I still don't know.

Could you please make the documentation more useful, and then link to it from the Docs tab instead of displaying Project not found error? That would be very helpful. Thanks.


@kparal hey :) thanks for filing this issue.

It says I can have a specific git repository for documentation, but it does not say how to configure it. What should I do in order to have documentation in Pagure? I still don't know.

You can refer to https://docs.pagure.org/pagure/usage/using_doc.html to understand how to use the Docs repository ( its actually one the most special features of pagure :smile: )

Could you please make the documentation more useful, and then link to it from the Docs tab instead of displaying Project not found error? That would be very helpful. Thanks.

I shall try to make it simpler by adding this link - "https://docs.pagure.org/pagure/usage/using_doc.html" instead of displaying "Project not found". So that one can understand what he/she is suppose to follow :)

@pingou can you give me more insight on this bug?

I came up with this : https://paste.fedoraproject.org/521031/33441148/

Login to comment on this ticket.

Metadata