Bug 1002353

Summary: error message in engine.log regarding a 404 response when attempting to read "/doc/ovirt-engine/manual/DocumentationPath.csv"
Product: [Retired] oVirt Reporter: Einav Cohen <ecohen>
Component: ovirt-engine-webadminAssignee: Greg Sheremeta <gshereme>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: unspecifiedCC: acathrow, alonbl, ecohen, iheim, knesenko, mgoldboi, sbonazzo, yeylon, ykaul
Target Milestone: ---   
Target Release: 3.3.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: ux
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-11-25 11:56:07 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Einav Cohen 2013-08-29 01:35:24 UTC 
Description of problem:

oVirt supports a context-sensitive help infrastructure: if a dialog-id-to-URL mapping is supplied within "http://[engine-server]/doc/ovirt-engine/manual/DocumentationPath.csv", a question-mark ("?") icon will appear in each dialog next to its title, and clicking it will lead to the relevant URL in the mapping.

[same goes for user portal and a file called "UserPortalDocumentationPath.csv"]

this file (and the entire documentation, for that matter) doesn't necessarily exist.

we should make the documentation base path brandable (and have it empty for oVirt by default, as oVirt doesn't have built-in documentation at the moment). the web-admin (and user portal) will check in run-time if the documentation base path is empty, and if so -  it won't try to do anything related to documentation, e.g. try to retrieve the mapping [*.csv] files.
Comment 1 Alon Bar-Lev 2013-09-17 19:27:22 UTC 
Hello Einav,

Why do you see this as branding and not product configuration?

Branding is changing themes, specific strings etc...

I do not think that the documentation URI falls into that category...

Thanks,
Alon
Comment 2 Alon Bar-Lev 2013-09-26 09:21:17 UTC 
(In reply to Alon Bar-Lev from comment #1)
> Hello Einav,
> 
> Why do you see this as branding and not product configuration?
> 
> Branding is changing themes, specific strings etc...
> 
> I do not think that the documentation URI falls into that category...
> 
> Thanks,
> Alon

We are going into the configuration option, putting empty manual upstream.
Comment 3 Sandro Bonazzola 2013-11-25 11:56:07 UTC 
oVirt 3.3.1 has been released