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.

Sign up for GitHub

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

Jump to bottom

improve/add update channel/appman related text and doc links #2106

Closed
phillxnet opened this issue Jan 13, 2020 · 3 comments · Fixed by #2107
Closed

improve/add update channel/appman related text and doc links #2106

phillxnet opened this issue Jan 13, 2020 · 3 comments · Fixed by #2107

Comments

@phillxnet
Copy link
Member

Our update channel selection related prompt dialogs (first login & dashboard) have minimum/no info and no links to assist with this required Rockstor package update choice. The Update page, in turn, was also lacking documentation links to assist with this decision.

It is proposed that we 're-vamp' these modal dialogs in keeping with documentation improvements that have happened in the mean time. We can also, within this issue address:
"Improve 'first login' update message" #1811

There is a requirement also, to be in line with tradmark use, for us to add "Uses" to our distro base text: i.e. "Uses openSUSE" / "Uses Tumbleweed". As this is a trivial text change, in keeping with this issues other elements, it is in keeping to be included. And nudges us close to be 'in compliance' with a "Built on openSUSE" distro ready for our openSUSE based installer release.
phillxnet added a commit to phillxnet/rockstor-core that referenced this issue Jan 13, 2020
@phillxnet
improve/add update channel/appman related text and doc links rockstor…
fba34bb 
…#2106

Improve text & add doc links to update channel selection modal dialog
reminder prompts: first login & Dashboard popups.

Includes:
- Improve update text clarity/brevity and add doc links accordingly.
- Update Frequency corrections for both channels.
- Normalise on ',.. dependant upon ...' text with donate modal dialog.
- Fix colour highlighting bug for Appliance ID text.
- Add Appman link and text on activation code entry dialog.
- Suggest forum rather than support email for general update channel
selection assistance.
- Reduce apparent number of steps for Stable channel activation.

Additionally:
- Update menu forum link & text to avoid redirect & improve robustness:

Our prior forum link was rockstor.com/forums. This older dir reference
is now redirected but consequently depends on two web servers. By going
directly to the new sub-domain url we avoid this dual dependency and
have this link work while our main site is down for maintenance; for
example.
@FroggyFlox
Copy link
Member

Hi @phillxnet,

Related to the issue of improving documentation on some key points of the UI, the thought of better linking to the documentation has lived in my head for a little while now. It's mostly unrelated to the current issue, but it did remind me of it.

Among many options we have, I was wondering whether we could also add an icon to those key points that would consistently points the user to the relevant section of the documentation. I was thinking of suggesting doing this in my upcoming "Rocknets" changes and you can see an illustration in the screenshot located in the comment below:
#2009 (comment)

There, you can see what I mean with the "question mark icon" that would contain a link to the relevant section of the documentation.

What do you think of doing something like that across the UI (implementing it progressively, of course)?

@phillxnet phillxnet mentioned this issue Jan 13, 2020
Merged
@phillxnet
Copy link
Member Author

@FroggyFlox Appologies I should have said I was preparing a pr for this issue. Which I have now done as it goes.

Re:

There, you can see what I mean with the "question mark icon" that would contain a link to the relevant section of the documentation.

Yes this is an excellent idea and has been 'planned' for a while now. I think these "?" links should supplement our text links however and in this issue's case I've only added text links. We probably need a 'proof of concept' pr for this such as may be associated with your #2009 issue. We also need to choose our icon carefully as later versions of bootstrap no longer include the previously default icon font which Rockstor already uses quite heavily (licence issue between bootstrap and icon font maker). So that's a detail for watch for so we don't end up making additional work for ourselves once we get to jump to Bootstrap 4 or whatever.

Would you mind casting a casual eye over the results of this issue's associated pull request?

We have lots on so don't look too closely. I was just after fixing up quite a few paper cuts re update channel communication. The text specifics are slightly more relevant to our pending "Build on openSUSE" releases but still make sense for our current but legacy CentOS base.

@FroggyFlox
Copy link
Member

I think these "?" links should supplement our text links however and in this issue's case I've only added text links. We probably need a 'proof of concept' pr for this such as may be associated with your #2009 issue. We also need to choose our icon carefully as later versions of bootstrap no longer include the previously default icon font which Rockstor already uses quite heavily (licence issue between bootstrap and icon font maker). So that's a detail for watch for so we don't end up making additional work for ourselves once we get to jump to Bootstrap 4 or whatever.

I completely agree with you with regards to the need of conserving/adding text links as well... that's a good point.
With regards to the icon, thanks for bringing this up I'll try to remember the matter when it'll be time for me prepare the PR related to #2009.

Would you mind casting a casual eye over the results of this issue's associated pull request?

I like these as they do make everything a lot clearer, thanks for doing all of these!

phillxnet added a commit that referenced this issue Jan 14, 2020
@phillxnet
Merge pull request #2107 from phillxnet/2106_improve/add_update_chann…
ba0ee33 
…el/appman_related_text_and_doc_links

improve/add update channel/appman related text and doc links. Fixes #2106
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

improve/add update channel/appman related text and doc links. Fixes #2106 phillxnet/rockstor-core
2 participants
@phillxnet @FroggyFlox