[jira] Issue Comment Edited: (KARAF-303) Documentation for available Features and how they might be configured

["Achim Nierbeck (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12966028#action_12966028 ] 

Achim Nierbeck edited comment on KARAF-303 at 12/2/10 4:10 AM:
---------------------------------------------------------------

I agree with you that a duplication of the documentation should be prevented. 

Here some pros and cons that come to my mind: 

Pros: 
- Only one place to edit documentation
- The provider of the bundle already does this

Cons:
- What if the Feature has more than one bundle that contains meta-type information?
- What if the bundle doesn't contain any information at all?

Open: 
- would it be possible to parse this meta-type documentation for usage in the online-documentation?
- again would it be possible to use this meta-type documentation as documentation attached to the feature:info command and in the webconsole?

If we get around the open points and find a good solution for the cons I'm with you that there should be only one place for the documentation. 

      was (Author: achim_nierbeck):
    I agree with you that a duplication of the documentation should be prevented. 

Here some pros and cons that come to my mind: 

Pros: 
- Only one place to edit documentation
- The provider of the bundle already does this

Cons:
- What if the Feature has more than one bundle that contains meta-type information?
- What if the bundle doesn't contain any information at all?

Open: 
- would it be possible to parse this meta-type documentation for usage in the online-documentation?
- again would it be possible to use this meta-type documentation as documentation attached to the feature:info command and in the webconsole?

If we get arround the open points and find a good solution for the cons I'm with you that there should be only one place for the documentation. 
  
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
>                 Key: KARAF-303
>                 URL: https://issues.apache.org/jira/browse/KARAF-303
>             Project: Karaf
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed. 
> Two things should be of Interest here: 
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war: 
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer: 
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented. 
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.