| Summary: | Docs: Reference Guide | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise Portal Platform 5 | Reporter: | Scott Mumford <smumford> | ||||
| Component: | unspecified | Assignee: | Scott Mumford <smumford> | ||||
| Status: | CLOSED NEXTRELEASE | QA Contact: | |||||
| Severity: | high | Docs Contact: | |||||
| Priority: | high | ||||||
| Version: | unspecified | CC: | chris.laprun, epp-bugs, mposolda, mvanco, smumford, vrockai | ||||
| Target Milestone: | --- | ||||||
| Target Release: | 5.1.0.Docs.GA | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| URL: | http://jira.jboss.org/jira/browse/JBEPP-517 | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | Bug Fix | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2010-12-11 05:59:55 UTC | Type: | Task | ||||
| Regression: | --- | Mount Type: | --- | ||||
| Documentation: | --- | CRM: | |||||
| Verified Versions: | Category: | --- | |||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||
| Bug Depends On: | 793373, 793436, 793499, 793539, 793544, 793606, 793607, 793608, 793610, 793611 | ||||||
| Bug Blocks: | 793372 | ||||||
| Attachments: |
|
||||||
|
Description
Scott Mumford
2010-09-30 03:31:50 UTC
Link: Added: This issue is a dependency of JBEPP-455 Link: Added: This issue depends JBEPP-456 Link: Added: This issue depends JBEPP-541 Typo: Section 2.7.1: First sentence: Should either be "A new portal skin will need to be..." or "New portal skins will need to be..." Typo: Section 2.7.2.1: Second sentence: It contains a couple typos and I think it should be two sentences: e.g. "Window styles can belong in a window style category. This category and the window styles will need to be specified in the resources file." Link: Added: This issue depends JBEPP-580 Typo: Section 2.7.2.1: Second paragraph: The XML filename should be "gatein-resources.xml" (The "s" is missing) Error: Section 2.7.2.2: The previous section defines MyThemeRed and MyThemeBlue as themes in the "MyTheme" category. But then in this section the CSS files discuss how to define "MyTheme" as if it is a theme. It's quite confusing because the actual styles defined in the CSS files should be for "MyThemeRed" and "MyThemeBlue". Typo: Section 2.7.2.3: First sentence: Missing the word "need", should be "..., you will need to specify the CSS classes for a theme..." Typo: Section 2.7.3.1: First sentence: Should be "Each portlet can be registered by a unique icon..." Section 2.7.3.1: Second sentence: Why is "webapplication" one word and bold font? I think that sentence should read: "This icon can be changed by adding an image to the following directory of the <bold>web</bold> application:" What is even more confusing about this sentence is that the directory shown does not exist. And then the next sentence shows an example of an image placed in a different directory. This makes me think the above-mentioned directory should be: skin/DefaultSkin/portletIcons/portlet_name.png where "portlet_name" is the name of the portlet in portlet.xml. That would make the example consistent with the explanation. Typo: Page 30: Second paragraph should be: Each application references a portlet using its application name (usually the name of the WAR file) and a portlet reference (the name of the portlet as defined in portlet.xml). Comment: Page 35: The key=value example for the French file is kind of confusing because the French version is the same as the English version: javax.portlet.title=Portlet Navigation It would be a more interesting example if you went with a different language, like the Spanish version (which also demonstrates the use of a unicode character): javax.portlet.title=Portlet de Navegaci\u00f3n Typo: Page 37: Bullet number 3: The term "java" should be capitalized. Typo: Sec 7.5.1: First sentence - "specifications" should be singular Commnet: Page 41: The last two paragraphs right *before* the Section 8.1 heading: The two paragraphs contradict themselves. The first paragraph talks about the case of a PortalRequestContext. Then the next paragraph starts "In the case of a different context such as PortalRequestContext..." which is confusing since that is not a different context. I tried to figure out what context this second paragraph might be referring to, but I couldn't find anything. Comment: Sec 8.2: The first sentence doesn't read well because of the hyphen. The "-lt" is important in that sentence! It would read better if the hypen didn't cause a line break. Typo: Page 42: Example 2 has a typo. There is an extra ">" right before orientation=rt. Typo: Section 10.1: Third paragraph: Second sentence should start: For example, an application subscribed to... Typo: Section 11.2.1: The second paragraph has two periods at the end. Typo: Page 57: Note #2: There should be a space between "GenericPortlet" and "render". Typo: Page 63: Note #3: Second sentence: The term "action parameters" should be the singular "action parameter". Typo: Section 11.2.2.4: Fifth paragraph: First sentence should start with "The other differences when..." or the verb "are" should be changed to "is" if "difference" is singular. The above typos and errors have been corrected. pg 69: Middle of the page: Paragraph starts with "The request parameters are maintained in the"bridge request scope". Notice there should be a space between *the* and "bridge request ...". pg 70: The description of the "DEFAULT" RenderPolicy has an extra "and" in the first sentence, and the I.e. part in the 2nd sentence needs a comma. I think the correct punctuation is "...using default behavior, i.e., as if DEFAULT is set." Section 12.3.1.5: First sentence: "Jboss" should be "JBoss", plus remove the "a" after the word "with". pg 74: First paragraph: Should be "While future versions *of* the 2.0 bridge..., at the *moment* you must dispatch..." Section 12.3.4.2.1: Third sentence: "This feature can be *used* to present a ..." pg 76: First sentence: "..., you can see a very simple *implementation* of a Map object..." pg 76: The code sample "#{resource['/img/the-path-to-my-image.png']}" is confusing because it refers to the /img directory but the previous sentence mentions the 'images' directory. It might be better understood if the code sample was "#{resource['/images/the-path-to-my-image.png']}".
Section 12.4.7.1: The word "statefull" should be "stateful" in the short sentence between the two code samples. Section 12.4.9: First sentence: The comment in parentheses is really an example but the wording "that is" is confusing. How about "To link to a non-JSF view (for example, jboss.org) you can use the following..." Section 13.1: This is just a comment so I don't forget - the entire section 13.1 is a lot of screen shots with no explanations of what they mean. We should probably add some text to explain what is happening in the screen shots. I can do this if you want me to. Section 13.2.1: Second paragraph: First sentence: "An example would *be* hosting the portal from..." Section 13.2.2.1: This section doesn't explain very well how to use the key that is generated. As far as I can tell, the file key.txt needs to go in the /conf/gatein/gadgets folder of your profile. Also the first sentence is a little overstated. How about: "A file called key.txt has to be generated for a gadget server to be secure." But we would need someone in-the-know to verify that. Section 14.3.1: First sentence: We should say where this file is found: "The main configuration file is 02portal.war/WEB-INF/conf/organization/idm-configuration.xml." Page 99: Second paragraph: "MembrshipType" should be "MembershipType" Page 112: Right in the middle of the page - step 2: The word "modify" should be capitalized. Page 120: Step 2: Missing a period after the first sentence (between SPNEGO and Under) Page 121: First sentence: Should be "This *activates* the SPNEGO..." Rich, would you mind combining few comments together so that we get less emails? I currently get one email for every comment you make. Sorry! I had no idea. I was just trying to make it easier for Scott to keep track of his changes. I will put them all in as one comment next time. Pg 124: Inside the "Assumptions" note: Number 2 needs to be updated to WSRP 2.0.0 (I think?). Number 3 mentions EPP Version 5.0-GA. Does that need to be updated to 5.1? Section 15.4: Third paragraph: First sentence: "...is used to *accomplish* this." Page 126: Last paragraph: Missing a space between "the" and "org.gatein.pc.remotable". Page 130: Inside the "Values" note: Second sentence ends with a couple extra periods. Page 130: Paragraph that proceeds the "Values" note: First word should be "Enter". Section 15.6.3 has the same couple of paragraphs as Section 15.6.2.2 (exact copies of each other). These two sections need to be merged into one. Section 15.7.1.1: Second paragraph: Second sentence: "...a valid email and the *previous* email address is not..." Section 15.8.1: Second paragraph: First sentence: "...can be modified with *repsect* to whether..." Section 15.8.2: First sentence; "...register with it before providing access *to* its services." Page 141: Step 4: I think the "A" in "Add property" needs to be bold. Page 142: Inside "Note": Second sentence: "...deploy the policy implementation as *a* JAR file in the..." Page 145: Last sentence: "Exo" should be "eXo". (Never mind - this might take a while to change since it appears numerous times in this chapter.) Section 16.3.2: Fourth paragraph: "...type, and a method on *the* target component to use..." Section 16.4: Fourth paragraph: Sentence should end "...can be left empty." Page 150: Second paragraph: First sentence: "...defines one or more <property> *elements*, each of which..." Page 150: Paragraph following the first code sample: "...requires one or more <value> *elements*." Page 151: First paragraph: "...which is used for plain *Java* style object..." Page 153: Middle of the page: "The Unified servlet context and unified classloader are..." (No comma after *context*) Page 153: Following paragraph: "...archives, configured with *the* dependencies property..." Section 16.6: Second paragraph: Remove the comma after "...the original portal .war archives by adding a .war..". A comma there creates a pause that makes the sentence confusing. Section 16.7: End of fifth paragraph has some extra spacing (I think). The term "org.exoplatform.container.ExoContainerContext" is a single word. Page 155: End of third paragraph - same story: should be "org.exoplatform.container.web.AbstractFilter" Page 155: Paragraph following the "Note": First sentence: "...may also need access to portal information..." (remove the first *to*) Page 155: The following sentence has a semi-colon in the middle of it that should be removed. Section 17.2.1: Question: Why does the Portal Reference Guide discuss using eXo JCR *outside* of Portal, i.e., in standalone mode? (I'm only curious- there may be a good reason for it.) Page 160: Next to the last paragraph: Remove the comma after *with*. Same sentence: Replace "J2EE" with "JavaEE". Section 17.2.2: Same story as before: From what I can tell, this entire section is for the standalone mode of JCR. The config file that takes up pages 162 and 163 should be replaced with the EPP version of the file. (I can send that to you if you need it.) Page 168: Third paragraph: Should be "...with the following *Relational* Database Management...". (It's kind of funny how it reads now though!) Section 17.3.2: From my understanding, this entire section refers to the standalone mode of JCR only, not EPP. I could be wrong though. The config file shown on pages 169-170 looks nothing like the EPP one. Page 171 and 172: Can you define your own JCR workspaces in EPP? I am either lost or confused at this point. If this information stays in the Reference Guide, then we need a use-case to explain why we would do this. Section 17.3.3: I don't know if this is EPP either. If it is, I can't find these config files so we should clarify where they are. Page 190: Within the "Note" is a reference to the /webapps folder, which is Tomcat. Just take off "/webapps". Section 17.10.1.1: Section title - "Jboss" should be "JBoss" No Release Note Required: JIRA pertains to documentation not product Release Notes Docs Status: Added: Not Required Thanks for the excellent feedback Rich. All the typos and errors you mentioned have been corrected. I'm emailing you some issues you raised that need more in-depth discussions. Page 150: Section 17.2 - Step 1 - Typo - "...with the DTD file above and the either the example configuration...". Page 150: Section 17.2 - Step 3 - Correction - "K or KB for kiloBytes" - Should be lowercase "k or kb" as is the norm for kilobyte. Also, the example for this on page 151 shows "KBytes" which is not indicated as a value in step 3. Page 155: Suggest font change (courier or at least bolded) for the values in the example for clarity. ex. "read;:/admin read;......" Page 155: Default value shown at bullet 29 runs off page on PDF. Page 157: "There are pre-configured configuration files for HSQLDB". - HSQL not listed in table above but is referenced here. I know that HSQL and H2 are not supported in production, but they do have a use OOTB during dev or at least when getting acquainted with EPP. Suggest at least calling this out. Page 158: Section 17.3.3 - Steps 2 and 3 - Suggest bolding the parameter names for clarity. Link: Added: This issue depends JBEPP-618 Link: Added: This issue depends JBEPP-623 Some notes and comments I am seeing in reference guide: Chapter 4 - Default portal configuration 4.1 - There is confusion when talking about "portal" and it means two different things here. I thing it would be better to use "portal container" where it make sense. So it can be better to use "There may be multiple independent portal containers..." or "Each portal container is internally composed of one or more portals". 4.2 - In sentence "Components, component-plugins, and init-params are explained in a later chapter of this document." can be link to "Chapter 15 - Foundations", where is this described. Chapter 5 - Portal default permission configuration 5.1 - Description seems to be correct but attached configuration file is old. Types "mandatory.group" and "mandatory.mstypes" are missing in configuration file and instead of it there is "access.control.workspace", which does not exist in EPP 5.1 5.2 - Reference to "access.control.workspace.roles" , which is probably does not correct as well. Chapter 6 - Portal navigation configuration - 6.2 - "Subpages" paragraph - I think it should talk about 'subnodes' or 'sub-navigation nodes' instead of 'subpages' . There is confusion among nodes and pages when term "subpages" is mentioned. - pages.xml section - There is mention about container tag, but it will be better to add some practical example of it. Or at least reference to file 02portal.war/WEB-INF/conf/portal/portal/sharedlayout.xml where container tags are used. Chapter 7 - Internationalization configuration 7.1 - There is mentioned that in Spanish file is "javax.portlet.title=Portlet Navigation" But this is not true because it's in english file. Spanish localization has : "javax.portlet.title=Portlet de navegaci\u00f3n" Chapter 8 - RTL In the first page and in 8.1 section are mentioned webui objects and terms like "UIPortalApplication", "RequestContext", "Groovy templates" or "Groovy binding context" but there is no other overview of WebUI or Groovy templates in the previous or next chapters of reference guide. So I am not sure if it makes sense to mention it here. Reader of reference guide might be little lost when he is reading this chapter. It seems that this chapter was copied from exo wiki from http://wiki.exoplatform.com/xwiki/bin/view/Portal/Right%20To%20Left%20Framework but other WebUI chapters were removed from EPP reference guide and this part still remains here without any context. 8.2 - It seems that location web/skin/portal/... etc. should start with "web.war" instead of "web" . 8.3 - There is incorrect location, which starts with nonexisting application "GateInResources". I think that correct path should be "01eXoResources.war/skin/DefaultSkin/webui/component/UITabSystem/UITabs/background/NormalTabStyle.gif" instead of it Chapter 16.6 (JBoss cache configuration in eXo JCR) Main issue here: This chapter is copied from eXo JCR documentation ( http://docs.jboss.org/exojcr/1.12.4-GA/developer/en-US/html_single/#JCR.JBossCacheConfigurationTemplates ) but I am not sure if it makes sense in EPP5 reference guide. I believe it can be better to mention how JBoss cache configuration for JCR is performed in EPP5. For example: - Mention that configuration of JCR workspaces and their caches is in server/<PROFILE>/deploy/gatein.ear/02portal.war/WEB-INF/conf/jcr/repository-configuration.xml - Mention that parameterized configuration ${...} is replaced by parameters from server<PROFILE>/conf/gatein/configuration.properties - Mention that actual JBoss cache and jgroups configuration is located inside jar file: server/<PROFILE/deploy/gatein.ear/lib/exo.portal.component.common-<VERSION>.jar#/conf/jcr/jbosscache/${gatein.jcr.config.type} where ${gatein.jcr.config.type} is taken from configuration.properties and can have value "local" or "cluster". 16.6.3 - I don't understand the number links and sentences like "Insert the appropriate cluster name at jbosscache-cluster-name" . I think that nobody should directly edit jboss cache configuration file, because paremeterized value is automatically replaced by current cluster name for paticular workspace, which is configured in repository-configuration.xml . Chapter 16.7 (LockManager configuration) Similar problem as for 16.6. This is talking about stanalone JCR but not about JCR in EPP context. For example: It can be mentioned that EPP configuration is in repository-configuration.xml and LockManager implementation in EPP is CacheableLockManagerImpl etc. some of my catches (not only bugs, some feature requests, too) from http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5/pdf/Reference_Guide/JBoss_Enterprise_Portal_Platform-5-Reference_Guide-en-US.pdf to consider : p80 - Predefined users are in the "user" field (and not "membershipType" as mentioned). p81 - In configuration snippet, there is value "/user" in "groupId" field. it should be (and is in actual config file) "/platform/users". Since this is only an example it is not literary a bug, but can be misleading. The snippet should have some description (like that it is again from the organization-configuration.xml file). Also I would suggest adding more content and changing the title, because by term "monitor" I would expect something not able to do write actions (like adding a user to group). p82 - In the path string "JBOSS_ASserver" used, I think "JBOSS_HOME" would be better. There are more issues with the path format in the reference guide, some unifying format for path should be considered (distinguishing the variable parts from other parts). p85 - hibernate.annotations and hibernate.mappings are missing the name of encapsulating element (which is "values-param"). Also apiCacheConfig and storeCacheConfig are missing the same thing (but for those it is "value-param").\ p144 - In path at the bottom of the page, there is a typo in "PROFIL" string and again the path has other format as before. p145 - Why is an ordered list used in this page? Workspace "system" is missing description. In example about number formats string "KBytes" is used, but it is not listed as a value in the list above, the same problem is in time formats. This whole part looks kind of awkward (i.e. step 2). I would rather suggest describing parts of configuration file. p147 - On the bottom the word "filesystem" is written with capitals "FileSystem". p150 - Value CAS internal data type class name exceeds the page margin. JCR index configuration file path is in other format again. p151 - The index-dir description is referring to "version 1.9" but doesn't say what is the subject of the version (it is eXo JCR). Even in other description when referring tho "JCR" version, it should be "eXo JCR". p152 - in errorlog-size row I believe the size is in bytes, so the lowercase "b" should be changed to uppercase "B". p154 - Again referring to version, "eXo JCR" should be prepended. p155 - Bottom of the page a typo in "You". p159 - Center of the page a typo in "You". p160 - The description of properties in examples would be nice. The above issues have been addressed in version 1-1.19 of the Reference Guide. One issue requires more information to resolve: Re Marek's comment: "5.2 - Reference to "access.control.workspace.roles" , which is probably does not correct as well." NeedInfo: I don't know what the correct code is here. "access.control.workspace.roles" appears in 5.0.0 portal-configuration.xml, but not as shown in code example. "access.control.workspace.roles" does not appear in 5.1(ER04) file at all. Can anyone let me know what the correct code sample(s) would be ( I need to cover both 5.0 AND 5.1.)? See the attached text file for info about the resolution of other issues. https://jira.jboss.org/secure/attachment/12339012/Feedback-action.txt Attachment: Added: Feedback-action.txt To 5.2 comment: When looking to sources of class UserACL.java and PortalACLPlugin.java, I am seeing that PortalACLPlugin can be used only for override configuration of two parameters:
- super.user
- portal.creation.roles
So parameter "access.control.workspace.roles" is not correct anymore. I checked for both 5.1 branch and 5.0.0.GA tag. So I think that docs can be updated for both 5.0 and 5.1. Parameter "access.control.workspace.roles" was probably used in some old release of GateIn or eXo portal. I think that correct PortalACLPlugin configuration can look like this in EP 5.0 or EPP 5.1:
<external-component-plugins>
<target-component>org.exoplatform.portal.config.UserACL</target-component>
<component-plugin>
<name>addPortalACLPlugin</name>
<set-method>addPortalACLPlugin</set-method>
<type>org.exoplatform.portal.config.PortalACLPlugin</type>
<description>setting some permission for portal</description>
<init-params>
<values-param>
<name>super.user</name>
<value>root</value>
</values-param>
<values-param>
<name>portal.creation.roles</name>
<value>*:/platform/administrators</value>
<value>*:/organization/management/executive-board</value>
</values-param>
</init-params>
</component-plugin>
</external-component-plugins>
Thanks Marek, I've updated the code sample as you suggested. some typos i've found in actual version: p80. in newly insterted "values-param" and "value-param" are not in parenthesis p93. typo in the "You" word - Y is missing p141. the is a capital letter used in package name org.eXoplatform... p145. typo in <field> - "f" is missing 8.1.4 Locale Policy configuration - I think that "GateIn Kernel" should be replaced with "eXo Kernel" p84 - fields for group are name, parentId, description, label p86 - new.user.event.listener configuration file - it is syntactically correct, but should be copied from the actual EPP files "ignoredUser" name are other in actual EPP config file. p87 - autologin-configuration.xml should be updated, too. in actual EPP conf file there is a new value "autologin". p88 - idm-configuration.xml needs to be updated as well. i.e. config value in actual EPP is <value>war:/conf/organization/picketlink-idm/picketlink-idm-config.xml</value> and there are much more value-param elements in it. p89 - org.exoplatform.services.organization.OrganizationService should be updated, too. there are much more fields in acutal configuration and everything is nicely commented, i guess that comments can be used in docuemtnation as field description. p92 - the configuration file listed is not part of EPP, i guess the file "picketlink-idm-config.xml" should be listed there with the path to that file 02portal.war/WEB-INF/conf/organization/picketlink-idm-config.xml p140 - kernel_1_0.xsd should be kernel_1_1.xsd (same for all other matches in the doc) p143-144 - confgis should be updated from 02portal.war/WEB-INF/conf/common/common.configuration.xml p158 - repository-configuration.xml differs from actual content VIlliam; I can't locate the typos you outlined (I think the page numbers are different in the version you looked at). p93. typo in the "You" word - Y is missing p145. typo in <field> - "f" is missing Can you give me the section title and possibly some surrounding text to make searching easier please? Thanks. Villiam: Are you sure about changing all instances of kernel_1_0.xsd to kernel_1_1.xsd? I grepped the jboss-epp-5.1 instance I have locally and numerous hits for kernel_1_0.xsd were found in the 02portal.war files VIlliam: RE: p143-144 - confgis should be updated from 02portal.war/WEB-INF/conf/common/common.configuration.xml The code sample on pages 143 and 144 of the PDF I have refers to web.xml and doesn't resemble the code in common-configuration.xml at all. Can you provide a section heading and some surrounding text to ensure I'm seeing the same code sample as you, please. hi Scott, i was using pdf from this address http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.1/pdf/Reference_Guide/JBoss_Enterprise_Portal_Platform-5.1-Reference_Guide-en-US.pdf i don't see the typos anymore - it seems that i was looking at older doc version, when i was making that comment ("you" and "field" typos) i'm going to check the rest of your comments i have greped the code snippets and checked the config files again and kernel 1_0 should be changed to 1_1 here: p88 (idm-configuration.xml) p141/142 (02portal.war/WEB-INF/conf/configuration.xml) p142/143 (hib. service 02portal.war/WEB-INF/conf/organization/idm-configuration.xml) p143/144 (02portal.war/WEB-INF/conf/common/common-configuration.xml) i'm not sure about (seems that it could be still kernel 1_0) p145 p140 (portal container) about common-configuration.xml - i've got it starting on p143 and the section is called "16.4. InitParams configuration element", i've found very similar contents in 02portal.war/WEB-INF/conf/common/common-configuration.xml i've found a problem with colors. in pdf version, screenshots on page 1 and 2 are blue instead of red (they are red in html version) Thanks for the extra info Viliam. All above issues have been actioned. Scott, there are some comments for WSRP part of Ref.Guide: WSRP part - chapter 15 15.6.1 - self consumer does not exist anymore, there are two default consumers: selfv1, selfv2 15.6.2.1 - EPP 5.1: Accessing the Configuration Portlet: there can be also written that it's now as a group page for /platform/administrators - it is not clear from link 15.6.2.1.1 - creating a consumer: last 2 screenshost are not updated, displayed wsdl doesn't exist, /v1/ or /v2/ must be used in URL 15.6.4 - 'configuration of the self producer' -> 'configuration of the self producers' (there are two self producers in config file) - comments says: cache expiring every five minutes and with a 30 second timeout for web service operations -> then example config should contain: <wsrp-producer id="selfv1" expiration-cache="300" ws-timeout="30000"> and <wsrp-producer id="selfv2" expiration-cache="300" ws-timeout="30000"> (5 -> 3) 15.7.1.1 - point 1. instead ofexample -> instead of example (space missing) - point 3. wrong url of consumer on screenshot 15.7.1.2 - all screenshots has wrong url of consumer 15.7.2.1 - Procedure 15.3, point 3. 'View' has red color, should be black and bold - Procedure 15.4, note with blue ball is badly alligned, some text is over the image (seems like green Node header is missing) Section "2.6 The default skin" - Minor typo in WAR name. There is "01eXoResource.war" but should be "01eXoResources.war". Section "2.7.4. Create New Portlet Specification CSS Classes" - Minor typo in WAR name. There is eXoResources.war but should "01eXoResources.war". Section "3.3. The Command Servlet" - i think that it's not clear from the ref.guide that CommandServlet is automatically added during deployment of each portlet application and injected as servlet in this application. I also think that first sentence needs some review: "The servlet is the main entry point for incoming requests, it also includes some init code when the portal is launched. " . Main entry point for HTTP requests to portal is PortalController servlet. CommandServlet is called by portlet container for particular portlets. I believe that whole section 3.3 needs some more review to be more clear and more technically accurate. Reminder that these chapters and sections still have notes about technical review needed after QE feedback: - Chapter 9. Right To Left (RTL) Framework - 17.6. JBoss Cache configuration - 17.7. LockManager On the WSRP part of the doc: - Why is section 15.3.2 on a different page as the rest of the 15.3 section? - 15.5: the URLs there are actually incorrect. Both URLs only work in EPP 5.1. EPP 5.0 only has access to WSRP 1 but the URL is different: in EPP 5.0: http://{hostname}:{port}/wsrp-producer/MarkupService?wsdl. (WSRP 1 only) in EPP 5.1: WSRP 1: http://{hostname}:{port}/wsrp-producer/v1/MarkupService?wsdl. WSRP 2: http://{hostname}:{port}/wsrp-producer/v2/MarkupService?wsdl. - 15.6.2.1.1: it doesn't matter that the screenshots are not updated as the example is not specific to the self consumer. Plus, it's still correct in EPP 5.0 (even though, again, the point of the screenshots here are not to show the self consumer, but rather how the portlet behaves if the given registration information is invalid). - Why is section 15.6.3.2 on its own page instead of the same page as the rest of section 15.6.3? - 15.6.4: self producer -> selfv1 and selfv2 consumers - Procedure 15.3: screenshots are barely legible⦠@Michal: you should add your documentation on how to remove the WSRP admin portlet⦠The above comments have been actioned. @Michal; I followed Chris's comments that, although the screenshots are slightly outdated, they serve the purpose they're intended for. Regarding Section "3.3. The Command Servlet" :I updated the para to read as follows: The CommandServlet is called by the portlet container for requests to particular portlets. It also includes some init code when the portal is launched. This servlet (org.gatein.wci.command.CommandServlet) is automatically added during the deployment of each portlet application and mapped to /gateinservlet. Is that more technically accurate? @Chris: Re the page placements. Were you looking at a chunked html version? This has to do with Publican's default chunking of sections. I can adjust that if needed, but it doesn't seem to be too much of a problem this close to release. Closing this JIRA as EPP core docs development is stopping for the 5.1.0 release. For minor issues, please open a JIRA against EPP 5.1.1. Only re-open this JIRA for blocker or critical issues. Re: chunking of sections. It's minor but it looks a little weird. Agreed on letting it as it is for now but worth looking into it for 5.1.1. Hi Scott, there are last few comments for WSRP part of Ref.Guide: 15.3 Notational Devices - there is JBOSS_HOME defined and at WSRP_PATH is EPP_HOME used, change EPP_HOME -> JBOSS_HOME general: - on same places JBOSS_HOME/jboss-as/server/$CONFIG is used and on other places there is JBOSS_HOME/jboss-as/server/<PROFILE>, should be unified 15.6.4 - sorry for my previous comment, here should be selfv1 and selfv2 'consumers' and not 'producers' Thanks! Fixed. Thanks Michal! Link: Removed: This issue depends JBEPP-541 |