Bug 1083009 - Documentation links are broken and some files are missing
Summary: Documentation links are broken and some files are missing
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine
Version: 3.4.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 3.4.0
Assignee: Alexander Wels
QA Contact:
URL:
Whiteboard: ux
Depends On:
Blocks: 1080034
TreeView+ depends on / blocked
 
Reported: 2014-04-01 10:08 UTC by Pavel Novotny
Modified: 2014-04-07 10:58 UTC (History)
11 users (show)

Fixed In Version: av6
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-04-07 10:58:29 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Pavel Novotny 2014-04-01 10:08:53 UTC
Description of problem:

Most of the Documentation links on the welcome page (as well as Guide links in Webadmin and User Portal) are broken, because the documentation content is missing or the link is incorrect.

Administration Guide [PDF] - missing CSS files *)
CLI Guide [PDF] - Page not found
Developer Guide [PDF] - Page not found
Evaluation Guide [PDF] - Page not found
Installation Guide [PDF] - missing CSS files *)
Power User Portal Guide [PDF] - Page not found
Quick Start Guide [PDF] - Page not found
Technical Reference Guide [PDF] - Page not found
User Portal Guide [PDF] - Page not found (because of incorrect URL, otherwise content is installed on system)

*) Missing CSS files (404 Not Found):
- /ovirt-engine/docs/manual/chrome.css
- /ovirt-engine/docs/manual/db4.css
- /ovirt-engine/docs/manual/RedHat/en-US/css/brand.css
- /ovirt-engine/docs/manual/print.css
- /ovirt-engine/docs/manual/site_overrides.css

All links to the [PDF] documents are invalid.

List of installed documentation - rhevm-doc-3.4.0-1.el6eng.noarch:

# ls -1 /usr/share/doc/rhevm-doc/manual/en-US/html/
Administration_Guide
Installation_Guide
Manager_Release_Notes
Technical_Guide
User_Guide

# ls -1 /usr/share/doc/rhevm-doc/manual/en-US/pdf/
Administration_Guide
Installation_Guide
Manager_Release_Notes
Technical_Guide
User_Guide


Version-Release number of selected component (if applicable):
rhevm-3.4.0-0.12.beta2.el6ev.noarch (av5)
rhevm-doc-3.4.0-1.el6eng.noarch
rhevm-branding-rhev-3.4.0-0.3.beta1.el6ev.noarch


How reproducible:
100%

Steps to Reproduce:
1. Open the welcome page (at /ovirt-engine/) and go through links in Documentation section.
2. 
3. 

Actual results:
Most of the links are broken (HTML and PDF), see description for details.

Expected results:
All documentation links to HTML and PDFs point to valid page or document. The HTML content is displayed correctly, i.e., no CSS or so is missing.

Additional info:

Comment 1 Pavel Novotny 2014-04-01 10:23:19 UTC
Feel free to adjust to correct BZ component, I used the general ovirt-engine-backed, because the missing files relate probably to documentation content (or maybe to wrong URL routing) and wrong URLs are defined in RHEV branding.

Comment 5 Pavel Novotny 2014-04-07 10:58:29 UTC
After re-evaluating this issue in av6, I don't experience problems with the documentation any more. It seems the latest branding and documentation packages are on the right track again.

Installed packages (all from av6 build):
rhevm-3.4.0-0.13.beta3.el6ev.noarch
rhevm-doc-3.4.0-2.el6eng.noarch
rhevm-branding-rhev-3.4.0-0.5.beta3.el6ev.noarch

The Documentation section on welcome page (/ovirt-engine/) now looks:

*Documentation*

Administration Guide [PDF] (/ovirt-engine/docs/manual/en_US/html/Administration_Guide/index.html)
Installation Guide [PDF] (/ovirt-engine/docs/manual/en_US/html/Installation_Guide/index.html)
Technical Guide [PDF] (/ovirt-engine/docs/manual/en_US/html/Technical_Guide/index.html)
User Guide [PDF] (/ovirt-engine/docs/manual/en_US/html/User_Guide/index.html)


The 'Guide' links in User Portal point to:

User Portal (Basic view): /ovirt-engine/docs/manual/en_US/html/User_Guide/chap-The_Basic_Tab.html

Power User Portal (Extended view): /ovirt-engine/docs/manual/en_US/html/User_Guide/chap-The_Extended_Tab.html


The 'Guide' link in Webadmin portal points to: /ovirt-engine/docs/manual/en_US/html/Administration_Guide/index.html (i.e., the same location as on welcome page)


All links to documentation pages and PDF files are valid and the documentation content is displayed corrently, i.e., no missing images, CSS, ...

All documentation guides are titled "Red Hat Enterprise Virtualization 3.4 Beta".


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