Hide Forgot
project_key: JBEPP Collective JIRA for current documentation issues, see the comments
Reference guide: in more places there is & instead of & 27.1.8. Adding New PropertyDefinition - missing text 30.1.1. JCR Configuration - in time formats there is or instead of for 39.4.1. Data container template - variable is missing description 39.4. Shipped JBoss Cache configuration templates jbosscache-data.xml - not found, maybe that should be emphased, that files and info from this chapters is related to the JCR package, and it's not a part of EPP package (or is it?). 41.3.2. - missing picture - broken url 41.4.1. Lucene tuning classes and packages not emphased in text 51.2.1. Implementation details note graphics looks bad 54.2. Statistics on the JCR API accesses broken link repository http://repository.jboss.com/maven2/org/exoplatform/jcr/exo.jcr.component.statistics. 62 broken link: * Tom Wheeler, The Java Content Repository (2007) Admin Guide: Example 2.3. URL Syntax < and > instead of < and > - I guess this would be more frequent issue and not in this doc only Example 2.6. Attributes first-name and last-name as request parameters & instead of & (same for 2.7, same for 2.11)
Reference Guide --------------- 3.2 A portal instance is simply a web application deployed as a WAR -> A portal instance is simply a set of web applications deployed as a EAR and WAR archives 3.3 GateInServlet class is incorrect org.gatein.wci.api.GateInServlet is correct It is possible to filter on the CommandServlet -> It is possible to filter on the GateInServlet Note: It is important to set INCLUDE as dispatcher as the portal will always hit the CommandServlet -> It is important to set INCLUDE as dispatcher as the portal will always hit the GateInServlet 4.1 There may be multiple independent portals deployed -> There may be multiple independent portal containers deployed 5.1 re-format config file - last 11 lines are moved right 6.1 and portal configuration is defined in {ownerType}.xml -> and portal configuration is defined in portal.xml 6.2 navigation.xml - current 5.2.0 portal contains nodes definitions with xml:lang (I think this is because new localization of nodes in UI) 6.4 add definition of serviceMangement gadget in gadget.xml <gadget name="ServiceMangement"> <path>/gadgets/ServiceManagement/ServiceManagement.xml</path> </gadget> 11. what about switch chapters 10 and 11? Chapter 9 is about localization and 11 is about xml resource bundles - there is no reason to have RTL between those 13.2.2 last sentence The argument is a request uri such as "/groups/:platform:administrators/administration/registry" -> The argument is a request uri such as "/g/:platform:administrators/administration/registry" General - there are few references to "eXo Portal" WSRP (Chapter 18) ---- 18.3.1 Of course, if you have modified you have modified the host name and port -> Of course, if you have modified the host name and port 18.4.1 there is a link to community wiki page how to configure SSL producer, but this one needs to be updated for GateIn 18.4.2.1 the consumer will act at the wss client -> the consumer will act as the wss client 18.4.2.4 3 options should start with same lowercase/uppercase missing dot after last sentence 18.5 there are some formatting problems in last 2 paragraphs - double spaces - value for theorg.gatein.pc.remotable - value set totrue - The NotRemotelyExposedPortlet , however 18.7.2 JBoss Enterprise Portal Platform provides a portlet to configure access (among other functions) to remote WSRP Producers grahically. -> JBoss Enterprise Portal Platform provides a portlet to configure access (among other functions) to remote WSRP Producers graphically. we'd have seen something similar to, after -> we'd have seen something similar to screenshot below, after 18.9.3 Since JBoss Enterprise Portal Platform does not currently support automated migration of portal data, the functionality that we provide as part of WSRP 2 is necessarily less complete than it could be with full portal support. - I think this is not true anymore because there is already portal support for migration - import/export
Migration Guide ---- 3.2.4 /portal/groups/:platform:administrators/administration/registry -> /portal/g/:platform:administrators/administration/registry 5 With Change 'EPP' to full name. 5.2 ? change this beginning of sentence 5.2 the portal may not answer and during login errors such as: ... May appear. -> the portal may not answer and during login there may appear errors such as:
Link: Added: This issue is related to JBQA-5579
Thanks for the feedback, gents. I've actioned the Reference Guide matters but there's still a few things to clear up: @Villiam; I think the 'or' in the time formats in 30.1.1. JCR Configuration is intentional. It's my understanding that, because the JCR supports human readable formats, either of the formats shown are valid. I've emailed Nickolas Filotto about the broken link to the eXo repository in 54.2. Hopefully he can assist to rectify. @Michal: re 6.2 navigation.xml: You say; "current 5.2.0 portal contains nodes definitions with xml:lang (I think this is because new localization of nodes in UI)". Sorry, but I don't know what you mean by this. re 18.9.3 (WSRP migration - import/export) The WSRP section is a direct port of the GateIn WSRP content written by Chris Laprun. I've emailed him with your comment so he can confirm and update the community doc if necessary. I'll port any changes he makes into EPP docs. Thanks again. I'll get onto the Migration and Admin Guides issues tomorrow.
In my opinion the JCR part is too long. I think, that only crucial and relevant parts should be the part of EPP reference guide. i.e. it's pointing to the example xml files which are not part of EPP bundle. I believe that this should be resolved similar way as picketlink (for more information, have a look at official JCR reference guide).
Linked issue for SP Installation Guide.
Link: Added: This issue relates to JBEPP-1433
Villiam, I completely agree. I've asked for some guidance as to what can come out of the JCR chapter a few times now. I'd love to cut it down. A lot. Can you give me some specifics? What happened with PicketLink? I'm not familiar with the strategy employed in that situation. Also, to what documentation are you referring when you say "official JCR reference guide"?
Scott, regarding 6.2. There is a new feature of 5.2 - you can dynamically internationalize navigation nodes in UI (Extended Label Mode) and it brought a change in navigation.xml. Now it looks like <node> <name>sitemap</name> <label xml:lang="en">SiteMap</label> <label xml:lang="fr">SiteMap</label> <label xml:lang="es">Mapa del Sitio</label> <label xml:lang="de">Seitenübersicht</label> <label xml:lang="it">Mappa del Sito</label> <label xml:lang="nl">Sitemap</label> <label xml:lang="pt-BR">Mapa do Site</label> <label xml:lang="ja">サイトマップ</label> <label xml:lang="ne">साईटम्याप</label> <label xml:lang="ru">SiteMap</label> <label xml:lang="ar">خريطة الموقع</label> <label xml:lang="ko">사이트맵</label> <label xml:lang="vi">Sơ đồ</label> <label xml:lang="zh">网站地图</label> <label xml:lang="zh-TW">網站導覽</label> <visibility>DISPLAYED</visibility> <page-reference>portal::classic::sitemap</page-reference> </node> And before it was like <node> <name>sitemap</name> <label>#{portal.classic.sitemap}</label> <visibility>DISPLAYED</visibility> <page-reference>portal::classic::sitemap</page-reference> </node> Of course previous approach still works, but I would recommend to use new one. Btw. it should be mentioned in User Guide as well (if it's not there already).
h5. Reference Guide * _14.2. Tutorials_ ** _It is also recommend_ -> _It is also recommended_ * _14.2.1. Deploying your first Portlet_ ** why is there a "Portlet" with capital "P"? * _14.2.1.3. Portlet Class_ ** the numbers in the code sample do not match the explanations below the sample (they are moved by one line) * _14.2.1.4. Application Descriptors_ ** the numbers in the code sample do not match the explanations below the sample (they are on wrong lines in the sample) * _14.2.1.1. Compiling_ ** in step 2: _gatein-simplest-helloworld-1.0.0-GA-SNAPSHOT.war_ -> _gatein-simplest-helloworld-5.2.0.GA.war_ * 14.2.2. JavaServer Pages Portlet Example ** _Compiling the example_, step 2: _gatein-jsp-hellouser-1.0.0-GA-SNAPSHOT.war_ -> _gatein-jsp-hellouser-5.2.0.GA.war_ * _14.2.2.2. Portlet Class_ ** the last two code samples have weird spacing (_UnavailableException_ on a new line in the method declaration) * _14.2.2.3. JSP files and the Portlet Tag Library_ ** the last sample of a page has weird spacing (the numbers divide render URLs to multiple lines, which is sort of difficult to read) ** _In the third method the action phase is triggered first then the render phase is triggered, which outputs some content back to the web browser based on the available render parameters._ - just a comma missing in the sentence * _14.2.2.4. JSF example using the JBoss Portlet Bridge_ ** Just a suggestion here. The section mentions JSR-301, which is Portlet Bridge 1.0 specification. The currently supported and probably more relevant is Portlet Bridge 2.0 specification - JSR-329. ** again, not all the numbers in the second code sample are placed on the relevant lines ** dot missing at the end of the description of _1_ * _15.1. Global Metadata Elements_ ** _ApplicationMonitoringFilter involves in request handling_ -> _ApplicationMonitoringFilter is involved in request handling_ * _16.1. JBoss Portlet Bridge Overview_ ** There is a long disclaimer about the non-final state of JSR-329. JSR-329 is already final (see http://www.jcp.org/en/jsr/detail?id=329) so it looks like the disclaimer is no longer necessary. * _16.3.4.2.1. Configuration_ ** it would be nice to have the link to the example pointing to the version of Portlet Bridge currently supported by 5.2, i.e. http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/seam/booking/ -> (http://anonsvn.jboss.org/repos/portletbridge/tags/2.2.0.GA.EPP520/examples/seam/booking/) * _16.4.1. Excluding Attributes from the Bridge Request Scope_ ** _foo.baz(wild-card)_ -> foo.baz. * _16.4.2. Supporting PortletMode Changes_ ** _render the \edit.jspx_ -> _render the /edit.jspx_
h5. User Guide * some screenshots don't match the details of 5.2 ** _Edit Portal's Config_ link at several places (see JBEPP-1073 from 5.1.1, should be also corrected in the text) ** _6.4.1.1. Adding a new Page using Page Creation Wizard_ *** all the screenshots in this section look different now *** navigation buttons in the _Page creation wizard_ are in reverse order now and there is no _Back_ button *** there are localized labels in the _Page creation wizard_ now
Link: Added: This issue relates to JBEPP-1441
h5. Migration Guide I think PortalLoginController should be mentioned in the Migration Guide. I created JBEPP-1441 for that since it's the addition of some new content. Scott, can you please have a look at it?
Hello, User guide: Chapter 2 – browser's versions actualization (ff 3.5 – 7, IE 7 – 9) Chapter 4 - subchapter 4.3.2 doesn't have any label 4.2 - Sitemap Portlet - wrong picture: in 5.2.0 isn't present “Expand All” link 4.3.1 - Four gadgets are provided by default with JBoss Enterprise Portal Platform, however you can add many more. → Seven gadgets are provided by default with JBoss Enterprise Portal Platform, however you can add many more. - picture of the Dashboard Workspace - pictures of: Calendar, Todo, Calculator, RSS Reader → wrong buttons of gadget windows - add pictures and descriptions for: Currency Converter, Export/Import Tool, Services Management 4.3.2 - picture of the Dashboard Workspace in step 4 and 5 - In sentence: “In the image below, the Currency Converter gadget has been added to the Dashboard, along with some of the default portal gadgets.” should be replaced the Currency Converter by any other non default gadget. - picture in step 6 - wrong buttons of gadget windows - Currency Converter is one of default gadgets since 5.2
The above issues have been rectified. @Vlastislav, Regarding the gadget/dashboard screenshots in 4.3.1 and 4.3.2: Neither the local EPP 5.2.0 instance I have or the shared instance at http://eppdev01.brq.redhat.com:8080/portal/classic/ show any difference from the images in the docs (still only four gadgets). I'll be happy to update the images if someone would forward new screenshots to me.
< Regarding the gadget/dashboard screenshots in 4.3.1 and 4.3.2: < Neither the local EPP 5.2.0 instance I have or the shared instance at http://eppdev01.brq.redhat.com:8080/portal/classic/ show any difference from the images in the < docs (still only four gadgets). You're rigth. I don't know why in my instance of epp5.2.0 was 7 default gadgets but now I've got only 4 too. So I'm updating 4.3.1 and 4.3.2: 4.3.1 - pictures of: Calendar, Todo, Calculator, RSS Reader → wrong buttons of gadget windows (minimalize, maximalize, etc. are in wrong order) 4.3.2 - picture in step 5 - wrong buttons of gadget windows (minimalize, maximalize, etc. are in wrong order) - picture in step 6 - wrong buttons of gadget windows (minimalize, maximalize, etc. are in wrong order) < I'll be happy to update the images if someone would forward new screenshots to me. Do you still need me to forward you new screenshots of the gadgets?
5.1 - User Name - This username must be between 3 and 30 characters long. → This username must be between 3 and 30 characters long, start with a character. And only alpha, digit, underscore, dash and dot is allowed for the username. - First Name - This name must be between 3 and 45 characters long. → This name must be between 1 and 45 characters long. - Last Name - This name must also be between 3 and 45 characters long. → This name must also be between 1 and 45 characters long. 5.2.1 - "If the user name does not exist or the user name and/or password is invalid an alert message will appear. To attempt the log in again; click the OK button on the alert message to be returned to the Sign In form. Enter the user name and password again." - instead of getting alert message, you'll be redirecting to Gatein signIn page (but I think that the behaviour described in docs is better than the current one) 6.2.1 - step 2 - picture of creation new portal - step 4 - Only alphabetical, numerical and underscore characters are allowed for this field and the name must have at least 3 characters. → Only alphabetical, numerical, dash and underscore characters are allowed for this field and the name must be between 3 and 30 characters. - between step 5 and 6 - There should be two new steps about Label and Description - step 7 - There should be added description about "Show info bar by default" checkbox 6.2.3 - second & third screenshon (Edit Inline Composer) - There should be Site's Config button instead of Portal Propeties - in green box Custom Portlets - I belive that there should be updated links to another documentations 6.2.5 - update second screenshot 6.3.1 - step 3 - update first screenshot - step 3 - in "Page Node Setting" section - add description for "Extended label mode" checkbox and "Language selector" - step 3 - in "Page Node Setting" section - Node name - Only alpha, digit and underscore characters are allowed for this field and it must have at least 3 characters. → Only alpha, digit, dash and underscore characters are allowed for this field and it must be between 3 and 30 characters. - step 3 - in "Page Selector" section - The second screenshot shows the page selector tab with selected page. In my opinion there would be better screenshot without selected page, because searching and selecting pages is mentioned below. Maybe there could be both screenshots. The screenshot without selected page at the begining and the screenshot with selected page below sentence "After selecting a page, the details of this page will be displayed in the Page Selector form.".
Hi Scott, unfortunately i'm not an authority to say which parts of JCR should and which shouldn't be in the EPP reference guide. i though, that the text in EPP reference guide was taken from some official JCR guide. and my idea was to point to it in similar manner like it is with picketlink: "This section does not provide information about PicketLink IDM and its configuration. Please, refer to the appropriate project documentation (http://jboss.org/picketlink/IDM.html) for further information." another point is that nobody from our (QA) team could review such a long and detailed section about JCR, we can provide only very basic review.
reference guide: 17.4.1. Configuration Files numbering in xml is wrong, the ServiceImpl part is in the lower part of xml and PicketLinkIDMOrganizationServiceImpl part is missing in the xml completely (but you can find it in the original xml file). the properties are wrong, too. like hibernate.* are properties of HibernateServiceImpl and so on. This should be corrected due to original xml file (02portal.war/WEB-INF/conf/organization/idm-configuration.xml) Chapter 22. JCR configuration The JCR configuration is defined in an XML file which is constructed as per the DTD below: (and the DTD is missing, seems to be and the end of 22.1.9. Lock Manager configuration) Table 24.1. Configuration parameters I'm afraid the list is incomplete, if i look into current repository-configuration.xml i can see parameters like: jgroups-configuration, jgroups-multiplexer-stack, jbosscaches-cluster-name, jbosscache-shareable, max-volatile-time, changesfilter-class it's explained in 30.1., but may be noted here, as well Procedure 25.1. driverliteral should be driverClassName Procedure 25.2. UR: / URL 26.2. Tree File Value Storage in code snippet the number "2" is on the left, in other snippets numbers are on the right (same for 29.1.2.)
h5. Developer Guide Some suggestions (just formal, mostly typos and weird sentence structures, the whole sentence is listed if there are more mistakes in a sentence): * _Chapter 2. Architectural choices_ (introduction) ** _decisions has to be made_ -> _decisions have to be made_ * 2.1. Identity server ** 1: _Tables names_ -> _Table names_ ** 2: _This solution is particularly adapted to_ -> _This solution is particularly adapted to_ (so that the prepositions hold and the rest of the sentence makes more sense) ** 2: _infrastructure that are_ -> _infrastructure that is_ ** 2: _multiple service_ -> _multiple services_ ** 2: _for very large set_ -> _for very large sets_ ** 3: _to implement the Picketlink IDM SPI to implement_ (sounds weird, probably should be restructured) ** _this is very useful when an LDAP infrastructure is provided but in a read-only mode_ -> _which is very useful when an LDAP infrastructure is provided in a read-only mode_ ** _Since the website may need to store additional information about users (such as his preferred language or skin), it can combine LDAP + Database, to retrieve users from LDAP but store additional properties in a database._ -> _Since a website may need to store additional information about users (such as their preferred language or skin), it can combine LDAP with database to retrieve users from LDAP and store additional properties in a database._ * _2.2. Storage_ ** _one of the combination_ -> _one of the combinations_ ** _during the very first startup of the website and then it is required that the database users has sufficient rights_ -> _during the very first startup of a website and then it is required that the database users have sufficient rights_ ** _a database server over another as long as it is part of_ -> _one database server over another as long as it is a part of_ ** _As said earlier content_ -> _As said earlier, content_ ** _instead of database, metadata about the files_ -> _instead of a database, whereas metadata about the files_ ** _Note that if the website is running on a cluster the filesystem will need to be accessible from all nodes and a NFS solution needs to be setup._ -> _Note that if the website is running on a cluster, the filesystem will need to be accessible from all the nodes and a NFS solution needs to be set up._ * _2.3. Cluster_ ** _to spend more time_ -> _spending more time_ ** _There is a cost associated to clustering (EPP 5.2 has some optimization when running on a single node) but the product is designed to linearly scale up so that same performance is added every time a new node is added._ -> _There is a cost associated with clustering (EPP 5.2 has some optimizations when running on a single node), but the product is designed to linearly scale up so that the same performance is added every time a new node is added._ ** _left aside_ -> _are left aside_ ** _replicate data_ -> _replicating data_ ** _etc_ -> _etc._ * _2.4. SSO_ ** _If the website is part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to put a Single-Sign-On solution in place among them._ -> _If a website is a part of a more global infrastructure with various components (the website being one of several), it may be in the benefit of users to use a Single-Sign-On solution._ ** _Summary_ - should be probably a header or something ** TODO note in the third bullet point ** unnecessary comma in the last bullet point ** Figure 2.2. - the image should be bigger since it is completely unreadable * _Chapter 3. Design choices_ ** _components of the architecture has been_ -> _components of the architecture have been_ * _3.1. Dashboards_ ** _, as each user will have the opportunity to design his own personal website, it comes_ -> _. Each user has an opportunity to design his own personal website, which comes_ (a new sentence) ** _and are still made_ -> _and are still being made_ ** _navigate the website_ -> _navigate through the website_ ** _, maybe_ -> _. Maybe_ (a new sentence there) * _3.2. JCR index replication for cluster setup_ ** _Lucene isn't cluster-ready but on a cluster_ -> _Lucene isn't cluster-ready, but on a cluster_ (comma) ** _to lose-up_ -> _to loosen up_ * _3.2.1. Standalone index_ ** _as soon as they are_ -> _as soon as it is_ ** TODO note in the figure * _3.2.2. Local index_ ** _This environment is easy to setup, each node keeps a local copy of the full indexes so that when a search is requested on a node, there is no network communication requested._ -> _This environment is easy to set up, each node keeps a local copy of the full indexes so that when a search is requested on a node, there is no network communication required._ ** _it requires to replicate_ -> _it is required to replicate_ ** _Also when a node is added it has to recreate it's own full index._ (commas missing) ** _it makes the startup of the new node faster but_ -> _which makes the startup of the new node faster, but_ ** TODO in the figure * _3.2.3. Shared index_ ** _all nodes. It requires_ -> _all the nodes. It is required_ ** _Advantages_ should be on a new line ** _Drawback_ -> _Drawbacks_ ** TODO in the figure * 4.1. Portal containers ** _two level of granularities_ -> _two levels of granularity_ ** _identity, with its own skin applied, set of pages_ -> _identity with its own skin applied to a set of pages_ ** _The biggest granularity is what is called "Portal Containers", a_ -> _The biggest granularity is in what is called "Portal Containers". A_ ** _Mapping_ -> _mapping_ ** broken URL (localhost...) ** _separate installation, note that_ -> _separate installations. Note that_ ** _The benefit over directly modifying the shipped files is that it will make the updates much easier (by just replacing the archives provided by EPP)._ ** Figure 4.1. - TODO note and the image is too small, should be resized * 4.1.1. Portal extension ** _each of them usually add services_ -> _which usually add services_ ** Figure 4.2 - TODO note and the image is too small and unreadable ** _located in: gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl it would be located in an extension such as_ -> _located in gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl, it would be in an extension at a location such as_ * _4.2. Visual identity_ ** _A portal visual identity will be made of the HTML produced by the result of the portal aggregation (the components that makes a page like columns, rows combined with the content produced by the portlets) and associated CSS files._ -> _A portal visual identity is made of HTML produced as a result of portal aggregation (the components that make a page like columns and rows combined with the content produced by the portlets) and associated CSS files._ ** _EPP allows to deploy multiple skins which consists of CSS files, it makes it possible to apply styling on the page compositions and components of a page (Portlets)._ -> _EPP allows to deploy multiple skins consisting of CSS files, which makes it possible to apply styling to the page compositions and components of a page (portlets)._ * _4.2.1. Customizing the login page_ ** _is showing up, that page can be customized by using an extension. To do so it would be_ -> _is shown and it can be customized by using an extension. To do so, it would be_ ** _include it in a portal extension such as_ * 5.1.1. Introduction ** _gadgets are those as defined_ -> _gadgets are defined_ ** _Within a portal it is possible to embed any OpenSocial gadget on a page or within the user dashboards, gadgets can be added to the application registry, or links can be added within the mini-composer (see the User Guide)._ -> _Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user's dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the User Guide)._ * _5.1.2. Developing Gadgets_ ** _The container offers an API for which the documentation_ -> _The container offers an API, the documentation for which_ ** _makes it easy_ -> _GWT makes it easy_ ** _Consequently GWT_ -> _Consequently, GWT_ * _5.2. Portlet Development_ ** _(JSR-286) (See the "Portlet Primer" chapter in the reference guide)_ (double brackets) ** _but it is also possible to use_ -> _, but it is also possible to use_ ** _, see the "Getting started with JBoss Portlet Bridge" chapter of the reference guide_ -> _(see the "Getting started with JBoss Portlet Bridge" chapter of the reference guide)_ (to be consistent)
@Vlastislav Thanks for the great User Guide feedback! :D re 6.2.1 Step 7: I tested setting the show info bar on and off, with root and mary, and I couldn't see any change that isn'ta attributable to the role change. So I don't actually know what this switch does. I've added a note that's it's there to the document, but can you provide an idea what it's supposed to do? Re 6.3.1 Extended label mode. I have no idea what it does. but I have included a space for it in the document. Can you provide a description? Thanks again.
@Viliam I've actioned your Reference Guide comments as best I can; I removed "17.4.1. Configuration Files" as there's not enough time before GA to correct all the idm-configuration.xml params (also, the content above says the doc does not go into IDM config and offers a link to community doc). I'll look at correcting this in the next cycle. Also, I changed "The table below outlines the Configuration Parameters available" at Table 24.1. Configuration parameters to read "The table below outlines /some/ the Configuration Parameters available" and added link to section 30.1. Again, time constraints. Thanks for the feedback.
I went through my commented parts of Ref.Guide (incl.WSRP) and there are still some minor corrections: 3.3 GateinServlet class wasn't changed in config file org.gatein.wci.api.GateInServlet should be used 6.2 encoding in navigation.xml is broken (I checked at pdf) 18.3 last paragraph ...it will not adversely affect your installation to leave it as-is. -> ...it will not adversely affect your installation to leave it as it is.
Link: Added: This issue relates to JBEPP-1437
Scott, re 6.2.1 Step 7 Create a portal with this checkbox checked: When you edit any page within a portal (or edit layout of the portal) and you add some portlet into a page. and when you edit the portlet, it will have Show info Bar checkbox checked. And this cause the portlet will have some kind of frame (info Bar). Here are steps to test this functionality: - create new portal with this checkbox checked - go to created portal -> Site Editor -> Edit page - add some portlet to page - click Edit portlet button of the added portlet - the Show Info Bar checkbox is checked - click cancel and finish - the portlet has info Bar - go to Site - click Edit Portal's Config link related to added portal - uncheck the "Show info bar by default" checkbox - go to Site Editor -> Edit page - add portlet to pade - click finish - the portlet has not info Bar
Re 6.3.1 Extended label mode. This is new feature. It provides possibility localize nodes. So if you have this checkbox checked adn you have for instace English Language you can write a Label for english. Then you can switch language to French and then write tha label for french and so on. And then when you are changing language of the portal the localized labels of the nodes are shown.
reference guide: 31.1.2. Template JBoss Cache Configuration async=q"false" in the test-jbosscache-lock.xml code.
@Michal Thanks. Fixed those few things. The PDF character encoding is working fine in local pdf builds, so it's something on the server end. Looking into a fix.
@Vlastislav Thanks so much for the info. I've added descriptions for those features.
User guide: 6.2.7 - Skins can be changed temporarily (and are reset at log-out) or permanently. -> That's not true: When you set skin by second way (Click on Site, then Edit Portal's Properties.) so this skin is set for this concreate portal, everybody who access this portal will see it in this skin. But when you change skin by first way (Mouse over the Start menu and click on Change Skin.) the skin is set for this concreate user and all portals within EPP will be shown in his skin. So when you don't change the skin by the first way you'll see all the portals with these portal's skins, but after first changing the skin by the second way since this moment you'll see all the portals in your specified skin. - step 2 - In my opinion there would be better screenshot with 2 skins at least. 6.3.2 - update second sceenshot - step 3 - In the Page Node Setting tab you can change the value of these fields: Label Visible Publication Date & time -> Extended label node Language Label Visible Publication Date & time 6.4.1.1 - step 4 - add description for Extended label mode and Language (this is the same as for 6.3.1 but for pages) - step 7 - I belive there should be "View Page properties" description (between Containers and Switch View mode) 6.4.1.2 - step 1 - screenshot - I belive there shold be portal in basic skin (the orange color doesn't seem good to me) - step 3 - Owner type - If the page Owner type is set to user, only the specified user (creator) can access and edit the page. -> user Owner type is not available in 5.2 so erase this sentence - step 3 - new screenshot - there is user Owner type - step 3 - Page Name - Only alphabetical, numerical and underscore characters are allowed to be used for this field and the name must be at least 3 and no more than 30 characters in length. -> Only alphabetical, numerical, dash and underscore characters are allowed to be used for this field and the name must be at least 3 and no more than 30 characters in length. - step 3 - Page title - If you choose to add a title to the page it must be at least 3 and no more than 30 characters in length. -> If you choose to add a title to the page it must be at least 3 and no more than 120 characters in length. 6.4.2 - step 2 - Click the edit icon to show a form to edit page properties. -> Click View Page properties icon to show a form to edit page properties. - step 3 - Permission Setting - sentence: "This form is supported for pages with group or portal ownership types. Because a user page is private, no user, other than the creator, can access or edit it." should be removed because user pages are not possible any more. - step 3 - Access right - The page Access right can be set to specific user groups or set to everyone (this includes unregistered users). -> Access right can be set to specific user groups or set to everyone (this includes unregistered users). - step 3 - Access right - Current access permissions on page are listed and you can remove permissions (by clicking the delete icon) or add further permission (by click the Add Permission button). -> Current access permissions on page are listed in <b>Access Pessmission Setting</b> tab and you can remove permissions (by clicking the delete icon) or add further permission (by click the Add Permission button). - step 3 - Edit right - If you want to re-assign this right to another group, click Select Permission to choose another one. -> If you want to re-assign this right to another group, click Select Permission in Edit Permission Setting tab to choose another one. - step 4 - Actually I don't understand what this step does mean. Because you are on the page where you can edit layout of the page after clicking the edit icon (mensioned in first sentence of step 2). And I cannot find Edit page icon (the 'page and pencil') 6.4.4 - step 1 and 2 - screenshots - there is Portal Properties button but there should be Site's Config 6.5.1.2 - above step 1 - I would add step 1 - Mouse over Group in the Toolbar. Highlight Organization and select Users and Groups Management 6.5.1.3 - step 3 - Change Password - Passwords must contain at least 6 characters and can contain letters, numbers and punctuation marks. -> Passwords must contain between 6 and 30 characters. 6.5.2.1 - step 2 - Description - Any length from 3 to 30 characters is allowed. -> Any length from 0 to 255 characters is allowed. - step 3 - Only letters, numbers and underscore characters are allowed for the Group Name field. -> Only letters, numbers, dash and underscore characters are allowed for the Group Name field. 6.5.3.1 - step 1 - Only letters, digits, dots, dashes and underscores are allowed for the membership name. -> Only letters, digits, dots, dashes and underscores are allowed for the membership name and it must be between 3 and 30 characters. 6.6.1 New Portals section - In my opinion the screenshot is useless here. Existing portals - Maybe useless screenshot too. 6.6.1.1 - update second screenshot - There is List Permission window but now it's named Select Permission - step 2 - Make the appropriate selections from the group and membership options presented in the Permission Selector dialogue box. -> Make the appropriate selections from the group and membership options presented in the Select Permission dialogue box. 6.6.2 - User - user pages are not in 5.2 any more 6.6.3 - the screenshod should be between step 2 and 3
User guide: Hi Scott, The are 2 small corrections after your changes: Chapter 2 - Internet Explorer (versions 7 and 9) -> Internet Explorer (versions 7 to 9) 6.2.3 - third screenshon (Edit Inline Composer) - There should be Site's Config button instead of Portal Propeties
@Miroslav I've actioned your Dev Guide feedback, thanks. All those TODOs were being inserted during the docbook export from Confluence. Annoying! Thanks again.
@Michal Unfortunately the broken characters in the PDF build will stay that way for a while. According to the Publican maintainer, the publican instance on the staging server will need to be updated to fix the issue. I have no idea when that's likely to happen. Since it's OK in the html versions, I'm happy to let it ride for now. @Vlastislav I've actioned you User Guide feedback, including the things in your most recent comment. Staging a new version of the User Guide now. @JBQA You guys are trying to kill me with all this feedback, aren't you?!?! ;)
Hi Scott, User Guide: 7.3 I thing there should be some info about new funcionality - Extended Label Mode. 7.3.3 - step 3 - update screenshot 7.3.4 - step 3 - update screenshot 8.2 - orange box - I don't know if the limitation mentioned here is already corrected or not. 8.2.1 - step 5 - update screenshot 8.2.6 - step 1 - the screenshot should be between step 2 and 3 8.2.8 - Procedure 8.2. Create a new Gadget - the sentences: "You can edit or refresh a gadget using the icons in the top right of the Gadget Details pane.", "You can delete a local gadget using the trashcan icon to the right of the appropriate gadget in the gadget list." and the screenshot below should be in the beginning of 8.2.10 8.2.8. - Procedure 8.1. Add a Remote Gadget -> Procedure 8.2.8.1. Add a Remote Gadget - Procedure 8.2. Create a new Gadget -> Procedure 8.2.8.2. Create a new Gadget In my opinion there should be 2 new chapters in User Guide: - first one about Group -> Administration -> Site Export/Import - second one about Group -> Administration -> Services Management but unfortunatelly I do know about these too little to tell you what to put into the chapters.
Thanks Vlastislav, Most of this latest feedback is actioned (I don't know if the issue in the warning in section 8.2 is resolved, so I've left it to be safe). Regarding the Procedure numbers in section 8.2.8, I can't manually control those, they're auto-generated by Publican. As for the two new sections, I agree completely, but unfortunately there isn't time to source draft content and publish it in time for GA. I'll create JIRAs for both of them and mark them for the next release. Thanks.
Closing this issue in preparation for the GA publication push. Any new feedback should be added to a new JIRA and marked as fix in the next release cycle. Only issues related to the feedback already posted here will be actioned if posted in this JIRA.
Hi Scott, I'm adding some notes about Instalation guide, in my opinion these should be in 5.2.0.Docs.GA. 2.1 - 1. orange box - It is possible to upgrade from JBoss Enterprise Portal Platform version 5.0 or 5.1.0 to JBoss Enterprise Portal Platform 5.1.1. -> It is possible to upgrade from JBoss Enterprise Portal Platform version 5.1.0 or 5.1.1 to JBoss Enterprise Portal Platform 5.2.0. - 1. orange box - To upgrade, copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the 5.1.1 installation. -> To upgrade, copy any customized configuration files and database settings from your existing JBoss Enterprise Portal Platform installation to the corresponding location of the 5.2.0 installation. -2. orange box - You must deploy a new instance of JBoss Enterprise Portal Platform 5.1.1 in order to use the Site Publisher add-on. -> You must deploy a new instance of JBoss Enterprise Portal Platform 5.1.0 or later in order to use the Site Publisher add-on. 2.2.2 - table 2.1 - add RHEL6 with OpenJDK and SunJDK - table 2.2 - update this table according to https://docspace.corp.redhat.com/docs/DOC-16080#comment-7733 section EAP 5.1.x 2.2.3 - Installing and Configuring JDK 6.0 on a generic Linux platform, Installing and Configuring JDK 6.0 on Microsoft Windows - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Sun's website: http://java.sun.com/javase/downloads/index.jsp#need. - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Oracle's website: http://www.oracle.com/technetwork/java/javase/downloads/index.html#need. - Alternatively, this page can be accessed directly at http://java.sun.com/javase/downloads/widget/jdk6.jsp. -> Alternatively, this page can be accessed directly at http://www.oracle.com/technetwork/java/javase/downloads/jdk6-jsp-136632.html. 4.4 - Disabling Authentication for JMX Invoker - JBOSS_HOME/server/<PROFILE>/jmx-invoker-service.xml -> JBOSS_HOME/server/<PROFILE>/deploy/jmx-invoker-service.xml - Disabling Pre-configured Accounts - JBOSS_HOME/server/<PROFILE>/gatein.ear/02portal.war/WEB-INF/web.xml -> JBOSS_HOME/server/<PROFILE>/deploy/gatein.ear/02portal.war/WEB-INF/web.xml 5.1.3 - <local-tx-datasource> -> <no-tx-datasource> - </local-tx-datasource> -> </no-tx-datasource> 5.1.4 - update gatein-ds.xml 5.3.3 - Is the example of the source code updated? Chapter 7 - example of starting portal - There should be example of epp5.2 instead of current 5.0.0
Thanks Vlastislav, I've fixed most those issues in the 5.2.0-4 version of the Installation Guide. I wasn't able to completely understand what you were asking me to add from the linked comment in EAP discussion. Can you please clarify?
Hello Scott, It's my copy and paste mistake. There should be only https://docspace.corp.redhat.com/docs/DOC-16080. So please update table 2.2 according to section EAP 5.1.x from the linked page. In my opinion the "JBoss Enterprise Portal Platform 5.0" and "JBoss Enterprise Portal Platform 5.1" shouldn't be here any more. Just DBs for 5.2.0. Sorry for misunderstanding.
Thanks for that Vlastislav, I've updated the table accordingly.
Hi Scott, there are some minor corrections after your changes. 2.1 - version 5.0 or 5.1.0 -> 5.1.0 or 5.1.1 2.2.2 - table 2.1 - Red Hat Enterprise Linux 6 - OpenJDK -> OpenJDK 1.6 Update 15 - SunJDK -> SunJDK 1.6 Update 15 2.2.3 - Installing and Configuring JDK 6.0 on a generic Linux platform - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Sun's website: http://java.sun.com/javase/downloads/index.jsp#need. - Download the Java 2 Platform, Standard Edition (J2SE) Development Kit (JDK) 6.0 from Oracle's website: http://www.oracle.com/technetwork/java/javase/downloads/index.html#need. - Alternatively, this page can be accessed directly at http://java.sun.com/javase/downloads/widget/jdk6.jsp. -> Alternatively, this page can be accessed directly at http://www.oracle.com/technetwork/java/javase/downloads/jdk6-jsp-136632.html. 5.1.4 gatein-ds.xml {{<datasources>}} {{<no-tx-datasource>}} {{<jndi-name>gatein-idm</jndi-name>}} {{<connection-url>jdbc:mysql://mysql-hostname:3306/gateinidm</connection-url>}} {{<driver-class>com.mysql.jdbc.Driver</driver-class>}} {{<user-name>gateinuser</user-name>}} {{<password>gateinpassword</password>}} {{<min-pool-size>5</min-pool-size>}} {{<max-pool-size>20</max-pool-size>}} {{<idle-timeout-minutes>0</idle-timeout-minutes>}} {{<prepared-statement-cache-size>32</prepared-statement-cache-size>}} {{</no-tx-datasource>}} {{<local-tx-datasource>}} {{<jndi-name>gatein-jcr</jndi-name>}} {{<connection-url>jdbc:mysql://mysql-hostname:3306/gateinjcr</connection-url>}} {{<driver-class>com.mysql.jdbc.Driver</driver-class>}} {{<user-name>gateinuser</user-name>}} {{<password>gateinpassword</password>}} {{<min-pool-size>5</min-pool-size>}} {{<max-pool-size>20</max-pool-size>}} {{<idle-timeout-minutes>0</idle-timeout-minutes>}} {{<prepared-statement-cache-size>32</prepared-statement-cache-size>}} {{</local-tx-datasource>}} {{</datasources>}}
Thanks Vlasitslav, I've slipped those changes in. The document has now been sent to release-engineering for publication. No further changes are possible from this point.