Bug 1324786

Summary: Generate new Complete_Resource_Reference containing EAP7 resources
Product: [JBoss] JBoss Operations Network Reporter: Filip Brychta <fbrychta>
Component: DocumentationAssignee: Tyler Kelly <tkelly>
Status: CLOSED CURRENTRELEASE QA Contact: Mike Foley <mfoley>
Severity: medium Docs Contact:
Priority: high    
Version: JON 3.3.5CC: loleary, tkelly
Target Milestone: post-GAKeywords: Triaged
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Current Full build command: git clone https://github.com/rhq-project/rhq.git -b RHQ_4_12_0_JON338GA --single-branch API_BUILD && \ cd API_BUILD/ && \ mkdir -p modules/common/cassandra-ccm/cassandra-ccm-core/target/classes/ && \ cp -r modules/common/cassandra-ccm/cassandra-ccm-core/src/main/bundle/cassandra modules/common/cassandra-ccm/cassandra-ccm-core/target/classes/ && \ mvn -Penterprise,dev -DskipTests install && \ cd modules/core/plugindoc/ && \ mvn install && \ cd ../../plugins && \ mvn -X org.rhq:rhq-core-plugindoc:4.12.0.JON330GA:plugindoc -Dmaven.test.skip=true
Last Closed: 2017-10-30 03:55:02 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:
Bug Depends On:    
Bug Blocks: 1134779, 1192878, 1217457, 1315797, 1443400    

Description Filip Brychta 2016-04-07 09:49:45 UTC
Document URL: https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Operations_Network/3.3/html-single/Complete_Resource_Reference/index.html


This document is generated via some docs generation tool. It reads the contents of the plug-in descriptors found in the product distribution and then spits it out into a document. 

This is the document Jared had many issues with and was not very successful in getting it generated. However, Simeon seemed to have no problems with it.

To make matters even more complicated, there were some changes/fixes that were applied atop of the generated content. For example, some of the plug-ins are in a deprecated state but there is no way to mark this in the plug-in descriptor and the generation stuff doesn't mark it as deprecated. So, what Deon had originally done was generate the document and then apply manual changes to the generated content before pushing it to the portal. Hopefully all those changes are stored as a change set in SVN or some better source repository system that you can replay/apply to the newly generated stuff.

Comment 1 Scott Mumford 2016-04-28 03:15:12 UTC
Have reached out to Simeon Pinder for an introduction to this process.

Comment 2 Scott Mumford 2016-05-04 23:34:53 UTC
Attempted the steps outlined in:
https://bugzilla.redhat.com/show_bug.cgi?id=1192869#c2

Encountered the same errors and warnings as Jared was getting.

Have reached out to Simeon for further assistance.

Comment 6 Tyler Kelly 2017-08-30 03:56:38 UTC
Update:
Got the API to build at modules/plugins/.
Still need to check for the manual edits made in the past and incorporate them.

There was a potential bug encountered that will be documented once I have a better idea of the potential solution.

Comment 7 Tyler Kelly 2017-09-20 00:57:58 UTC
UPDATE: got the api docs to build successfully. need to make a few manual changes and potentially create a script to automate 'manual' changes.

Comment 8 Tyler Kelly 2017-09-29 06:19:41 UTC
Draft CRR is now on QA server.

Changes so far:
- The EAP7 and RHQ-openshift API have been added.
- HornetQ has been removed, it was not build during the maven build of the doc, is it suppose to be there????
- addressed BUG1217457: https://bugzilla.redhat.com/show_bug.cgi?id=1217457

Is there anything else that needs to go in? The list of sections that are built can be found here:
https://gitlab.cee.redhat.com/red-hat-jboss-operations-network-documentation/doc-jon-docs/tree/preview/docs/Complete_resource_reference/en-US

Git Commits and Git Merge
https://gitlab.cee.redhat.com/red-hat-jboss-operations-network-documentation/doc-jon-docs/merge_requests/64/commits

Preview:
https://access.qa.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html-single/complete_resource_reference/

Comment 9 Tyler Kelly 2017-10-03 00:16:36 UTC
Moving back to modified, will work on other bugs related CRR to reduce work for QA.

Comment 10 Tyler Kelly 2017-10-03 04:25:10 UTC
Was able to resolve additional bug related to Complete Resource Reference, however the outstanding bug https://bugzilla.redhat.com/show_bug.cgi?id=1134779 remains unresolved. Moving to QA regardless.

Comment 22 Tyler Kelly 2017-10-30 03:55:02 UTC
Updated Complete Resource Reference Guide now available on the customer portal:
https://access.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html/complete_resource_reference/
    For new chapter containing the EAP 7 plugin:
https://access.redhat.com/documentation/en-us/red_hat_jboss_operations_network/3.3/html/complete_resource_reference/eap7