Bug 793432 (JBEPP-516) - Docs: User Guide
Summary: Docs: User Guide
Keywords:
Status: CLOSED NEXTRELEASE
Alias: JBEPP-516
Product: JBoss Enterprise Portal Platform 5
Classification: JBoss
Component: unspecified
Version: unspecified
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 5.1.0.Docs.GA
Assignee: Scott Mumford
QA Contact:
URL: http://jira.jboss.org/jira/browse/JBE...
Whiteboard:
Depends On:
Blocks: JBEPP-455
TreeView+ depends on / blocked
 
Reported: 2010-09-30 03:29 UTC by Scott Mumford
Modified: 2010-12-18 03:03 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-12-13 04:17:52 UTC
Type: Task
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker JBEPP-516 0 None None None Never

Description Scott Mumford 2010-09-30 03:29:56 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
project_key: JBEPP

This is a tracker for issues relating to the EPP User Guide.

Please open separate JIRAs for issues and link them to this one.

Comment 1 Scott Mumford 2010-09-30 03:30:21 UTC
Link: Added: This issue is a dependency of JBEPP-455


Comment 2 Scott Mumford 2010-11-01 04:16:11 UTC
No Release Note Required: JIRA pertains to documentation not product

Comment 3 Scott Mumford 2010-11-01 04:16:11 UTC
Release Notes Docs Status: Added: Not Required


Comment 4 Michal Vanco 2010-11-27 01:38:54 UTC
Hi Scott,
there are my comments for User Guide verification. Thanks!

- First page + title + second page title - 5.0 is mentioned, should be
5.1

2.4 Navigation
- Dashboard editor should be bold as well, it is twice in paragraph.
- Site + Group editors are available for admin, but Dashboard editor is
available for all users.

3.3.1
- There should be screen of Dashboard workspace and not calendar

3.3.2
- Screen 3. is misunderstanding, it could be removed or there could be
only screen of Add gadgets link

5.1.2 (?)
- "..that allows them to; add a new page..." -> "..that allows them to
add new page..."

5.2.1
- There is not latest screen of point 2. Portal templates tab was added.
- + there should be some comment (+screen) about portal templates as
well

5.2.2
- It seems that ideas are not completed here.
- First sentence ends with :, but nothing follows.
- An administrator can change many aspects of a portal:
 - there should be some list of what can be changed I think
- And I think this chapter is not about Edit Portal, because it is
5.2.5. 5.2.2 is only about displaying present portals.

5.2.3
- There should be mentioned ending of edit layout action: by Finish
button on Edit Inline composer or with Abort (do not save changes)

5.2.4
- There is too big screenshot of Navigation management

5.2.7
- point 2. Screen could be updated with deployed SimpleSkin (to have
list with at least 2 items)
- Screen for permament skin change is not correct - Properties tab is
missing, and Vista + Mac skins do not exists at gatein or epp
- permanent, point 3. "Click Save then Finish" -> "Click Save (to
finish)"

5.3.3
- point 3., it should be something like: Right-click on node where you
want to paste this node
- and screen is not correct, you should not paste in system nodes

5.3.4
- same as for 5.3.3
- remove last sentence: "This new pages will appear in the page lists:"

5.3.5
- same as for 5.3.3

5.3.6
- screen is not correct, you can't delete system nodes

5.3.7
- screen is not correct, system nodes should not have sub-nodes

5.4.1.1
- point 6., "or click the icon to see more templates" -> "or click the
select box in right pane to see more templates"

5.4.1.2
- screen in point 3. is duplicated, second one doesn't bring anything
new
- Owner id for user owner type is not described, describe separately for
portal, group, user. Remove sentence "The name of the page owner"

5.4.4
- point 1., "Go to Site Editor in..." -> "Mouse over Site Editor in..."

5.5.1
  remove sentence: "You can not users to a group but you can remove them
from the group". - it's not true, you can add users to groups as well

General:
- on some places there is Mouse over and somewhere it is Mouse-over, it
should be unified

5.5.1.1
- under screen of point 2., "Account Settings" -> Account Setting

5.6.2.1
- should be numbered 1.-6. and not 1.-3.+1.3.

5.6.2.2
- same as for 5.6.2.1 (via page management numbering)

Comment 5 Scott Mumford 2010-12-08 05:13:49 UTC
The above comments have been actioned.

Comment 6 Michal Vanco 2010-12-08 19:08:20 UTC
Scott, there is wrong name of Preface page in EPP User Guide: pref-JBoss_Portlet_Bridge_Reference_Guide-Preface.html
Can you edit page name? It doesn't look well in url :)
Thanks.

Comment 7 Scott Mumford 2010-12-09 05:02:00 UTC
Thanks Michel. Fixed.
How did you even catch that?!

Comment 8 Michal Vanco 2010-12-09 17:38:53 UTC
Hi Scott, previous preface name was 100% luck.

Today I wend through User Guide again and there are some new + edited comments:

3.2
 - wrong screenshot of Navigation portlet - current screenshot is toolbar
 - edit screenshot of Sitemap portlet - cut off navigation portlet + breadcrumbs portlet

3.3
 - first two screens could be cut, there are some redundant discontinuous lines on top and on left
 - second screenshot can be after double click on dashboard - name as input (now it's highlighted)

3.3.1
 - first screenshot is from SP - there is Edit select in top right corner
 - second screenshot in pdf is maximized, in html it's ok
 - Calendar - I can't switch between daily and montly view, I have only one view of calendar and there is no option of customization (only by changing skins)
 - ToDo - tasks can't be highlighted with different colors (at least not mine)

3.3.2
 - second screenshot is from SP - there is Edit select in top right corner
 - point 5. there is url of googlegallery gadget, but currency converter is below -> change screenshot to url: http://www.donalobrien.net/apps/google/currency.xml

4.2 + 4.2.1
 - sign in dialog which is at 4.2.1 is described in 4.2 - it should be reorganized

4.5
 - when you forgot your password, you won't get any temporary password, email contains only link to application to edit password

5.2.1
 - there are some redundant lines of first two screenshots

5.2.2
 - you access portal by selecting portal in Site menu, when you click on Site - you are in Site management - portal lists + actions

5.2.4
 - There is too big screenshot of Navigation management

5.2.7
 - point 2. Screen could be updated with deployed SimpleSkin (to have list with at least 2 items)

5.3.1
 - there is an issue JBEPP-716 and current behavior of portal isn't as described here

5.3.5
 - screen is not correct, you can't cut system node

5.3.7
 - change screenshot, it has no reason to use Move Up/Down on 1 subpage, you should pop-up context menu on test node for better ilustration

5.5.1
 - 'Users and Groups Management' should be bold

5.5.2
 - 'Users and Groups Management' should be bold, 'Group Management' should be bold

5.5.2.5
 - there is an orange line above screenshot

5.5.3
 - 'Users and Groups Management' should be bold

5.6.1.2
 - wrong screenshot - 'Properties' tab is missing

5.6.2.2
 - edit right - remove italic
 - procudure 5.2, add 'Click on View Page Properties in the Page Editor.' after 2. and before 3.

7.2.10.1
 - change this screen, there is mentioned 'Created by the eXo Platform SARL, dang.tung + email', I think you could edit any other gadget or create and edit new one

Thanks in advance for applying!

Comment 9 Michal Vanco 2010-12-09 19:16:39 UTC
Btw. User Guide has same issue as Ref.Guide - blue images in pdf version.

Comment 10 Scott Mumford 2010-12-13 04:17:01 UTC
Above issues are actioned Michal, thanks.

I didn't change the procedure in 5.3.1 that is affected by JBEPP-716 but I made sure the JIRA is a known issue in the Release Notes.

Seems counter-productive to add a workaround in the core docs when the bug is being fixed next micro release.

Comment 11 Scott Mumford 2010-12-13 04:17:52 UTC
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. 

Comment 12 Michal Vanco 2010-12-17 14:02:18 UTC
Hi Scott, 
there are still some points which weren't actioned. Can you pls have a look:

3.3
 - first screen could be cut, there are some redundant discontinuous lines on top and on left
 - second screenshot can be after double click on dashboard name = name as input (now it's highlighted)

3.3.1
 - in pdf, second screenshot is maximized

5.2.1
 - there are some redundant lines on first two screenshots

5.2.4
 - in pdf, second screenshot is maximized

5.2.5
 - 'Edit Portal Properties' should be bold and not italic

5.2.7
 - point 2. Screen could be updated with deployed SimpleSkin (to have list with at least 2 items)
 - there is a redundant line on third screenshot

5.2.8 
 - Switching between Portals -> Switching between portals
 - Users switch between Portals -> Users switch between portals

5.4.2
 - Edit page can be also done with Site/Group/Dashboard editor->Edit a page, this possibility isn't mentioned here

5.5.2
 - 'Users and Groups Management' should be bold, 'Group Management' should be bold

5.6.2.2
 - procudure 5.2, add 'Click on View Page Properties in the Page Editor.' after 2. and before 3.

7.2.1
 - steps to finish should be added, it means: after Save, click Close and then click Finish image

I also sent it to you by e-mail, thanks for your reply!

Comment 13 Scott Mumford 2010-12-18 03:03:38 UTC
Thanks Michal,
Comments in-line below:

3.3
 - first screen could be cut, there are some redundant discontinuous lines on top and on left
 (Next release)

 - second screenshot can be after double click on dashboard name = name as input (now it's highlighted)
 (this is actually the way I want the image, to show the interactivity of the name field)

3.3.1
 - in pdf, second screenshot is maximized
   (fixed)

5.2.1
 - there are some redundant lines on first two screenshots
 (Next release)

5.2.4
 - in pdf, second screenshot is maximized
 (fixed)

5.2.5
 - 'Edit Portal Properties' should be bold and not italic
   (fixed)
   
5.2.7
 - point 2. Screen could be updated with deployed SimpleSkin (to have list with at least 2 items)
 (Next release)
 - there is a redundant line on third screenshot
 (Next release)

5.2.8
 - Switching between Portals -> Switching between portals
 - Users switch between Portals -> Users switch between portals
 (fixed)

5.4.2
 - Edit page can be also done with Site/Group/Dashboard editor->Edit a page, this possibility isn't mentioned here
 (Next release)

5.5.2
 - 'Users and Groups Management' should be bold, 'Group Management' should be bold
 (fixed)

5.6.2.2
 - procudure 5.2, add 'Click on View Page Properties in the Page Editor.' after 2. and before 3.
  (fixed)

7.2.1
 - steps to finish should be added, it means: after Save, click Close and then click Finish image 
 (fixed)


Note You need to log in before you can comment on or make changes to this bug.