About page, configurable cli download links

[fabianofranz]

Adds an "About" page to the web console with server version information and configurable download links for the CLI tools (if provided).

I wanted to make the download URL's flexible enough to allow you to either specify multiple links pointing directly to the client packages (for each platform, for example), or you could point to an external page that links the actual packages (the GitHub releases page, for example). So the configuration takes both the URL and title. Examples of valid configurations would be:

cli: {
  downloadURL: {
    "Linux (32 bits)": "https://<cdn>/cli-v1.1.1-e1d9873-linux-32bit.tar.gz",
    "Linux (64 bits)": "https://<cdn>/cli-v1.1.1-e1d9873-linux-64bit.tar.gz",
    "Windows": "https://<cdn>/cli-v1.1.1-e1d9873-windows.zip",
    "Mac OS X": "https://<cdn>/cli-v1.1.1-e1d9873-mac.zip"
  }
}

or

cli: {
  downloadURL: {
    "Latest Release": "https://<cdn>/openshift-origin-client-tools/releases"
  }
}

About page

Fixes #2281
Fixes #3493
Fixes #4344
Fixes #4885

[liggitt]

Hmm, this seems super specific. Won't there be other things that need customizing on that page as well, like product name and other links? Plumbing all of that through config seems like the hard way to do that

[fabianofranz]

We may want to reduce the amount of info in that page, but an entry in the config file for CLI download links is a specific requirement from online. Links for docs already use the filters mechanism used everywhere on the web console.

[jwforres]

@liggitt we've talked with @brenton and @danmcp about specifically letting administrators put in their own download links so they can host oc themselves, so this is more than just per product config, its really administrative config

[liggitt]

we also don't expose doc links in config... I would expect doc links and cli download links to use the same config mechanism... I just don't want such a bespoke setting for something so general

[fabianofranz]

I think this is the only thing left in this PR, waiting for @jwforres confirmation about where we want this config.

[fabianofranz]

@jwforres @spadgett

[jwforres]

try the openshift icon in red

[jwforres]

... hit enter too soon...

check with @luciddreamz for what the right red is for the openshift icon

[jwforres]

the download links blend together a bit, maybe stacking them vertically, or having a gray pipe between them

[spadgett]

@sspeiche FYI

[sspeiche]

I wonder, if this is the about page for Origin, then we may want to have the link go to openshift.org
Likewise, at some point we may want to specific links to the offering page for Enterprise and Dedicated?.

Though I think for an initial pass, it would be fine just defaulting to openshift.com as it has redirects already

[fabianofranz]

Yeah, at least for now the idea was to point to openshift.com which links every other product and project.

[sspeiche]

It all looks great. Only thing I'm not sure of is how we are directing users to get help, provide feedback or report problems. Would this come in the about page or a separate menu item or ?

[liggitt]

does this have to be served in a separate file? don't really want lots of individual requests for config data

[jwforres]

agree with @liggitt why wouldn't this be in config.js ?

[fabianofranz]

All config.js entries are something you can change to customize some behavior, while version info is always generated by the master, not part of the set of configs an installation could change. Didn't seem to fit well. But I could buy having it in config to save a request, I think.

[fabianofranz]

Fixed, version is now being server in config.js, in a separate object as it was before to keep what's really configurable as a separate structure.

[fabianofranz]

the download links blend together a bit, maybe stacking them vertically, or having a gray pipe between them

@jwforres yeah, my first version was vertical and for some reason I changed, moved back which looks better

[fabianofranz]

check with @luciddreamz for what the right red is for the openshift icon

@luciddreamz using #c00 until we confirm what's the right color

[fabianofranz]

It all looks great. Only thing I'm not sure of is how we are directing users to get help, provide feedback or report problems. Would this come in the about page or a separate menu item or ?

@sspeiche I think the design review in the works by @sg00dwin includes that, it has a "?" drop-down that include links to docs, this About page, and probably other stuff. Anyone else could confirm?

[luciddreamz]

@fabianofranz the OpenShift logo is #CD202C:

[jwforres]

There would be a place to add other links there, we need to think about
"Report a problem" we had a lot of issues trying to do that in v2 because
different products and even different user plans had different ways to
report problems.

On Friday, January 22, 2016, Fabiano Franz notifications@github.com wrote:

It all looks great. Only thing I'm not sure of is how we are directing
users to get help, provide feedback or report problems. Would this come in
the about page or a separate menu item or ?

@sspeiche https://github.com/sspeiche I think the design review in
the works by @sg00dwin https://github.com/sg00dwin includes that, it
has a "?" drop-down that include links to docs, this About page, and
probably other stuff. Anyone else could confirm?

—
Reply to this email directly or view it on GitHub
#6783 (comment).

[fabianofranz]

@luciddreamz thanks! updated

[jwforres]

Ok result of a number of discussions is that we are going to do this as an extension JS. So we need a JS API for providing custom download links, think about how you would do the same thing for help links (and if possible go ahead and implement it cause we need it soon).

OOTB in origin I'm guessing we wouldn't provide a CLI download link since the only place they exist today is in the release in github which includes ALL the binaries.

So if we dont have any CLI download links available, then maybe tweak the text in the CLI section?

[fabianofranz]

@jwforres ok, thanks, I'll adjust this to use JS extensions. No CLI download links available were already a supported scenario, the About page adjusts to it.
@spadgett do we already use extension JS somewhere in the code? Could you point me to it?

[spadgett]

Ok result of a number of discussions is that we are going to do this as an extension JS.

It seems odd to ask admins to write JS code to set one URL :-/

[spadgett]

do we already use extension JS somewhere in the code? Could you point me to it?

Not yet, but here is the help topic:

https://docs.openshift.org/latest/install_config/web_console_customization.html

Let me know if you have trouble.

[fabianofranz]

@spadgett thanks!

[liggitt]

don't pass the whole version struct to the template, just put the version string in the struct given to the template. that removes the need to make this package depend on the version packages, and gives us compiler checks on the use of the GitVersion field

[fabianofranz]

Nice, fixed.

[fabianofranz]

Waiting to rebase when the console ui restructure lands.

[fabianofranz]

Rebased, [merge].

[openshift-bot]

[Test]ing while waiting on the merge queue

[spadgett]

@fabianofranz looks like you need to clean / install assets

[jwforres]

@fabianofranz java/bindata.go is wrong looks like it needs to be updated, it just got updated yesterday, in general you shouldn't ever be checking in java/bindata.go

[fabianofranz]

@jwforres meh, I removed and didn't notice it was there again. :/

[openshift-bot]

Evaluated for origin test up to 2501295

[openshift-bot]

continuous-integration/openshift-jenkins/test FAILURE (https://ci.openshift.redhat.com/jenkins/job/test_pr_origin/770/)

[openshift-bot]

continuous-integration/openshift-jenkins/merge SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_requests_origin/4841/) (Image: devenv-rhel7_3324)

[jwforres]

[merge]

[openshift-bot]

Evaluated for origin merge up to 2501295