Kuali Rice Roadmap
  1. Kuali Rice Roadmap
  2. KRRM-128

Create improved and comprehensive documentation on how to use the KRAD development framework

    Details

    • Type: Rice Enhancement Rice Enhancement
    • Status: Resolved Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Component/s: KRAD
    • Labels:
      None
    • Rice Theme:
      Development Ease of Use
    • Priority Score:
      0
    • Impact if not Implemented:
      New developers will continue to have an extremely steep learning curve when starting to use Kuali applications based on Rice. Core Rice developers will spend more time answering questions on mailing lists.
    • Priority - KFS:
      No Priority
    • Priority - KC:
      No Priority
    • Priority - KS:
      No Priority
    • Priority - Rice:
      No Priority
    • Effort Estimate:
      Medium ~ 500 hrs

      Description

      This issue was broken off from KRRM-71.

      With the current KNS documentation, there are bits and pieces related to how to use it to build an application. However, much of it is still a bit mysterious. In order for us to promote KRAD as "rapid", we really need to have a good set of documentation in support of it.

      At the very least this should include reference documentation and tutorials on how to create the following:

      1) Business Objects (including database mapping and db definition)
      2) Business Object metadata in Data Dictionary files
      3) Maintenance documents and related DD files
      4) Transactional documents and related DD files
      5) Permissions (KIM integration)
      6) Workflow (KEW integration)

      As mentioned, I think these come in two forms:

      1) Reference documentation - much of this could be contained within javadoc, but there will still need to be some scaffolding around it in our main documentation body to help people find what they need.
      2) Tutorials - take them through the process of building an application using the framework. Start small and work your way up to more advanced features include KEW, KIM integration and other such features.

        Issue Links

          Activity

          Hide
          Eric Westfall added a comment -

          Note that some of this work is already being done concurrent with the KRAD effort as they have a contracted resource working on those documents. Though I doubt they will cover all that I have lain out in the description of this issue.

          Show
          Eric Westfall added a comment - Note that some of this work is already being done concurrent with the KRAD effort as they have a contracted resource working on those documents. Though I doubt they will cover all that I have lain out in the description of this issue.
          Hide
          Eric Westfall added a comment -

          Linked as "discovered by" KRRM-71 since this is one part of that larger issue.

          Show
          Eric Westfall added a comment - Linked as "discovered by" KRRM-71 since this is one part of that larger issue.
          Hide
          Matt Sargent added a comment -

          Much of this has been done and is part of the delivered Rice documentation. There's on going work to fill in some of the "coming soon" heavy chapters through time set aside from documentation and testing as part of each milestone. The second part, tutorials, may need some attention though.

          Show
          Matt Sargent added a comment - Much of this has been done and is part of the delivered Rice documentation. There's on going work to fill in some of the "coming soon" heavy chapters through time set aside from documentation and testing as part of each milestone. The second part, tutorials, may need some attention though.
          Hide
          Jessica Coltrin (Inactive) added a comment -

          Some tutorials and exercises are available as part of Jerry's KRAD training if someone wants to attend that.

          Show
          Jessica Coltrin (Inactive) added a comment - Some tutorials and exercises are available as part of Jerry's KRAD training if someone wants to attend that.
          Hide
          Matt Sargent added a comment -

          see notes for progress

          Show
          Matt Sargent added a comment - see notes for progress
          Hide
          Jessica Coltrin (Inactive) added a comment -

          Jerry's training manual plus documentation on transactional documents and other new features will be provided as part of the 2.2 release. Exercises will continue to be provided through Jerry's KRAD training which he provides on his own time.

          Show
          Jessica Coltrin (Inactive) added a comment - Jerry's training manual plus documentation on transactional documents and other new features will be provided as part of the 2.2 release. Exercises will continue to be provided through Jerry's KRAD training which he provides on his own time.

            People

            • Assignee:
              Unassigned
              Reporter:
              Eric Westfall
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Structure Helper Panel