Announcement Announcement Module
Collapse
No announcement yet.
Spring Roo Command Reference Guide Maven Plugin Page Title Module
Move Remove Collapse
X
Conversation Detail Module
Collapse
  • Filter
  • Time
  • Show
Clear All
new posts

  • Spring Roo Command Reference Guide Maven Plugin

    Hi,

    We built a custom Maven plugin for generating reference guide for the Spring Surf ( http://www.springsurf.org/ ) Roo commands.

    Since this Maven plugin can also be used for other Roo Addons and is available in Alfresco public Maven repo, we think it might be worthwhile to share it with Spring Roo community.

    http://www.springsurf.org/roodocplugin/sites/1.0.0/

    Please let us know if you have any comment/feedback.

    Thanks!

    Yong

  • #2
    Hi Yong,

    This is interesting . Currently we have a 'reference guide' command which does this automated for us, but a Maven plugin would certainly be more convenient. Can we generate our normal styles to this so we get the same template applied as shown here?

    Cheers

    Comment


    • #3
      Hi, Stefan

      This plugin is based on that Roo command. Here is the document generated for Spring Surf

      http://www.springsurf.org/sites/1.0....and-index.html

      We use same template :-)

      Thanks!

      Yong

      Comment


      • #4
        Hi Yong,

        Ben and I will take a closer look sometime this week. Thanks for your offering, it looks good.

        Comment


        • #5
          Just taking a look at the Surf-generated docs, I think it doesn't include the last-minute enhancements I made to the auto-generation model in https://jira.springsource.org/browse/ROO-487. It makes the reference guide much more informative for users, as it shows defaults etc.

          At a broader level we are presently planning our major feature improvements for the next few releases. On my list is add-on discovery and central indexing. It may prove a better idea to make some sort of auto-maintained central web site contain these generated reference guide pages. We could even extend it so people could search for an add-on that provides a command they're looking for. So they could type "find surf setup" and it would show that the "surf setup" command is part of the Spring Surf add-on. There's no reason metadata about add-on commands can't be included in automatically-derived metadata for the add-on repository model.

          Actually that example command reminds me.... It would be recommended if you could rename the "install surf" command to "surf setup", for consistency with all of the other Roo commands. We made a large number of renames as part of https://jira.springsource.org/browse/ROO-232 so you might like to take a look there for how the conventions changed if interested.

          Cheers
          Ben

          Comment

          Working...
          X