Greg Sheremeta has posted comments on this change.
Change subject: userportal, webadmin: use json for documentation mapping files
......................................................................
Patch Set 4: Verified+1
(6 comments)
> It is so simple to pass it as we pass any other information when we
> initialize the gwt application, using our existing mechanism at the gwt host
> servlet or when loading parameters.
Alright, I'll work with Alexander on getting this working, but I'll do it in a
separate patch. For now, I didn't add any additional hardcodes, so I didn't
make it worse :) I added a todo and I'll get to it this week.
Regarding the servlet, as I said before, the JSON lookup and merging has to
happen somewhere -- if not on the server, then on the client. If on the client,
I'd have to manually manipulate the JSON keys in GWT, where I don't have access
to real Java libraries. I think it's better on the server for this reason
alone. Saving requests is just a bonus. Thanks for your opinion -- let's agree
to disagree.
I think I addressed all your other concerns.
....................................................
File README.manual
Line 1: ovirt-engine manual
Line 2: =====================
Line 3:
Line 4: ovirt-engine supports context-sensitive help for various dialogs and
actions in the web applications.
Done
Line 5:
Line 6: To add context sensitive help, a few files need to be created.
Line 7:
Line 8: 1. <ovirt-engine-home>/manual/docsconfig.properties
Line 4: ovirt-engine supports context-sensitive help for various dialogs and
actions in the web applications.
Line 5:
Line 6: To add context sensitive help, a few files need to be created.
Line 7:
Line 8: 1. <ovirt-engine-home>/manual/docsconfig.properties
Done, but I don't understand why it's called DOC_PACKAGE, or why it's installed
to /usr/share/doc
Line 9: This file should contain two keys, helptags.webadmin and
helptags.userportal, that contain the location of helptag-mapping JSON files.
Line 10:
Line 11: Example docsconfig.properties file:
Line 12: ----------------------------------
Line 5:
Line 6: To add context sensitive help, a few files need to be created.
Line 7:
Line 8: 1. <ovirt-engine-home>/manual/docsconfig.properties
Line 9: This file should contain two keys, helptags.webadmin and
helptags.userportal, that contain the location of helptag-mapping JSON files.
Done
Line 10:
Line 11: Example docsconfig.properties file:
Line 12: ----------------------------------
Line 13: # comma-separated list of json files (relative to this file) that
contain documentation mappings for webadmin and userportal
Line 8: 1. <ovirt-engine-home>/manual/docsconfig.properties
Line 9: This file should contain two keys, helptags.webadmin and
helptags.userportal, that contain the location of helptag-mapping JSON files.
Line 10:
Line 11: Example docsconfig.properties file:
Line 12: ----------------------------------
Done
Line 13: # comma-separated list of json files (relative to this file) that
contain documentation mappings for webadmin and userportal
Line 14: # example: helptags.webadmin=common.json,webadmin.json
Line 15: helptags.webadmin=common.json,webadmin.json
Line 16: helptags.userportal=common.json,userportal.json
Line 12: ----------------------------------
Line 13: # comma-separated list of json files (relative to this file) that
contain documentation mappings for webadmin and userportal
Line 14: # example: helptags.webadmin=common.json,webadmin.json
Line 15: helptags.webadmin=common.json,webadmin.json
Line 16: helptags.userportal=common.json,userportal.json
it does. I'll add unit tests.
Line 17:
Line 18: 2. JSON files corresponding to the above properties file -- so, using
the sample, common.json, webadmin.json, userportal.json.
Line 19: These files should contain one object, each key is a helpTag, and each
corresponding value is a help URL.
Line 20:
Line 19: These files should contain one object, each key is a helpTag, and each
corresponding value is a help URL.
Line 20:
Line 21: Example common.json file:
Line 22: ------------------------
Line 23: { "create_new_vm": "/manual/some/help/document.html", "delete_vm":
"/manual/another/help/document.html" }
Done
Line 24:
Line 25: These helpTags ("create_new_vm", "delete_vm") are found in the Java
code Model objects. Dialogs and other actions work with
Line 26: Models, so we use the Model attribute helpTag to wire up
context-sensitive help.
--
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: 4
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
