[
http://jira.amdatu.org/jira/browse/AMDATU-452?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12228#comment-12228
]
Marcel Offermans commented on AMDATU-452:
-----------------------------------------
Documented as:
http://www.amdatu.org/confluence/display/Amdatu/Bundle+Documentation+Template
Decided to document the dependencies "the OSGi way", so as requirements and
capabilities. That means we don't do transitive dependencies, nor do we
directly refer to other bundles.
Regarding the JavaDoc, I'm not sure if that really helps. The high level
description should be enough for you to decide to use this bundle. Perhaps
other pages, with specific examples, will help you decide (but those should not
be part of this template I think).
> Component documentation
> -----------------------
>
> Key: AMDATU-452
> URL: http://jira.amdatu.org/jira/browse/AMDATU-452
> Project: Amdatu
> Issue Type: Task
> Reporter: Paul Bakker
> Assignee: Marcel Offermans
> Priority: Critical
> Fix For: Sprint 1
>
>
> It is now very difficult to start using Amdatu components because it is
> unclear what dependencies and what configuration a component needs. To use an
> Amdatu component you now have to install the bundle and use "dm notavail" to
> figure out what other component or configuration you should install next.
> This might be ok for internal use, but it is critical for external developers
> to simplify this process.
> For each component we need the following documentation on the web site:
> -Component dependencies (it would be even better to also list the transitive
> dependencies), including all alternatives. Do I HAVE to use Casandra or is
> there an in-memory implementation?
> -Required & optional configuration (name of the config file, and properties)
> -A link to the JavaDoc that should describe the service API
> Some code examples and step-by-step guides would help a lot too.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
http://jira.amdatu.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
_______________________________________________
Amdatu-developers mailing list
[email protected]
http://lists.amdatu.org/mailman/listinfo/amdatu-developers
