Bug 1021048

Summary: jboss portal 6.1 installation guide displaying wrong file structure in section 4.5
Product: [JBoss] JBoss Enterprise Portal Platform 6 Reporter: Eric Eichhorn <truehypocrisy>
Component: DocumentationAssignee: JPP Docs Team <jpp-docs>
Status: VERIFIED --- QA Contact: Vaclav Tunka <vtunka>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 6.1.0CC: bdawidow, epp-bugs, jpallich, jpp-docs, mmurray, tkyjovsk
Target Milestone: GAKeywords: Documentation
Target Release: 6.1.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Eric Eichhorn 2013-10-18 21:05:10 UTC
Description of problem:
Section 4.5 Installation Structure and Details 
Example 4.1 is still displaying jboss-jpp-6.0 file structure.  There are minor changes to structure and could be confusing for new user, like myself. :-)

Version-Release number of selected component (if applicable):

6.1.0

How reproducible:
Have a look for yourself:
https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Portal/6.1/html-single/Installation_Guide/index.html

Comment 2 Jared MORGAN 2013-10-20 21:21:17 UTC
(In reply to Eric Eichhorn from comment #0)
> Description of problem:
> Section 4.5 Installation Structure and Details 
> Example 4.1 is still displaying jboss-jpp-6.0 file structure.  There are
> minor changes to structure and could be confusing for new user, like myself.
> :-)
> 
> Version-Release number of selected component (if applicable):
> 
> 6.1.0
> 
> How reproducible:
> Have a look for yourself:
> https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Portal/6.1/
> html-single/Installation_Guide/index.html

Thanks for this report, Eric. We're planning on an async release of this guide towards the middle of November. This fix will be included in the guide.

Comment 3 Aakanksha 2013-10-23 17:42:17 UTC
(In reply to Jared MORGAN from comment #2)
> (In reply to Eric Eichhorn from comment #0)
> > Description of problem:
> > Section 4.5 Installation Structure and Details 
> > Example 4.1 is still displaying jboss-jpp-6.0 file structure.  There are
> > minor changes to structure and could be confusing for new user, like myself.
> > :-)
> > 
> > Version-Release number of selected component (if applicable):
> > 
> > 6.1.0
> > 
> > How reproducible:
> > Have a look for yourself:
> > https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Portal/6.1/
> > html-single/Installation_Guide/index.html
> 
> Thanks for this report, Eric. We're planning on an async release of this
> guide towards the middle of November. This fix will be included in the guide.

Installation guide is updated with the new directory structure for JPP 6.1

Comment 6 Jared MORGAN 2013-11-07 21:02:55 UTC
Jiri, you changed the Target Release fields to 6.1.1.

This is not correct. We will be asynchronously releasing these updates into the 6.1.0 documentation once QE signs off on the work.

You also set the status to FailedQA. Was this intentional?

Comment 9 Dominik Pospisil 2013-11-13 15:49:29 UTC
The first paragraph of the section says:

"Following is a listing of the directory structure, and a description of what the directory contains."

However there is none description of what the files/dirs contains provided. Without this information the section does not make much sense.

The listed structure seems correct, however I would propose some minor changes:

- the content of standalone/data as well as standalone/tmp could be wiped out
- the jboss-jpp-6.1/modules directory is missing layers.conf
- modules/system directory could be expanded two levels more to show base and gatein layers

There are also few cosmetic issues:

- standalone/configuration has wrong ident in the last listing
- extra line below gatein-management
- dots below gatein-sso and gatein top level dirs

Comment 12 Dominik Pospisil 2013-12-04 12:25:55 UTC
Tho following listing is incorrect:

├── modules
│   └── system
│   │   ├── add-ons
│   │   │   ├── gatein
│   │   ├── layers
│   │       ├── base 
│   └── layers.conf

Starting with 6.1.0.ER3 this has been changed to

├── modules
│   ├── layers.conf
│   └── system
│       └── layers
│           ├── base
│           └── gatein

Comment 13 Aakanksha 2014-02-06 09:16:48 UTC
(In reply to Dominik Pospisil from comment #12)
> Tho following listing is incorrect:
> 
> ├── modules
> │   └── system
> │   │   ├── add-ons
> │   │   │   ├── gatein
> │   │   ├── layers
> │   │       ├── base 
> │   └── layers.conf
> 
> Starting with 6.1.0.ER3 this has been changed to
> 
> ├── modules
> │   ├── layers.conf
> │   └── system
> │       └── layers
> │           ├── base
> │           └── gatein

Topic is updated with the changed structure. 
link to updated topic: http://docbuilder.ecs.eng.bne.redhat.com/22544/remarks/#Installation_Structure_and_Details