Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1114745

Summary: Included modules should include information about whether they are supported.
Product: [JBoss] JBoss Enterprise Application Platform 6 Reporter: sgilda
Component: DocumentationAssignee: Jimmy Wilson <jawilson>
Status: CLOSED CURRENTRELEASE QA Contact: Russell Dickenson <rdickens>
Severity: high Docs Contact:
Priority: unspecified    
Version: 6.3.0CC: dmichael, jason.greene, jawilson, jdoyle, pjelinek, xiwu
Target Milestone: GA   
Target Release: EAP 6.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Build Name: 22509, Development Guide-6.3-1 Build Date: 30-06-2014 17:04:26 Topic ID: 3891-657886 [Latest]
Last Closed: 2015-06-23 11:24:50 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Updated listModules.rb script
none
Script that formats the modules in Markdown table format. none

Description sgilda 2014-06-30 20:55:25 UTC
Title: Included Modules

Describe the issue:
This issue was originally reported by  as a second part for Bug 893343. This is a separate issue and should be a separate bug.

From  xiaohui Wu :

3.7.2. Included Modules
2. The list of included modules makes no mention of which are supported and which are not, which is definitely going to be confusing to users.



Suggestions for improvement:


Additional information:

Comment 2 David Michael 2014-07-04 07:52:05 UTC
From https://bugzilla.redhat.com/show_bug.cgi?id=893343#c22
Pavel Jelinek 2014-07-04 02:49:51 EDT 

But the main issue is that the article on Customer portal does not cover all informations removed from Development Guide. The information about conditionally added dependencies is lost. The removal of this info can not be acceptet until it is added to the article or replaced in any other way.

Hi Jimmy,

Please provide the required information so that we can fix https://bugzilla.redhat.com/show_bug.cgi?id=893343.

Thanks,
David Michael

Comment 3 sgilda 2014-07-07 13:16:47 UTC
Hi David, I am not sure I understand why you are commenting about the issue with Bug 893343 here.

Bug 893343 is to move the 'Implicit Module Dependencies' table to the Customer Portal, which impacted topic: Implicit Module Dependencies [4353]

This bug is to move the 'Included Modules' table to the Customer Portal, which impacted topic: Included Modules [3891]

I separated this from the original bug because it was a totally separate issue and may not be as urgent as the original bug or even required.

Comment 5 sgilda 2014-07-08 13:25:29 UTC
From Darrin Mison: 

 Darrin Mison 2013-03-20 01:34:07 EDT

Table 3.1 - the content came from the AS7 confluence page[1]. I'm not aware of any other sources of this information.

Section 3.7.2 - this list is generated by this script[2]. It traverses the modules directory and gets the names from the module.xml files.

Q: What defines a module as being able to be loaded on demand or not?  

Q: Looking now I can see a lot of modules have a jboss.api" property in their modules.xml.  Some of these are set to "private", a few are set to "unsupported". Should we filter the list based on that?


[1] https://docs.jboss.org/author/display/AS7/Implicit+module+dependencies+for+deployments

[2] https://github.com/dmison/Assorted-Scripts/blob/master/JBoss-AS7/listModules.rb

Comment 6 sgilda 2014-07-08 13:56:52 UTC
Modified topic: Included Modules [3891, rev: 682454]

Replaced list with link to https://access.redhat.com/articles/1122333

Change can be previewed here:

After the next build, the fix can be verified here:
http://docbuilder.usersys.redhat.com/22509/#Included_Modules1

https://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.3/html-single/Development_Guide/index.html#Included_Modules1

Comment 7 Pavel Jelinek 2014-07-21 08:07:46 UTC
Unfortunately the article https://access.redhat.com/articles/1122333 is empty at this moment. The list of included modules is missing.

Comment 8 sgilda 2014-07-21 11:21:59 UTC
*** Bug 1104623 has been marked as a duplicate of this bug. ***

Comment 9 sgilda 2014-07-21 12:03:06 UTC
Modifying the severity based on duplicate bug 1104623.

Comment 10 sgilda 2014-07-21 20:46:07 UTC
Hi Jimmy, 

I seeded the Customer Portal article with a table listing the included modules that used to be in the docs. This is NOT current, but at least something is there.

Please let me know if there's anything I can do to help with this.

Thanks,
Sande

Comment 11 sgilda 2014-07-22 14:54:00 UTC
Hi Jimmy,

I modified the script mentioned in comment 5 above to generate the markdown for the table rows and renamed it to listModulesInTable.rb. I'll attach the script here.

I updated the table in the article here: https://access.redhat.com/articles/1122333

All we need now is the information about whether it is supported or not.

Comment 12 sgilda 2014-07-22 14:56:01 UTC
Created attachment 919945 [details]
Updated listModules.rb script

Modified the listModules.rb script to format the modules in Markdown table syntax.

Comment 13 sgilda 2014-07-22 15:51:30 UTC
Uploading new listModulesTableFormat.rb script.

Comment 14 sgilda 2014-07-22 15:51:59 UTC
Created attachment 919952 [details]
Script that formats the modules in Markdown table format.