Bug 1008553 - need to adjust the landing / welcome / splash page to contain the updated RHEVM 3.3 documentation links
Summary: need to adjust the landing / welcome / splash page to contain the updated RHE...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine-webadmin-portal
Version: 3.3.0
Hardware: Unspecified
OS: Unspecified
high
unspecified
Target Milestone: ---
: 3.3.0
Assignee: Alexander Wels
QA Contact: Pavel Stehlik
URL:
Whiteboard: ux
: 989227 1014672 (view as bug list)
Depends On:
Blocks: 3.3snap1
TreeView+ depends on / blocked
 
Reported: 2013-09-16 15:07 UTC by Yuko Katabami
Modified: 2015-09-22 13:09 UTC (History)
14 users (show)

Fixed In Version: is20
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Yuko Katabami 2013-09-16 15:07:52 UTC
Description of problem:
When you open RHEVM Web Portal landing page, Hypervisor Deployment Guide is included in the list of documentation links.
This guide became obsolete and no longer in RHEV documentation suite.


Version-Release number of selected component (if applicable): 3.3


How reproducible: 100%


Steps to Reproduce:
1. Open Web Portal landing page in any given locale.
2. Check the Documentation list.


Actual results:
It has a link to Hypervisor Deployment Guide


Expected results:
It should be removed from the list.

Additional info:
Screenshot is attached.

Comment 1 Einav Cohen 2013-09-17 18:52:51 UTC
Yuko, I am not sure what you mean by "This guide became obsolete and no longer in RHEV documentation suite" - do you mean that this link is broken?
I have just tested the welcome page in "is15" and this link is not broken - it redirects to the "Hypervisor Deployment Guide" properly.

Comment 2 Yuko Katabami 2013-09-17 21:42:13 UTC
(In reply to Einav Cohen from comment #1)
> Yuko, I am not sure what you mean by "This guide became obsolete and no
> longer in RHEV documentation suite" - do you mean that this link is broken?
> I have just tested the welcome page in "is15" and this link is not broken -
> it redirects to the "Hypervisor Deployment Guide" properly.

Hi Einav,

What I meant to say was that docs team no longer updates this guide.
The current version (for RHEV 3.2) was written as RHEL 6.4 HDG by the platform writer team.
There will be no more update for this guide, and it is removed from the RHEV docs documentation suite in 3.3, therefore it should be removed from this landing page as well.

Sorry I did not pick this up while I was translating the string in Zanata.


We can double check with Cheryn. (I am adding "needinfo")

@Cheryn, could you please confirm this for us?

Comment 3 Yuko Katabami 2013-09-18 04:41:47 UTC
Hi Einav,

In addition to the above, I also found that "Manager Release Notes" is not listed on this page. Could you please check whether it is supposed to be there?
If necessary I can file a separate bug. Please let me know.

Comment 4 Einav Cohen 2013-09-18 15:26:50 UTC
(In reply to Yuko Katabami from comment #3)
> Hi Einav,
> 
> In addition to the above, I also found that "Manager Release Notes" is not
> listed on this page. Could you please check whether it is supposed to be
> there?
> If necessary I can file a separate bug. Please let me know.

many thanks for noticing and notifying me about it, Yuko - I appreciate it.
I am turning this BZ into a general "adjust RHEV-M welcome page to RHEV-M 3.3 documentation" BZ.
I am 'needinfo'ing Cheryn as well to provide here an exact list of RHEV-M 3.3 documentation documents. Once provided, we will adjust the welcome page according to it.

[removing the 'i18n' keyword, as this is not actually related to i18n]

Comment 5 Einav Cohen 2013-09-18 15:30:02 UTC
*** Bug 989227 has been marked as a duplicate of this bug. ***

Comment 6 Cheryn Tan 2013-09-20 05:51:10 UTC
Hi Einav, Yuko is right -- the Hypervisor Deployment Guide is being deprecated from the RHEL suite for 6.5. And since there is quite a bit of overlap between the HDG and RHEV Installation Guide, our plan is to fold the HDG content into the IG. 

As for Manager Release Notes, I'm hesitant of including it on the landing page because it is usually the book that is the last to be completed and translated, so it may end up delaying the delivery of the rhevm-doc-* packages. I'm in favour of leaving it on access.redhat.com only; anyway with the Red Hat Support plug-in it's now easier for customers to access the release notes through the admin portal UI.

Adding Arthur and Jodi (current RHEV team lead) if they have any other opinions.

Otherwise, this is the full list of RHEV docs:
Administration Guide
Command Line Shell Guide
Developer Guide
Evaluation Guide
Installation Guide
Power User Portal Guide
Quick Start Guide
Technical Reference Guide
User Portal Guide
V2V Guide

Comment 7 Jodi Biddle 2013-09-20 06:22:49 UTC
I second Cheryn's position. No need to include release notes or the HDG for this release, it'll only cause trouble in the future.

Comment 8 Einav Cohen 2013-09-21 17:04:48 UTC
Thanks, Cheryn. 

Any chance that you can provide here a list of the exact names of the html/pdf documents (once they are determined) so we will link them properly in the welcome page?

Comment 9 Cheryn Tan 2013-09-23 06:26:16 UTC
Hi Einav, do you mean the package names (Red_Hat_Enterprise_Virtualization-Installation_Guide-3.3-web-en-US-1-0.0.el6.eng) or just the guide titles? If it's just the titles, the list from comment 6 should be fine. Thanks.

Comment 10 Einav Cohen 2013-10-01 13:49:24 UTC
(In reply to Cheryn Tan from comment #9)
> Hi Einav, do you mean the package names
> (Red_Hat_Enterprise_Virtualization-Installation_Guide-3.3-web-en-US-1-0.0.
> el6.eng) or just the guide titles? If it's just the titles, the list from
> comment 6 should be fine. Thanks.

Hi Cheryn, we actually need both the titles from comment #6, as well as the file names themselves to link to (***.html / ***.pdf). thanks.

Comment 11 Cheryn Tan 2013-10-02 03:40:03 UTC
Hi Einav, 

I'm not too well-versed with the implementation details, but I don't think they'd be any different from the current versions. The HTML files should be in the format of 
https://{manager-hostname}/docs/{lang_code}/html/{Book_Name}/index.html
https://{manager-hostname}/docs/{lang-code}/pdf/{Book_Name}/Red_Hat_Enterprise_Virtualization-{version.number}-{Book_Name}-{lang-code}.pdf

For example:
https://rhevm.example.com/docs/en_US/html/Administration_Guide/index.html
https://rhevm.example.com/docs/en-US/pdf/Administration_Guide/Red_Hat_Enterprise_Virtualization-3.3-Administration_Guide-en-US.pdf

Further details are here:
https://docspace.corp.redhat.com/docs/DOC-95209

Feel free to ping me when you get online, and we'll work this out.

Comment 12 Einav Cohen 2013-10-03 01:01:21 UTC
Thanks, Cheryn.


Alex - it seems that the only "new" document that we were discussing here ("Manager Release Notes") should not be included in the welcome page after all.
so all documents basically remained the same, just need to make sure to change the relevant names/parts of URLs from "3.2" to "3.3" where necessary, and the link(s) to the "Hypervisor Deployment Guide" should be removed.

If there are still open issues - please let me / Cheryn know. thanks.

Comment 13 Einav Cohen 2013-10-03 20:08:36 UTC
*** Bug 1014672 has been marked as a duplicate of this bug. ***

Comment 14 David Botzer 2013-10-31 11:51:19 UTC
Fixed, 3.3/is20
This the list of DOCs in the RHEVM welcome page:
Administration Guide [PDF]
CLI Guide [PDF]
Developer Guide [PDF]
Evaluation Guide [PDF]
Installation Guide [PDF]
Power User Portal Guide [PDF]
Quick Start Guide [PDF]
Technical Reference Guide [PDF]
User Portal Guide [PDF]
V2V Guide [PDF] 

All links working and refer to RHEVM 3.3
Please confirm,

Comment 15 Alexander Wels 2013-10-31 11:53:06 UTC
Yes this refers to the list of links to the docs on the welcome page.

Comment 16 David Botzer 2013-10-31 12:14:34 UTC
Fixed, 3.3/is20

Comment 18 Itamar Heim 2014-01-21 22:25:12 UTC
Closing - RHEV 3.3 Released

Comment 19 Itamar Heim 2014-01-21 22:25:50 UTC
Closing - RHEV 3.3 Released

Comment 20 Itamar Heim 2014-01-21 22:29:23 UTC
Closing - RHEV 3.3 Released


Note You need to log in before you can comment on or make changes to this bug.