Update docs links

[joshuawilson]

The docs team has released the getting started doc. This is to replace the pdf version that we currently have.

We need a link to this from the landing page and from within the running app. We also need to remove the outdated pdf version.

Please use https://docs.openshift.io/getting-started-guide.html

This is need to support https://github.com/fabric8-ui/fabric8-ui/pull/2516

[joshuawilson]

@catrobson can you help identify where this link should go? @mindreeper2420 can you add this link once a location is set? @qodfathr here is the getting stared doc for your review. @rkratky I noticed that the Deployments page image is with the internal setting, it is experimental in production. @corinnekrych can you please update prod-preview accordingly.

[corinnekrych]

@joshuawilson i've just set it experimental

[catrobson]

@rkratky @qodfathr -

I've put together my thoughts for handling this throughout the application (logged in and out) here: https://redhat.invisionapp.com/share/NVFTBRWQ9MB

The help icon in the header of the application is consistent with OpenShift design. The documentation would always also be accessible via openshift.io when logged out via the new documentation tab on the homepage.

To do this, we would put the current docs.openshift.io page into the header/footer of the openshift.io webpage. When you navigate into a document, it would still show Red Hat Developers as the top left logo unless we change that over to OpenShift.io, which would be preferred as well if we can.

This also means that the homepage that was being worked on previously by the UX team that combined OpenShift.io and RHOAR documentation would not be recommended, we would just have OpenShift.io documentation on the website. The RHOAR team could use the same page template for their documentation, but it shouldn't be hosted on OpenShift.io.

Please review and let me know if you are ok with moving forward with this direction.

[qodfathr]

@catrobson that works for me.

Everyone -- please note that the link https://docs.openshift.io/getting-started-guide.html is now part of the Welcome to OSIO email sent to new users, so if that URL is going to change, we need to update the email. (A process which takes a few days to get scheduled.) (So let's not change it :) )

[joshuawilson]

this is done and in production

[rkratky]

@catrobson @qodfathr I have only now realized that this resulted in the creation of https://openshift.io/documentation.html -- I find that suboptimal. I don't mean the look of the page, but the fact that there are now two docs landing pages:

• https://openshift.io/documentation.html
• https://docs.openshift.io/

Not only does that create a potential for confusion (users might not be immediately sure whether the offered docs are the same) but it also seems non-systemic: while the actual docs are hosted from a sub-domain (docs.os.io), there's a docs landing page elsewhere.

If the issue is with the look of the docs.os.io page, we will gladly modify it to conform to what the UX team created for https://openshift.io/documentation.html. I would then suggest setting up a redirect from this URL to https://docs.openshift.io/ to get rid of the described duplicity.

[catrobson]

@rkratky thanks for the message, this was an oversight I'm afraid.

I agree with the redirect methodology, but would like to suggest that we should have docs.openshift.io redirect to /documentation so it follows our URL logic for everything else we're going to do on Openshift.io domain name. Is that OK with you?

[rkratky]

@catrobson Well, the actual docs would still live at docs.os.io/foobar.html, so unless we move these files to os.io/documentation/foobar.html, then I think we would be not be solving the problem.

[catrobson]

Ok, understood. We'll redirect the other way for the URL then.

[rkratky]

@catrobson Could you please let me know where I can find the source code for the landing page you created, so that I can deploy it on docs.os.io? Also, are there some other considerations? I.e. should the top bar be the same even though it would be a different URL?

[joshuawilson]

@rkratky it is this repo. https://github.com/openshiftio/openshift.io

[AdamJ]

@rkratky @catrobson for the Documentation page (openshift.io/documentation.html), I can set up an automatic redirect, bringing the user to docs.openshift.io. If that is the desired operation, then the documentation.html page can either just be left blank or, in the case of a timeout or redirect issue, can have information on where the user should navigate to.

Thoughts?

[catrobson]

@mindreeper2420 can you help get the OS.io marketing page header and footer into docs.openshift.io so that we maintain a good user experience even if the URL is different? Once that is ready, we can redirect.

[AdamJ]

@rkratky How would you like me to deliver the header/footer for docs.openshift.io? Would it be preferred to just share to HTML/CSS or is there a particular dev that I should speak with?

[rkratky]

@mindreeper2420 Sharing the HTML/CSS is just fine. There's no dev assigned to that page.

[AdamJ]

@rkratky Here are the .less files for the header and footer:

• https://github.com/openshiftio/openshift.io/blob/master/src/assets/stylesheets/_navigation.less
• https://github.com/openshiftio/openshift.io/blob/master/src/assets/stylesheets/_footer.less

HTML here:

• https://github.com/openshiftio/openshift.io/blob/master/src/app/index.html
  • the footer is included at the bottom of the page