Bug 724656 (BRMS-559)
| Summary: | BRMS Drools javadocs - multiple subdirectories - no top-level index.html file | ||
|---|---|---|---|
| Product: | [JBoss] JBoss Enterprise BRMS Platform 5 | Reporter: | Len DiMaggio <ldimaggi> |
| Component: | Documentation | Assignee: | Ryan Zhang <rzhang> |
| Status: | CLOSED WORKSFORME | QA Contact: | Lukáš Petrovický <lpetrovi> |
| Severity: | medium | Docs Contact: | |
| Priority: | high | ||
| Version: | 5.1.0 GA | CC: | atangrin, gdesmet, ge0ffrey.spam, lcarlon, lpetrovi, ncross |
| Target Milestone: | --- | Keywords: | Documentation |
| Target Release: | BRMS 5.3.0.GA | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| URL: | http://jira.jboss.org/jira/browse/BRMS-559 | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-03-06 04:19:04 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: | |||
|
Description
Len DiMaggio
2011-03-01 16:55:57 UTC
Only drools-api is considered backwards compatible API afaik. With the maven-javadoc-plugin it should be possible to use <aggregate>true</> to get an aggregation of all javadocs. With the split-up on 5.2, it might be interesting to implement that there first, and get one per repository (drools, guvnor, integration). If so, create a GUVNOR issue and assign it to me. We seem to not be shipping javadocs inside the distribution packages. If that is correct, please close this as NOTABUG. We ended up shipping the jadavocs. Thus this one needs to be resolved for the next release. At the .org side this is the situation: In Drools we're shipping the public API javadocs (knowledge-api). In TIP: An overall index.html file is easy: - Don't configure javadocs per module - But in the assembly distribution, configure a dependency-aggretation of all the stuff you want javadocs for: http://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate-dependency-sources.html Notice that this even works over-repositories. Here's the code how to do it: https://github.com/droolsjbpm/jbpm/commit/ea282cd17de81127280ed298feb2ce356dfef3ec 724656 Aggregate the drools javadoc producing a single top level index file src/main/assembly/brms-javadoc.zip.xml pom.xml Update status to ON_QA. Please verify them against ER6. Ryan, in order to verify this, I need a location for the Javadoc files. There are none for ER6. Thanks! (In reply to comment #8) > Ryan, in order to verify this, I need a location for the Javadoc files. > There are none for ER6. Thanks! Yes, sorry, my mistake. The ER7's javadoc has been add up to : http://jawa05.englab.brq.redhat.com/candidate/BRMS-5.3.0-ER7/brms-p-5.3.0.BRMS-ER7-javadocs.zip Please verify. This bug is still valid. There are multiple top-level directories and no index. Also, there's just drools and modeshape - no jBPM? This is not (and IMHO shouldn't be) a blocker for 5.3. Sorry, my bad. This ticket is way too obsolete - the requested funcitonality is there, but the package has morphed into something different in the meantime. I'll open another BZ for the new issue. |