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

Out of date links in Help file; lack of clear navigation #1173

Closed
acrowland opened this issue Oct 14, 2022 · 4 comments · Fixed by #1259
Closed

Out of date links in Help file; lack of clear navigation #1173

acrowland opened this issue Oct 14, 2022 · 4 comments · Fixed by #1259
Labels
help wanted Extra attention is needed low priority Low priority but desired fix

Comments

@acrowland
Copy link

Hello,
I wanted to download the latest stable release of Open Shell, and struggled.

  1. I typed Open Shell into the Open Shell search bar, pointed to Open-Shell Help. Selected Useful Links. All of them are for Classic Shell. Using the most obvious one, I got a page saying it was no longer maintained, as of 2017!
  2. I tried openshell.org. Not the right site.
  3. By clicking the Open Shell Settings icon in File Explorer (something not all users will actually have), I clicked the Open-shell Homepage link. It took me to GitHub, which is apparently the main shop window for the product now. And there I see “If you just want to use it or looking for setup file, click here to download” and a green Download button, with ‘Nightly builds’ below that. I click the big button and am taken, not to the latest stable download, but to the nightly builds page. All of the versions I can see have a ‘Pre-release’ button by them that doesn’t do anything. At this point I go back to the Help file, try the Classic Shell forums, click around a bit. Many of the links in GitHub which appear potentially informative only lead to stuff about GitHub itself, not the program in question (Open Shell), which is very confusing. The People link doesn’t come up with anything I can use, not even an email address for submitting a bug report about the old links.
  4. Eventually discover that if you scroll down far enough there is an entry with ‘Latest’ next to it (which doesn’t work), and below that there is actually a download, though it is under the heading ‘Assets’, which doesn’t mean anything to me.
  5. At some point I stumble across this Forum… It wasn’t even linked to on the home page.

Now before you go thinking I must be some sort of idiot, I would point out that I am a very experienced user and professional IT bod, but it took me a long time to find something simple (latest stable) and even longer to find the right forum. The defunct Classic Shell home pages and forums were far more discoverable. I can assure you that the majority of my customers would not be able to download and install O-S from these pages. Sure, you are developers and once you are used to GitHub it probably becomes clear, but please do not lose sight of the fact that you are writing for ordinary people.
So please point the big green button to the actual download. And please update the Help file!

@ge0rdi
Copy link
Member

ge0rdi commented Oct 14, 2022

Hello and thank you for your feedback.

I wanted to download the latest stable release of Open Shell, and struggled.

Note that there is updater component installed by default that checks for Open-Shell updates automatically (about once a week). So, by default users are notified about new versions automatically.

Do you have this feature disabled?
Or didn't it work for you?

I typed Open Shell into the Open Shell search bar, pointed to Open-Shell Help. Selected Useful Links. All of them are for Classic Shell.

Unfortunately help file is still the one from Classic Shell. Nobody fixed/improved it yet.
It would be nice if anyone could have a look at this, but I guess it is not big priority (and this is a volunteer-maintained project).

I tried openshell.org. Not the right site.

Not sure how did you get to such domain, but simplest possible google search for "Open Shell" returns our main github page on first place.

By clicking the Open Shell Settings icon in File Explorer (something not all users will actually have)

Shortcut to Open Shell Settings is created in start menu by default on installation.
Moreover, settings are by default accessible from context menu when right clicking on start button.

And there I see “If you just want to use it or looking for setup file, click here to download” and a green Download button, with ‘Nightly builds’ below that.

Yup. This is something that should be easy to improve.
Apparently, there is simple "Download" link missing. It is kind of weird we have link for nightly builds but not for actual official release.

At some point I stumble across this Forum… It wasn’t even linked to on the home page.

There is Get Help section with Report issues link on home page.
I guess that should be pretty clear. Or do you have some concrete idea how to improve it?

@ge0rdi
Copy link
Member

ge0rdi commented Oct 14, 2022

Apparently, there is simple "Download" link missing. It is kind of weird we have link for nightly builds but not for actual official release.

Should be fixed already.
Please, have a look:
https://open-shell.github.io/Open-Shell-Menu/

@acrowland
Copy link
Author

acrowland commented Oct 14, 2022 via email

@ge0rdi
Copy link
Member

ge0rdi commented Oct 14, 2022

I guess I might volunteer to fix the help file, seeing as I brought it up.

That would be really appreciated.

You can have a look at how help is being built here:
https://github.com/Open-Shell/Open-Shell-Menu/blob/master/Src/Setup/BuildInstaller.bat#L8

You should be able to figure out paths to help source files, etc.

By the way, I note that the 'big green button' on https://github.com/Open-Shell/Open-Shell-Menu also still goes to nightly builds rather than the Release version.

Fixed already, thank you.

I think that separating the website for developers from the website for end users would be a good thing, even if they are hosted on the same domain.

That's why github offers hosting of project pages on github.io .
We have such already:
https://open-shell.github.io/Open-Shell-Menu

That is the main project page (Open-Shell should link to it).

BTW It is much better to use github for replies/comments rather than replying to e-mail notification. That way you have much more control over formatting, etc.

@ge0rdi ge0rdi added help wanted Extra attention is needed low priority Low priority but desired fix labels Nov 24, 2022
ge0rdi pushed a commit that referenced this issue Dec 24, 2022
 - New help style
 - Grammar fixes/slight reformatting
 - Windows 8 -> 8+
 - Links now go to Github or Classic shell mirror
 - Updated Readme and EULA style to match
 Fixes #1173, #880
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed low priority Low priority but desired fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants