Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify the Getting Started guide and migrate installation options to User Guides #193

Open
bcipriano opened this issue Aug 7, 2020 · 2 comments

Comments

@bcipriano
Copy link
Collaborator

bcipriano commented Aug 7, 2020

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

@bcipriano
Copy link
Collaborator Author

@sharifsalah Any thoughts on this? Are User Guide pages the right way to go here or is a Reference page more appropriate?

@sharifsalah
Copy link
Collaborator

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:

  1. Choosing an installation method
  2. Linux
    1. Installing from source
    2. Installing using containers
    3. Installing natively
  3. macOS
    1. Installing from source
    2. Installing using containers
    3. Installing natively
  4. Windows...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants