Simplify the Getting Started guide and migrate installation options to User Guides
Describe the documentation issue
I've gotten the impression from some users that the Getting Started guide provides an unnecessary level of flexibility, laying out several options for installing each component which ultimately makes the guide harder to read for novice users.
I think the info on installation methods is valuable, but it may give the user too much choice upfront.
Describe the enhancement
My proposal is:
- Simplify each guide page to provide one installation option, or if necessary one option per OS.
- That installation option should be updated to use Python 3 when Python is involved -- we should be encouraging transition to Python 3 wherever possible.
- Redistribute the other installation methods to User Guide pages per component, for example "Installing Cuebot".
Additional context
N/A
@sharifsalah Any thoughts on this? Are User Guide pages the right way to go here or is a Reference page more appropriate?
I would definitely recommend limiting and simplifying choices within a guide, especially for folks who are unfamiliar and new to the project.
Ideally, the user should make the choice before starting to work through a guide, for example by selecting the right combination of OS and method. It's also a good idea to have some information that helps the user choose between the various options; when is option A recommended over option B?
Personally, I think from the user's perspective, it's better to have a long list of installation guides. (as opposed to some as installation guides and some as user guides)
The topics might look something similar to:
- Choosing an installation method
- Linux
- Installing from source
- Installing using containers
- Installing natively
- macOS
- Installing from source
- Installing using containers
- Installing natively
- Windows...