Bug 793730 (JBEPP-801)

Summary: Docs: EPP Reference Guide
Product: [JBoss] JBoss Enterprise Portal Platform 5 Reporter: Scott Mumford <smumford>
Component: DocumentationAssignee: Scott Mumford <smumford>
Status: CLOSED NEXTRELEASE QA Contact: ecs-bugs
Severity: low Docs Contact:
Priority: low    
Version: 5.2.0.GACC: mcupak, mposolda, mvanco, smumford, vrockai
Target Milestone: ---   
Target Release: 5.2.x   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBEPP-801
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-08-15 04:32:09 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: 793458, 793611, 793649, 793661, 793676, 793689, 793819, 794003    
Bug Blocks: 793727    

Description Scott Mumford 2011-02-10 06:01:56 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
project_key: JBEPP

A tracker for issues in the EPP Reference Guide.

For major issues (major content issues, major structural changes), create a new JIRA and link it to this one.

Minor issues (typographical and grammatical errors) can be added to comments below.

Comment 1 Scott Mumford 2011-02-14 02:13:56 UTC
Link: Added: This issue depends JBEPP-727


Comment 2 Scott Mumford 2011-02-14 02:14:44 UTC
Link: Added: This issue depends JBEPP-753


Comment 3 Scott Mumford 2011-02-14 02:15:14 UTC
Link: Added: This issue depends JBEPP-765


Comment 4 Scott Mumford 2011-02-15 07:29:16 UTC
Link: Added: This issue depends JBEPP-739


Comment 5 Scott Mumford 2011-02-15 07:30:37 UTC
Link: Added: This issue depends JBEPP-690


Comment 6 Scott Mumford 2011-04-15 04:12:42 UTC
Subject Matter Expert: Added: smumford
NEEDINFO: Added: Nobody


Comment 7 Scott Mumford 2011-04-15 04:13:33 UTC
Subject Matter Expert: Removed: smumford 
NEEDINFO: Removed: Nobody 


Comment 8 Scott Mumford 2011-04-19 04:36:19 UTC
Link: Added: This issue depends JBEPP-894


Comment 9 Scott Mumford 2011-04-19 04:49:01 UTC
Link: Added: This issue depends JBEPP-541


Comment 10 mposolda 2011-05-06 08:57:44 UTC
Minor issue in http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Portal_Platform/5.1/html-single/Reference_Guide/ in section 15.7.1.2. - Registration Modification on Producer Error . There is paragraph called: JBoss Enterprise Portal Platform 5.0 and WSRP 1 Exceptions . I think the version number 5.0 should be upgraded.

Comment 11 Scott Mumford 2011-05-12 05:30:20 UTC
Thanks Marek, good catch. Fixed.

Comment 12 mposolda 2011-08-08 15:05:48 UTC
JBEPP-894 reopened and comment added. Scott, let me know if something is unclear.

Comment 13 Viliam Rockai 2011-08-08 16:06:51 UTC
hi scott,

i haven't found nothing major, so instead of creating JIRAs, i'll put my minor spots into this comment:

h4.14.1. Password Encryption
	* i believe you should use the term [plaintext|http://en.wikipedia.org/wiki/Plaintext] instead of [plain-text|http://en.wikipedia.org/wiki/Plain-text].
	
h4.14.8. LDAP Integration
	* missing full stop mark at the end of the 1st paragraph.
	
h4.Procedure 14.20. Set up LDAP read-only Mode
	* would be nice if step 2 had the code snippet similar to snippets in "uncomment" parts below
	* in 14.21. b/ 14.22. b/ 14.23. c - would be nice to include the comment into snippet as well

h4.17.3.1.2. Datasource Paramenters
	* transaction-isolation values should be denoted	
	* <idle-timeout-minutes value.) string is missing ">"
	* in this part some tags are bold some are not, should be unified

Comment 14 Michal Vanco 2011-08-08 17:26:35 UTC
Hi Scott,
there are 2 minor details in WSRP removal procedure:

1) re-write first sentence - it's not very clear
15.9. Removing WSRP
If you are not going to use WSRP in your JBoss Enterprise Portal Platform instance, your installation will not be adversely affected should you leave the WSRP files in place. 

2) remove point 5.c) because it's optional step mentioned in 9.

Comment 15 Scott Mumford 2011-08-10 03:31:52 UTC
Viliam,

Thanks for your feedback.
I changed 'plain-text' to 'plain text' as that's what's prescribed in the RH Style Guide:
https://home.corp.redhat.com/node/67041#p Nice catch!

Also, the content used in 17.3.1.2. Datasource Paramenters was taken from the EAP Admin and Config Guide. I have passed the corrections I made in EPP on to them for use in their version. Thank you on their behalf.

Comment 16 Scott Mumford 2011-08-10 04:12:38 UTC
Michal,
I've incorporated your recommendations. Thanks.

Comment 17 Miroslav Cupák 2011-08-15 04:04:38 UTC
A few issues spotted:
* In section *13.3.4.2.1.*, the [link|http://anonsvn.jboss.org/repos/portletbridge/tags/2.0.0.FINAL/examples/seam/booking/] to Seam Booking Demo points to Portlet Bridge 2.0.0.FINAL tag. I guess this should rather point to the example in 5.1.1's version of Portlet Bridge - 2.1.2.GA.EPP51, i.e. [here|http://anonsvn.jboss.org/repos/portletbridge/tags/2.1.2.GA.EPP51/examples/seam/booking/].
* There should be _foo.baz._ instead of _foo.baz(wild-card)_ in _...any attribute beginning with foo.baz(wild-card)..._ in section *13.4.1.*
* There should be _/edit.jspx_ instead of _\edit.jspx_ above the code in section *13.4.2.*
* _portlets web application_ in section *13.3.4.3.1.* sounds a bit strange - maybe just _portlet_ instead?
* _portlet served_ should probably be _portlet-served_ in section *13.2.1.2.*
* _JBoss Enterprise Portal Platform_ is not highlighted (as the rest of the technologies) at the beginning of section *13.2.2.*
* A typo in 13.3.4.3.1.: "We have -setup- +set up+...".


Comment 18 Scott Mumford 2011-08-15 04:32:09 UTC
Docs development/maintenance for the EPP 5.1.1 release is closed.

Miroslav, Thanks for your feedback, I'll include it in trackers for the next release cycle.

Comment 19 Miroslav Cupák 2011-08-15 04:32:23 UTC
Link: Added: This issue depends JBEPP-1074