[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=14053728#comment-14053728 ] Lance commented on TAP5-2192: - I'm looking at ComponentLibraryInfo and I think that these details are outside of tapestry's scope. Homepage url for a library? Source root for a library? I really don't think that tapestry should be concerning itself with such information. > 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=14053728#comment-14053728 ] Lance edited comment on TAP5-2192 at 7/7/14 3:03 PM: - I'm looking at ComponentLibraryInfo and I think that these details are outside of tapestry's scope. Homepage url for a library? Source root for a library? I really don't think that tapestry should be concerning itself with such information. Perhaps a maven plugin or gradle plugin could generate a service to provide this but I really don't feel it's tapestry's job. was (Author: uklance): I'm looking at ComponentLibraryInfo and I think that these details are outside of tapestry's scope. Homepage url for a library? Source root for a library? I really don't think that tapestry should be concerning itself with such information. > 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=14053728#comment-14053728 ] Lance edited comment on TAP5-2192 at 7/7/14 3:28 PM: - I'm looking at ComponentLibraryInfo and I think that these details are outside of tapestry's scope. Homepage url for a library? Source root for a library? I really don't think that tapestry should be concerning itself with such information. Perhaps a maven plugin or gradle plugin could generate a service to provide this but I really don't feel it's tapestry's job. Since these attributes are already available in maven/gradle I feel this breaks the DRY principle too. was (Author: uklance): I'm looking at ComponentLibraryInfo and I think that these details are outside of tapestry's scope. Homepage url for a library? Source root for a library? I really don't think that tapestry should be concerning itself with such information. Perhaps a maven plugin or gradle plugin could generate a service to provide this but I really don't feel it's tapestry's job. > 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=14053969#comment-14053969 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - Hello, Lance! This code I'm writing isn't trying to show the same information which is already provided by Maven metadata. It goes beyond that, including information not provided by Maven. My intention is to easily provide information and links about components, pages and mixins. It's used in a new page (actually, a tab of T5Dashboard) so you can easily and quickly go from inside your webapp to the library URL, documentation, JavaDoc, etc. In addition, it'll provide links to JavaDoc and source in a class-by-class basis. These last two pieces of data aren't provided by the Maven/etc metadata, with ComponentLibraryInfo or a subclass taking care of specifics like source code folder convention and Git/SVN/etc web viewers. I don't think there's a place in pom.xml to specify the documentation or JavaDoc URL, just the project URL. > 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=14054016#comment-14054016 ] Lance commented on TAP5-2192: - I can see what you're doing but I still feel this is outside of tapestry's scope. I also feel is outside of the scope of this jira. Barry wanted access to the list of mixins, components and pages and also the services and their contributions. All of this is I agree with is inside tapestry's scope. But I feel that requiring javadoc roots, dependency versions and source repositories etc is definitely not tapestry's job. This is much better handled by a dependency management framework such as maven or gradle. > 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=14054020#comment-14054020 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - Lance, all that information in ComponentLibraryInfo is completely optional. Even ComponentLibraryInfo itself is optional. What I'm doing is beyond the scope of the ticket, but that's something related I still wanted to do: a very easy way to view the JavaDoc and source of component, page and mixin classes. > 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=14054034#comment-14054034 ] Lance commented on TAP5-2192: - I suggest you write a gradle plugin then rather than doing it in tapestry core. Then you wouldn't be limited to component libraries either if you wanted to expand it to all dependencies (eg log4j etc, etc). You also have lots of existing info on the dependencies in gradle. > 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=14054046#comment-14054046 ] Lance commented on TAP5-2192: - Let's think about this... How does a library developer keep the version number up to date? Will this be updated by the maven release plugin? > 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=14054050#comment-14054050 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - Lance, I still need more information than available in Maven or Gradle to do what I did. And I don't want to constrain the library component writers on what build tool they want to use (if any). I agree that updating the version number would be a problem. And that we could find a way to fill parts of ComponentLibraryInfo from Maven or Gradle information. > 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=14054051#comment-14054051 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - By the way, have you tried it yet? If not, please do it. I'd love to hear your feedback. :) > 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=14054080#comment-14054080 ] Lance commented on TAP5-2192: - If this was a gradle plugin, you would have direct access to the javadoc html (through the javadoc artifact) and the source code (through the sources artifact). This would eliminate the need for a sources root and a javadoc root. You'd also have access to the dependency version numbers which is much better than forcing library authors to maintain the version number in two places. This would be a great gradle plugin. You could auto-generate a service that could be used in many more places than just tapestry webapps. > 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=14054080#comment-14054080 ] Lance edited comment on TAP5-2192 at 7/7/14 7:32 PM: - If this was a gradle plugin, you would have direct access to the javadoc html (through the javadoc artifact) and the source code (through the sources artifact). This would eliminate the need for a sources root and a javadoc root. You'd also have access to the dependency version numbers which is much better than forcing library authors to maintain the version number in two places. This would be a great gradle plugin. You could auto-generate a service that could be used in many more places than just tapestry webapps. After thinking about this more... I am even more convinced this should be handled at build time (in gradle) and NOT by tapestry. was (Author: uklance): If this was a gradle plugin, you would have direct access to the javadoc html (through the javadoc artifact) and the source code (through the sources artifact). This would eliminate the need for a sources root and a javadoc root. You'd also have access to the dependency version numbers which is much better than forcing library authors to maintain the version number in two places. This would be a great gradle plugin. You could auto-generate a service that could be used in many more places than just tapestry webapps. > 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=14054080#comment-14054080 ] Lance edited comment on TAP5-2192 at 7/7/14 7:32 PM: - If this was a gradle plugin, you would have direct access to the javadoc html (through the javadoc artifact) and the source code (through the sources artifact). This would eliminate the need for a sources root and a javadoc root. You'd also have access to the dependency version numbers which is much better than forcing library authors to maintain the version number in two places (lets consider CI builds where it changes every checkin). This would be a great gradle plugin. You could auto-generate a service that could be used in many more places than just tapestry webapps. After thinking about this more... I am even more convinced this should be handled at build time (in gradle) and NOT by tapestry. was (Author: uklance): If this was a gradle plugin, you would have direct access to the javadoc html (through the javadoc artifact) and the source code (through the sources artifact). This would eliminate the need for a sources root and a javadoc root. You'd also have access to the dependency version numbers which is much better than forcing library authors to maintain the version number in two places. This would be a great gradle plugin. You could auto-generate a service that could be used in many more places than just tapestry webapps. After thinking about this more... I am even more convinced this should be handled at build time (in gradle) and NOT by tapestry. > 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=14054096#comment-14054096 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - If this was a Gradle plugin, lots of component libraries wouldn't use it because they don't use Gradle (mine included). > 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=14054102#comment-14054102 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - And even if this was a Gradle plugin, the ComponentLibraryInfo class would still need to exist for the Component Libraries tab of the T5Components page to work. This information needs to be structure in a class no matter where the information source is, so I think this part of the conversation is moot. The information in it would just come from a different place (from the Gradle plugin instead of hardwired in 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)
[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=14054104#comment-14054104 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - And I need that information in runtime, unless you want the Component Libraries page/tab to be discarded completely. > 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=14054122#comment-14054122 ] Lance commented on TAP5-2192: - Yes, my big complaint is asking library authors to reliably give us this information and keep it up to date. By asking for a javadoc / sources URL I can only assume that you are also wanting component authors to publish their javadoc / sources to a public URL. IMHO it's better to add the sources / javadoc artifacts to the classpath and access from there. > 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=14054129#comment-14054129 ] Lance commented on TAP5-2192: - BTW if you wrote this as an ant task it could work in maven, ant and gradle > 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=14054122#comment-14054122 ] Lance edited comment on TAP5-2192 at 7/7/14 8:01 PM: - Yes, my big complaint is asking library authors to reliably give us this information and keep it up to date. I also feel that this getting out of scope for what tapestry is (an ioc container and a web framework). By asking for a javadoc / sources URL I can only assume that you are also wanting component authors to publish their javadoc / sources to a public URL. IMHO it's better to add the sources / javadoc artifacts to the classpath and access from there. was (Author: uklance): Yes, my big complaint is asking library authors to reliably give us this information and keep it up to date. By asking for a javadoc / sources URL I can only assume that you are also wanting component authors to publish their javadoc / sources to a public URL. IMHO it's better to add the sources / javadoc artifacts to the classpath and access from there. > 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] [Issue Comment Deleted] (TAP5-2192) Add support for distributed documentation
[ https://issues.apache.org/jira/browse/TAP5-2192?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Lance updated TAP5-2192: Comment: was deleted (was: BTW if you wrote this as an ant task it could work in maven, ant and gradle) > 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=14054145#comment-14054145 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - Lance, have you tried the page I wrote? It seems to me we're not discussing the same thing. All that information is absolutely optional. It's more targeted at open source component libraries, of course, so the sources are already published to a public URL in this case. The only information there which changes often is the version. I can remove that. I'm not sure what this Ant task would do. Generate some file to be added to the JAR contents to be read later by the Component Libraries page? Or do you want it to be removed completely? Again, I'm not trying to replace or reimplement dependency management tools, just provide information about all the component libraries used in a webapp in the easiest way possible. > 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=14054150#comment-14054150 ] Lance commented on TAP5-2192: - I haven't tried the page but I'm pretty sure it's linking to javadoc and sources and stuff like that. I feel that these sorts of reports are jobs for the IDE and the build tool. Not a web framework. > 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=14054154#comment-14054154 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - So please try it and tell me whether it still has any redeeming value. > 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=14054161#comment-14054161 ] Thiago H. de Paula Figueiredo commented on TAP5-2192: - My point is this is all very specific about component libraries, not just generic dependencies. > 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=14054175#comment-14054175 ] Lance commented on TAP5-2192: - I do owe you the common courtesy of trying it out... I don't have my dev box here tonight. I'll give it a try when I do. But I feel that version numbers, artifact ids, javadoc urls and source roots should not be configured inside tapestry. It just doesn't belong here This feels more like a javadoc doclet or similar build time report. Or an ide plugin. > 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=14054271#comment-14054271
]
Lance commented on TAP5-2192:
-
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be implemented / overrided. Perhaps
driven by an XML file generated at build time etc.
> 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=14054271#comment-14054271
]
Lance edited comment on TAP5-2192 at 7/7/14 11:11 PM:
--
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be implemented / overrided. Perhaps
driven by an XML file generated at build time etc. Using Resource also allows
javadoc to be sourced from classpath or a URL etc.
was (Author: uklance):
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be implemented / overrided. Perhaps
driven by an XML file generated at build time etc.
> 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=14054271#comment-14054271
]
Lance edited comment on TAP5-2192 at 7/7/14 11:12 PM:
--
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
was (Author: uklance):
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be implemented / overrided. Perhaps
driven by an XML file generated at build time etc. Using Resource also allows
javadoc to be sourced from classpath or a URL etc.
> 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=14054271#comment-14054271
]
Lance edited comment on TAP5-2192 at 7/7/14 11:13 PM:
--
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String URL's. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
was (Author: uklance):
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
> 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=14054271#comment-14054271
]
Lance edited comment on TAP5-2192 at 7/7/14 11:14 PM:
--
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String URL's. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
This feels much more like 'the tapestry way' of doing things.
was (Author: uklance):
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String URL's. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
> 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=14054271#comment-14054271
]
Lance edited comment on TAP5-2192 at 7/8/14 12:09 AM:
--
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String URL's. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Or better yet,
library authors could add the maven version / artifact to the jar manifest and
the service could look it up.
Using Resource also allows javadoc and sources to be sourced from classpath or
a URL etc.
This feels much more like 'the tapestry way' of doing things.
was (Author: uklance):
How's this for a compromise... my main problem is requiring the configuration
inside tapestry. I don't necessarily mind that it's modelled inside tapestry.
1. Remove getComponentLibraryInfo() from LibraryMapping
2. Add ComponentLibraryInfoSource
{code}
public interface ComponentLibraryInfoSource {
ComponentLibraryInfo getComponentLibraryInfo(String libraryName);
}
{code}
3. Change ComponentLibraryInfo to use Resource instead of String URL's. eg
{code}
public interface ComponentLibraryInfo {
Resource getHomePageRoot();
Resource getSourceRoot();
Resource getJavadocRoot();
// etc
}
{code}
This way, ComponentLibraryInfoSource could be contributed to and overridden.
Perhaps driven by an XML file generated at build time etc. Using Resource also
allows javadoc to be sourced from classpath or a URL etc.
This feels much more like 'the tapestry way' of doing things.
> 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=14054366#comment-14054366
]
Barry Books commented on TAP5-2192:
---
I created this Jira because I started writing a documentation module and found
that to be impossible because there is no way to get a list of what's
installed. I think it would also be useful to have a documentation mapped
configuration that modules could contribute to if they want to. As Lance said
it would be useful to define these interfaces in Tapestry but I think the code
that shows the documentation should be in a separate module
(tapestry-documentaton?). This way if you include that you get it. Personally I
would want it on my development machine but not in production. This way if a
module cares to it could add something like this to it's module.
@Contribute(ModuleDocumentationService.class)
public static void arbitraryMethodName(MappedConfiguration configuration)
{
configuration.add("ModuleName", new My ComponentLibraryInfo());
}
This way core just needs to define two interfaces. One for the Service and one
for the Documentation. The service one is easy it just needs to return the
configuration map. I think Lance's ComonentLibraryInfo is a good start.
> 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=14054435#comment-14054435
]
Lance commented on TAP5-2192:
-
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 ConfigurationListener {
void onConfigureList(ServiceDescriptor d, List l);
void onConfigureMap(ServiceDescriptor d, Map m);
void onConfigureCollection(ServiceDescriptor d, Collection c);
}
{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)
[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=14054438#comment-14054438 ] Barry Books commented on TAP5-2192: --- In 2 I was referring to configurations such as Map, Ordered etc. I though you could only have one configuration per service. If that's not the case or you solution provides more data the mechanism does not really matter to me. > 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=1405#comment-1405 ] Lance commented on TAP5-2192: - Yes, the ServiceDescriptor would be the combination of service interface, service id and any marker annotations. > 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 2:41 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);
}
{code}
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 ConfigurationListener {
void onConfigureList(ServiceDescriptor d, List l);
void onConfigureMap(ServiceDescriptor d, Map m);
void onConfigureCollection(ServiceDescriptor d, Collection c);
}
{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)
[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 2:55 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 ServiceDescriptor would be the combination of service interface, service id and any marker annotations. All these combined uniquely identify a service. was (Author: uklance): Yes, the ServiceDescriptor would be the combination of service interface, service id and any marker annotations. > 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 3:03 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 getInterface();
String getId();
List getMarkers();
}
{code}
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);
}
{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)
[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 3: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 getInterface();
String getId();
List> getMarkers();
}
{code}
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 getInterface();
String getId();
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)
[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 3:13 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();
List> getMarkers();
}
{code}
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 getInterface();
String getId();
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)
