[docs] Move wiki docs to RTD

[arif-ali]

Creating an initial PR for the basis of discussion.

Would like to get more people involved in docs as well. As wiki requires merge permissions to contribute. The idea is to convert all the wiki docs, and add them to RTD, so that we can get more contributions, and ensuring our docs are upto date.

This PR converts Debian Packaging and How to write a Plugin docs to give an idea.

Any thoughts on this would be awesome

---

Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines

• Is the commit message split over multiple lines and hard-wrapped at 72 characters?
• Is the subject and message clear and concise?
• Does the subject start with [plugin_name] if submitting a plugin patch or a [section_name] if part of the core sosreport code?
• Does the commit contain a Signed-off-by: First Lastname email@example.com?
• Are any related Issues or existing PRs properly referenced via a Closes (Issue) or Resolved (PR) line?
• Are all passwords or private data gathered by this PR obfuscated?

[packit-as-a-service]

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

• sudo dnf install -y 'dnf*-command(copr)'
• dnf copr enable packit/sosreport-sos-4303
• And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

[jcastill]

Love the idea, thank you for this @arif-ali! I have a couple of questions:
When you write RTD you mean readthedocs.io, right?
And when you write 'Move wiki docs to RTD', does it mean that we will stop using https://github.com/sosreport/sos/wiki or that we'll have two copies?
Sorry if these are very basic questions
Let me know if I can help with the Red Hat ones!

[jcastill]

sos.readthedocs.org seems to redirect, at least in my case, to sos.readthedocs.io. Maybe it's worth changing the address in these two places, so it's also consistent with line 36 in ‎docs/user_docs/contribution_guidelines.rst ?

[arif-ali]

Love the idea, thank you for this @arif-ali! I have a couple of questions: When you write RTD you mean readthedocs.io, right?

Correct, it does mean Read the Docs

And when you write 'Move wiki docs to RTD', does it mean that we will stop using https://github.com/sosreport/sos/wiki or that we'll have two copies?

That was my idea, or at least long term. At the moment only people with merge rights can update the wiki, and that prevents collaboration, and updating the documention from the wider teams

Sorry if these are very basic questions Let me know if I can help with the Red Hat ones!

The plan is to do all of them in the PR, this was just a taster to get things discussing, then I can get those done too. We can do most of the stuff using pandoc, and convert them. There's still some subtle changes we'll need to make, but should be simple enough.

I have added/updated the Debian packaging guidelines recently, as they were way out of date, but I have at least one other person who's helping with Debian packaging, but can't write to the wiki. Doing this in the git repo, and hence the readthedocs helps to update the documentation, and hence it would be one place to do it, rather then 2 places, and only 4 people can actually update the wiki.

We will update any other lingering links where needed, if this is the route we want to take.