Bug 860975 - Review javadoc destribution
Summary: Review javadoc destribution
Keywords:
Status: NEW
Alias: None
Product: JBoss Enterprise Portal Platform 5
Classification: JBoss
Component: Documentation
Version: 5.2.2.GA
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: ---
Assignee: JPP Docs Team
QA Contact: Martin Vecera
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-09-27 08:54 UTC by Toshiya Kobayashi
Modified: 2023-06-23 14:12 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Toshiya Kobayashi 2012-09-27 08:54:19 UTC
Now customers can download jboss-epp-doc-5.2.2.zip [1]. It includes lots of javadoc but most of them are private APIs and should not be used by user applications.

We need to review javadoc destribution for the future releases. The steps would be like the following:

1. Stop shipping the javadoc destribution
2. Figure out what are the public (supportable) APIs which customers can use
3. Ship only javadoc for public APIs

Note:
The current customer guidance by GSS is [2]:
===
- JSR-168/286 API is supported
- Any other API(org.gatein/org.exoplatform) is not officially supported. We don't recommend to use, but users can use it on thier own.
 -> Exceptionally, APIs introduced in Reference Guide are supported
 --> Organization API(org.exoplatform.services.organization)
===

[1] https://access.redhat.com/jbossnetwork/restricted/softwareDetail.html?product=jbportal&downloadType=distributions&softwareId=14263&version=5.2.2
[2] https://access.redhat.com/knowledge/solutions/60268


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