search

openscanhub / fedora-infra

Deployment configurations for the Fedora infrastructure.
https://openscanhub.fedoraproject.org
GNU General Public License v3.0
1 stars 1 forks source link

Where should the user documentation go? #34

Closed siteshwar closed 4 months ago

siteshwar commented 5 months ago

This issue tracks documenting OpenScanHub for users of the Fedora project.

@nirik Shall the user documentation go to Fedora wiki?

This issue was previously discussed with @kdudka and we wanted to use something that could be tracked through git. However, we would appreciate any guidelines from the Fedora infrastructure team.

nirik commented 5 months ago

You could use the wiki, thats easy, but yes, no got backing.

You could use docs.fedoraproject.org, but I am not sure where on there. The various teams/parts are built from different git repos. Perhaps a seperate thing along the lines of the defensive coding guide: https://docs.fedoraproject.org/en-US/defensive-coding/ ?

kdudka commented 5 months ago

Assuming it uses markdown, both the options sound fine to me. I do not think I will the primary person writing the documentation, so my opinion is not that important though.

siteshwar commented 5 months ago

@nirik @kdudka I would start drafting user documentation on the Fedora wiki and see how things go. Let me know if you could recommend me any template to follow.

siteshwar commented 5 months ago

I made an initial draft of the documentation at: https://fedoraproject.org/wiki/OpenScanHub

siteshwar commented 4 months ago

There is always a room for improvement in the docs, but we have agreed to do it on the Fedora wiki and the basic documentation is done. So, I am going to close this issue.