Bug 793797 (JBEPP-871)

Summary: Docs: Improving Reader Productivity Suggestion
Product: [JBoss] JBoss Enterprise Portal Platform 5 Reporter: Scott Mumford <smumford>
Component: DocumentationAssignee: Scott Mumford <smumford>
Status: CLOSED NEXTRELEASE QA Contact: ecs-bugs
Severity: medium Docs Contact:
Priority: medium    
Version: 5.1.0.Docs.GACC: epp-bugs, smumford
Target Milestone: ---   
Target Release: 5.1.1.Docs.GA   
Hardware: Unspecified   
OS: Unspecified   
URL: http://jira.jboss.org/jira/browse/JBEPP-871
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-04-19 04:38:40 UTC Type: Feature Request
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:    
Bug Blocks: 793729    

Description Scott Mumford 2011-04-07 03:42:00 UTC 
Affects: Documentation (Ref Guide, User Guide, etc.)
project_key: JBEPP

From: Larry [larry_g_smith]
Sent: March-30-11 7:04 AM

On page 30 (of the JBEPP User Guide), it describes how to edit layout. It would be helpful if it references the associated manuals & sections that describes how the applications are created (I.e. JBoss_Developer_Studio-4.0-JBoss_Portlet_Tools_User_Guide-en-US.pdf).

This cross-referencing of topics may help people become productive more faster.
Further to my email, I found some promising workshops on your portal which ideally should be referenced from the User Guide.

N.B.: when I installed the JB Developer Studio, I could not perform examples described without further plugin updates to the studio. Some users may be confused if this is not described.
Comment 1 Scott Mumford 2011-04-07 03:53:40 UTC 
Some of the requests made in the original correspondence are more to do with JBDS than JBEPP.
The JBDS Docs Lead is looking into these.

Regarding cross-referencing JBDS docs within JBEPP docs: 
A note about "Custom Portlets" has been added to the JBEPP User Guide (at the end of the 'Edit Layout' subsection) which requests readers to refer to the JBDS Portlet Tools Guide and/or the JBEPP Reference Guide's "Developing Portlets' section for information about creating and deploying portlets.
Comment 2 Scott Mumford 2011-04-13 23:39:48 UTC 
Release Notes Docs Status: Added: Not Required
Comment 3 Scott Mumford 2011-04-15 04:12:41 UTC 
Subject Matter Expert: Added: smumford
NEEDINFO: Added: Nobody
Comment 4 Scott Mumford 2011-04-15 04:13:32 UTC 
Subject Matter Expert: Removed: smumford 
NEEDINFO: Removed: Nobody
Comment 5 Scott Mumford 2011-04-19 04:38:40 UTC 
New content to be verified.
Comment 6 Scott Mumford 2011-04-19 04:39:05 UTC 
Link: Added: This issue is a dependency of JBEPP-800