Alon Bar-Lev has posted comments on this change.
Change subject: userportal, webadmin: use json for documentation mapping files
......................................................................
Patch Set 5:
(3 comments)
I believe that manual should be removed from Makefile and from spec file as
well as we no longer install any file.
....................................................
File README.manual
Line 5: actions in the web applications.
Line 6:
Line 7: To add context sensitive help, a few files need to be created.
Line 8:
Line 9: 1. /usr/share/doc/DOC_PACKAGE/manual/docsconfig.properties
where is the configuration of ENGINE_MANUAL?
I think better phrasing will be something more similar to:
OVERVIEW
--------------
ovirt-engine supports manual package for context sensitive help within
application. Manual package is not provided by base package and should be added
externally.
PREPARATIONS
---------------------
Provided the manual package name is DOC_PACKAGE the following steps should be
followed.
1. Prepare manual which are static html files,.
2. Create manual configuration file at docsconfig.properties within root of
manual, create lookup index files to map between help tag and URI, see format
bellow.
3. Package manual pages at DOC_PACKAGE to be installed into filesystem, for
example:
/usr/share/doc/DOC_PACKAGE/manual
4. Tell engine where manual is
/etc/ovirt-engine/engine.conf.d/20-DOC_PACKAGE.conf
ENGINE_MANUAL="/usr/share/doc/DOC_PACKAGE/manual"
MANUAL CONFIGURATION FILE
-----------------------------------
ovirt-engine will read the docscibfug.properties [[[[ AND I HATE THIS NAME AS
IT IS NOT docsconfig it is index or config or manual.properties or anything but
doc]]] located at the root of the manual content.
The format of this file is:
helptags.APPLICATION = [index1.json[, index2.json[, ....]]]
APPLICATION is the name of the application that issue the request, the value is
list of json files relative to configuration file that map between help tag and
URI, they content is merged left to right, last wins.
For format of index mapping file is a dictionary key is help tag and value is
uri relative to the package.
Example:
{
"create_new_vm": "newvm.html,
"delete_vm": "delvm.html,
}
The index file can be generated out of source code or compare to source code
using build/doctag.py tool available within engine source respository.
Line 10:
Line 11: The format of the properties file is:
Line 12:
Line 13: helptags.APPLICATION = <list of files>
Line 28: Example common.json file:
Line 29:
Line 30: {
Line 31: "create_new_vm": "/manual/some/help/document.html",
Line 32: "delete_vm": "/manual/another/help/document.html"
why not relative to manual?
Line 33: }
Line 34:
Line 35: These helpTags ("create_new_vm", "delete_vm") are found in the Java
code
Line 36: Model objects. Dialogs and other actions work with Models, so we use
the
....................................................
File packaging/etc/engine.conf.d/30-DOC_PACKAGE.conf
Line 1: ENGINE_MANUAL="/usr/share/doc/DOC_PACKAGE/manual"
why do you added this file? oh.... I meant to document this... not to add it.
--
To view, visit http://gerrit.ovirt.org/21392
To unsubscribe, visit http://gerrit.ovirt.org/settings
Gerrit-MessageType: comment
Gerrit-Change-Id: I4d6e8be143583d253943445842c2851fb52274e6
Gerrit-PatchSet: 5
Gerrit-Project: ovirt-engine
Gerrit-Branch: master
Gerrit-Owner: Greg Sheremeta <gsher...@redhat.com>
Gerrit-Reviewer: Alexander Wels <aw...@redhat.com>
Gerrit-Reviewer: Alon Bar-Lev <alo...@redhat.com>
Gerrit-Reviewer: Einav Cohen <eco...@redhat.com>
Gerrit-Reviewer: Greg Sheremeta <gsher...@redhat.com>
Gerrit-Reviewer: Vojtech Szocs <vsz...@redhat.com>
Gerrit-Reviewer: oVirt Jenkins CI Server
Gerrit-HasComments: Yes
_______________________________________________
Engine-patches mailing list
Engine-patches@ovirt.org
http://lists.ovirt.org/mailman/listinfo/engine-patches
