AcademySoftwareFoundation / opencue.io

Source for OpenCue website
https://www.opencue.io
Creative Commons Attribution 4.0 International
17 stars 26 forks source link

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

Open bcipriano opened 4 years ago

bcipriano commented 4 years ago

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:

Additional context

N/A

bcipriano commented 4 years ago

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

sharifsalah commented 4 years ago

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...