[jira] [Comment Edited] (TAP5-2192) Add support for distributed documentation
[ https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14055368#comment-14055368 ] Lance edited comment on TAP5-2192 at 7/8/14 7:47 PM: - Hi Thiago, I've just fired up the t5dashboard/componentlibraries page. I think a page listing the components is generally a good idea (better if it can be disabled). But I really hate the idea of configuring homepage URL's, artifact id's, group codes, javadoc and source locations inside tapestry. Since maven / gradle know this info, I'd be far less concerned with an option which made use of this. ie write the version / artifact id / javadoc url etc to the jar's manifest at build time (or an XML / JSON file) and look it up at runtime. Please see my ComponentLibraryInfoSource suggestion above. was (Author: uklance): Hi Thiago, I've just fired up the t5dashboard/componentlibraries page. I think a page listing the components is generally a good idea (better if it can be disabled). But I really hate the idea of configuring homepage URL's, artifact id's, group codes, javadoc and source locations inside tapestry. If I want javadoc and source code, it's only a few keystrokes away in my IDE... No config required. > Add support for distributed documentation > - > > Key: TAP5-2192 > URL: https://issues.apache.org/jira/browse/TAP5-2192 > Project: Tapestry 5 > Issue Type: Improvement >Affects Versions: 5.4 >Reporter: Barry Books >Assignee: Thiago H. de Paula Figueiredo > Labels: documentation, month-of-tapestry > > Please add support for a distributed documentation system. The basic > requirements are: > 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver > supports pages) > 2. Access to a Map of all Configurations. The map would have the > configuration class as the Key and contain an object such a list or map that > contains the configuration. > 3. Access to a list of configured services. > From this it should be possible to build documentation of a running system. > Thanks > Barry -- This message was sent by Atlassian JIRA (v6.2#6252)
[jira] [Commented] (TAP5-2192) Add support for distributed documentation
[ https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14055368#comment-14055368 ] Lance commented on TAP5-2192: - Hi Thiago, I've just fired up the t5dashboard/componentlibraries page. I think a page listing the components is generally a good idea (better if it can be disabled). But I really hate the idea of configuring homepage URL's, artifact id's, group codes, javadoc and source locations inside tapestry. If I want javadoc and source code, it's only a few keystrokes away in my IDE... No config required. > Add support for distributed documentation > - > > Key: TAP5-2192 > URL: https://issues.apache.org/jira/browse/TAP5-2192 > Project: Tapestry 5 > Issue Type: Improvement >Affects Versions: 5.4 >Reporter: Barry Books >Assignee: Thiago H. de Paula Figueiredo > Labels: documentation, month-of-tapestry > > Please add support for a distributed documentation system. The basic > requirements are: > 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver > supports pages) > 2. Access to a Map of all Configurations. The map would have the > configuration class as the Key and contain an object such a list or map that > contains the configuration. > 3. Access to a list of configured services. > From this it should be possible to build documentation of a running system. > Thanks > Barry -- This message was sent by Atlassian JIRA (v6.2#6252)
[jira] [Comment Edited] (TAP5-2192) Add support for distributed documentation
[
https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14054435#comment-14054435
]
Lance edited comment on TAP5-2192 at 7/8/14 9:07 AM:
-
Barry, for point 2. of this jira (accessing configuration info) you can't have
a map by class since there can be multiple services for a service interface.
I'd say a listener approach might be better
{code}
public interface ContributionListener {
void onConfigureList(ServiceIdentifier id, List l);
void onConfigureMap(ServiceIdentifier id, Map m);
void onConfigureCollection(ServiceIdentifier id, Collection c);
}
public interface ServiceIdentifier {
Class getServiceInterface();
String getServiceId();
Set getMarkers();
}
{code}
I guess that ServiceDef should extend this new ServiceIdentifier interface too:
http://tapestry.apache.org/5.3/apidocs/org/apache/tapestry5/ioc/def/ServiceDef.html
was (Author: uklance):
Barry, for point 2. of this jira (accessing configuration info) you can't have
a map by class since there can be multiple services for a service interface.
I'd say a listener approach might be better
{code}
public interface ContributionListener {
void onConfigureList(ServiceDescriptor d, List l);
void onConfigureMap(ServiceDescriptor d, Map m);
void onConfigureCollection(ServiceDescriptor d, Collection c);
}
public interface ServiceDescriptor {
Class getServiceInterface();
String getServiceId();
Set getMarkers();
}
{code}
I guess that ServiceDef should extend this new ServiceDescriptor interface too:
http://tapestry.apache.org/5.3/apidocs/org/apache/tapestry5/ioc/def/ServiceDef.html
> Add support for distributed documentation
> -
>
> Key: TAP5-2192
> URL: https://issues.apache.org/jira/browse/TAP5-2192
> Project: Tapestry 5
> Issue Type: Improvement
>Affects Versions: 5.4
>Reporter: Barry Books
>Assignee: Thiago H. de Paula Figueiredo
> Labels: documentation, month-of-tapestry
>
> Please add support for a distributed documentation system. The basic
> requirements are:
> 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver
> supports pages)
> 2. Access to a Map of all Configurations. The map would have the
> configuration class as the Key and contain an object such a list or map that
> contains the configuration.
> 3. Access to a list of configured services.
> From this it should be possible to build documentation of a running system.
> Thanks
> Barry
--
This message was sent by Atlassian JIRA
(v6.2#6252)
[jira] [Comment Edited] (TAP5-2192) Add support for distributed documentation
[ https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=1405#comment-1405 ] Lance edited comment on TAP5-2192 at 7/8/14 9:08 AM: - You are correct that there's only 1 configuration (List, Map, Collection) per service. But 2 services can have the same service interface. The ServiceIdentifier would be the combination of service interface, service id and any marker annotations. All these combined uniquely identify a service. was (Author: uklance): You are correct that there's only 1 configuration (List, Map, Collection) per service. But 2 services can have the same service interface. The ServiceDescriptor would be the combination of service interface, service id and any marker annotations. All these combined uniquely identify a service. > Add support for distributed documentation > - > > Key: TAP5-2192 > URL: https://issues.apache.org/jira/browse/TAP5-2192 > Project: Tapestry 5 > Issue Type: Improvement >Affects Versions: 5.4 >Reporter: Barry Books >Assignee: Thiago H. de Paula Figueiredo > Labels: documentation, month-of-tapestry > > Please add support for a distributed documentation system. The basic > requirements are: > 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver > supports pages) > 2. Access to a Map of all Configurations. The map would have the > configuration class as the Key and contain an object such a list or map that > contains the configuration. > 3. Access to a list of configured services. > From this it should be possible to build documentation of a running system. > Thanks > Barry -- This message was sent by Atlassian JIRA (v6.2#6252)
[jira] [Comment Edited] (TAP5-2192) Add support for distributed documentation
[
https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14054435#comment-14054435
]
Lance edited comment on TAP5-2192 at 7/8/14 9:05 AM:
-
Barry, for point 2. of this jira (accessing configuration info) you can't have
a map by class since there can be multiple services for a service interface.
I'd say a listener approach might be better
{code}
public interface ContributionListener {
void onConfigureList(ServiceDescriptor d, List l);
void onConfigureMap(ServiceDescriptor d, Map m);
void onConfigureCollection(ServiceDescriptor d, Collection c);
}
public interface ServiceDescriptor {
Class getServiceInterface();
String getServiceId();
Set getMarkers();
}
{code}
I guess that ServiceDef should extend this new ServiceDescriptor interface too:
http://tapestry.apache.org/5.3/apidocs/org/apache/tapestry5/ioc/def/ServiceDef.html
was (Author: uklance):
Barry, for point 2. of this jira (accessing configuration info) you can't have
a map by class since there can be multiple services for a service interface.
I'd say a listener approach might be better
{code}
public interface ContributionListener {
void onConfigureList(ServiceDescriptor d, List l);
void onConfigureMap(ServiceDescriptor d, Map m);
void onConfigureCollection(ServiceDescriptor d, Collection c);
}
public interface ServiceDescriptor {
Class getServiceInterface();
String getServiceId();
List> getMarkers();
}
{code}
> Add support for distributed documentation
> -
>
> Key: TAP5-2192
> URL: https://issues.apache.org/jira/browse/TAP5-2192
> Project: Tapestry 5
> Issue Type: Improvement
>Affects Versions: 5.4
>Reporter: Barry Books
>Assignee: Thiago H. de Paula Figueiredo
> Labels: documentation, month-of-tapestry
>
> Please add support for a distributed documentation system. The basic
> requirements are:
> 1. Access to a list of Pages/Compoents/Mixins. (ComponentClassResolver
> supports pages)
> 2. Access to a Map of all Configurations. The map would have the
> configuration class as the Key and contain an object such a list or map that
> contains the configuration.
> 3. Access to a list of configured services.
> From this it should be possible to build documentation of a running system.
> Thanks
> Barry
--
This message was sent by Atlassian JIRA
(v6.2#6252)
