If we're going to point users to quick docs, they must be reviewed to ensure correctness. Someone running into a page and pointing out issues is not the best way. So, is there a formal process to approve what makes it to quick-docs and what does not?
@ankursinha Most, if not all, of the Quick Docs pages were imported directly from the Fedora Wiki with a pandoc conversion.
pandoc
As for a review process, do you have any suggestions? The quick docs cover several different topics, so it's hard to identify subject matter experts quickly and reliably. GitHub has functionality to request reviews from specific people for certain files / source, but I'm not sure if Pagure has functionality like this. I am guessing the Docs Team is open to ideas towards this end though.
I think in the meantime, documents that have not been reviewed should be marked as such. Otherwise, users will assume that this information on the official Fedora docs site, have been vetted and is correct?
Well, at the moment the only way I can see is that the team manually contact people and ask them to review the entries. Would using the model package reviewers use work maybe? Write a document, request a review swap on the devel/docs mailinglist? IMO, that has quite a few advantages:
The core team can keep an eye on the reviews and do the final merge, but volunteers can review docs and say "Approved" or something?
FYI for anyone who hasn't seen it: almost all quick-docs now have a banner saying they need a review and point people to an updated README that explains how to review one. See #107.
I add it to this Question,
Is there a process to review and delete Fedora Wiki pages that were or are being migrated to quick-docs?
Having both can cause a bit confusion?
Regards.,
You can set up a redirect as explained here: https://docs.fedoraproject.org/en-US/quick-docs/#_wiki_redirects
Metadata Update from @ankursinha: - Issue close_status updated to: stale - Issue status updated to: Closed (was: Open)
Login to comment on this ticket.