Bug 793732 (JBEPP-803)

Summary: Docs: EPP-SP User 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: epp-bugs, smumford, tkyjovsk
Target Milestone: ---   
Target Release: 5.2.x   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBEPP-803
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-08-15 04:40:20 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: 793631, 793779, 793780, 793781, 793782, 793811, 793891    
Bug Blocks: 793727    

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

A tracker for issues in the EPP Site Publisher User 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:10:00 UTC
Link: Added: This issue depends JBEPP-711


Comment 2 Scott Mumford 2011-02-15 05:18:58 UTC
Link: Added: This issue depends JBEPP-777


Comment 3 Scott Mumford 2011-02-15 07:19:06 UTC
Link: Added: This issue depends JBEPP-712


Comment 4 Scott Mumford 2011-03-14 03:13:27 UTC
Link: Added: This issue depends JBEPP-849


Comment 5 Scott Mumford 2011-03-14 04:39:24 UTC
Link: Added: This issue depends JBEPP-852


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


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


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


Comment 9 Scott Mumford 2011-04-19 04:37:23 UTC
Link: Added: This issue depends JBEPP-877


Comment 10 Scott Mumford 2011-04-19 04:37:52 UTC
Link: Added: This issue depends JBEPP-875


Comment 11 Scott Mumford 2011-04-19 04:41:02 UTC
Link: Added: This issue Cloned from JBEPP-851


Comment 12 Scott Mumford 2011-04-19 04:41:36 UTC
Link: Removed: This issue Cloned from JBEPP-851 


Comment 13 Scott Mumford 2011-04-19 04:41:52 UTC
Link: Added: This issue depends JBEPP-851


Comment 14 Scott Mumford 2011-04-19 04:42:07 UTC
Link: Added: This issue depends JBEPP-850


Comment 15 Scott Mumford 2011-04-19 04:42:36 UTC
Link: Added: This issue depends JBEPP-846


Comment 16 Scott Mumford 2011-05-24 00:29:11 UTC
Link: Added: This issue depends JBEPP-956


Comment 17 Scott Mumford 2011-06-02 05:10:15 UTC
Link: Added: This issue depends JBEPP-964


Comment 18 Tomas Kyjovsky 2011-08-10 12:22:42 UTC
I've only read the doc up to the 3rd chapter. This is what I've got so far (mostly typos):

2.3.5. Version
"mixin: versionable" --> "mixin:versionable"

I'm not sure if the last 2 paragraphs about software versioning are really relevant in context of CMS.


3.1.1. Register an account
Point 2. - Table 3.1. 
"The user name that is used to login into the system." --> either "log into" or "login to"
"The user name must be started with a character." --> "The user name must start with a character."

But I'd rather suggest using the same field descriptions as in the EPP User Guide (5.1. Register New Accounts).

Point 4. The magnifying glass icon missing.

Point 6.
"Password and Confirm Password are not the same." --> "The Password and Confirm Password fields are not the same."
"The Email Address is not a invalid format." --> "The Email Address is not in a valid format."

3.1.2. Sign In
Table 3.2. Options - I suggest using the same field descriptions as in EPP User Guide (5.2. Sign In and Sign Out).

3.1.6. Toolbar Visibility

"Procedure 3.8. Grant all users access to toolbar and CMS" - The title is only correct for initially empty user database because this procedure doesn't grant the access to already existing users, only to the newly registered.

3.2. Change the display language
Point 2. Missing icon
Point 3. "Click Apply to change the display language temporarily, ..." - Temporarily? The EPP UG says: "Click Apply to save your change. The site should refresh and display its attributes in the language you've just chosen."

3.3. Change the skin of the current site
"... more easy and effective." --> "easier and more effective."

Comment 19 Scott Mumford 2011-08-12 06:48:30 UTC
Thanks Tomas,
Those issues have been fixed in the version of the doc on stage except for:

I didn't import the suggested text from the EPP User Guide, as the SP User Guide is an eXo-RH shared document and larger changes can't be as easily applied. I might look at doing that for a future release though. It's a good suggestion.

The instances of missing icons aren't actually bugs; using in-line graphics of UI buttons is contrary to section 508 accessibility standards (U.S.) and makes doc translation difficult. So there's a policy to avoid them. Each one in the SP User Guide should have been replaced with text instead. So, ironically, I need you to point out where an icon IS present, not where they aren't.

Thanks again for your feedback.

Comment 20 Scott Mumford 2011-08-15 04:39:14 UTC
Link: Removed: This issue depends JBEPP-875 


Comment 21 Scott Mumford 2011-08-15 04:39:28 UTC
Link: Removed: This issue depends JBEPP-777 


Comment 22 Scott Mumford 2011-08-15 04:39:36 UTC
Link: Removed: This issue depends JBEPP-956 


Comment 23 Scott Mumford 2011-08-15 04:39:44 UTC
Link: Removed: This issue depends JBEPP-846 


Comment 24 Scott Mumford 2011-08-15 04:39:55 UTC
Link: Removed: This issue depends JBEPP-712 


Comment 25 Scott Mumford 2011-08-15 04:40:04 UTC
Link: Removed: This issue depends JBEPP-877 


Comment 26 Scott Mumford 2011-08-15 04:40:20 UTC
Docs development/maintenance for the EPP 5.1.1 release is closed.