Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.7
    • Component/s: pge wrapper framework
    • Labels:
      None

      Description

      Whip up a user guide (akin to http://oodt.apache.org/components/maven/filemgr/user/) that documents the CAS PGE architecture, and its extension point and object model.

      1. CAS-PGE_learn_by_example.docx
        123 kB
        Rishi Verma
      2. developer.html
        8 kB
        Rishi Verma
      3. fileconcatenator-pge.tar
        30 kB
        Rishi Verma
      4. OODT-217.2011-06-22.patch.txt
        8 kB
        Rishi Verma
      5. pge_instance_plugin_points.png
        69 kB
        Rishi Verma

        Issue Links

          Activity

          Chris A. Mattmann created issue -
          Hide
          Rishi Verma added a comment -

          Hi Chris,

          I'm working on transferring some of the content written about PGE (section 21) in [1] to xdoc for CAS-PGE.

          I think, in particular, the architecture and overview portions of [1] are very useful for import. The example given at the end of the document may first need to be simplified, as well as tested against 0.3-SNAPSHOT, before performing any import. Cameron and I have been discussing how to proceed with the given example.

          [1] https://svn.apache.org/repos/asf/oodt/branches/wengine-branch/wengine/src/main/resources/documentation/UserGuide.doc

          Show
          Rishi Verma added a comment - Hi Chris, I'm working on transferring some of the content written about PGE (section 21) in [1] to xdoc for CAS-PGE. I think, in particular, the architecture and overview portions of [1] are very useful for import. The example given at the end of the document may first need to be simplified, as well as tested against 0.3-SNAPSHOT, before performing any import. Cameron and I have been discussing how to proceed with the given example. [1] https://svn.apache.org/repos/asf/oodt/branches/wengine-branch/wengine/src/main/resources/documentation/UserGuide.doc
          Hide
          Chris A. Mattmann added a comment -

          Thanks Rishi. Awesome. I'd love to work on this with you.

          Show
          Chris A. Mattmann added a comment - Thanks Rishi. Awesome. I'd love to work on this with you.
          Rishi Verma made changes -
          Field Original Value New Value
          Attachment developer.html [ 12483474 ]
          Attachment OODT-217.2011-06-22.patch.txt [ 12483475 ]
          Attachment pge_instance_plugin_points.png [ 12483476 ]
          Hide
          Rishi Verma added a comment -

          Hey Chris,

          I've started a very basic developer guide, based on parts of Brian Foster's Workflow UserGuide. Let me know what you think.

          Wanted to mention the following though:
          [1] I've left 'Architecture' section blank for now. I don't think the UserGuide really explained the architecture of CAS-PGE in detail, or perhaps I just did not recognize it in the text.
          [2] The image (pge_instance_plugin_points.png) image attached is in a different diagram style than most OODT documentation diagrams. If you could let me know which tool was used to generate images in documentation like Workflow components, I'd be happy to convert the attached image to the desired style.
          [3] We would need an example for the user to follow. I think that should go in a separate page called 'Basic Users Guide'.

          Show
          Rishi Verma added a comment - Hey Chris, I've started a very basic developer guide, based on parts of Brian Foster's Workflow UserGuide. Let me know what you think. Wanted to mention the following though: [1] I've left 'Architecture' section blank for now. I don't think the UserGuide really explained the architecture of CAS-PGE in detail, or perhaps I just did not recognize it in the text. [2] The image (pge_instance_plugin_points.png) image attached is in a different diagram style than most OODT documentation diagrams. If you could let me know which tool was used to generate images in documentation like Workflow components , I'd be happy to convert the attached image to the desired style. [3] We would need an example for the user to follow. I think that should go in a separate page called 'Basic Users Guide'.
          Hide
          Cameron Goodale added a comment -

          Rishi,

          I looked over your files and this looks like a really solid place to start from. The image you are talking about appears to be from OmniGraffle judging by the boxes and drop shadows. I will take the action of converting your colorful image into a more OODT-esque version and attach it to this issue for review.

          Show
          Cameron Goodale added a comment - Rishi, I looked over your files and this looks like a really solid place to start from. The image you are talking about appears to be from OmniGraffle judging by the boxes and drop shadows. I will take the action of converting your colorful image into a more OODT-esque version and attach it to this issue for review.
          Hide
          Rishi Verma added a comment -

          Was wondering how that was made, thanks Cameron! Appreciate your help on this.

          Show
          Rishi Verma added a comment - Was wondering how that was made, thanks Cameron! Appreciate your help on this.
          Hide
          Rishi Verma added a comment -

          Wrote up a tutorial that takes a user step-by-step through the process of setting up and deploying a sample PGE. It's in MS-word format, but I will convert it to xdoc soon (easier to review in its current format). I've also attached the sample project (.tar).

          Let me know if you have any comments!

          rishi

          Show
          Rishi Verma added a comment - Wrote up a tutorial that takes a user step-by-step through the process of setting up and deploying a sample PGE. It's in MS-word format, but I will convert it to xdoc soon (easier to review in its current format). I've also attached the sample project (.tar). Let me know if you have any comments! rishi
          Rishi Verma made changes -
          Attachment fileconcatenator-pge.tar [ 12489555 ]
          Attachment CAS-PGE_learn_by_example.docx [ 12489556 ]
          Hide
          Chris A. Mattmann added a comment -
          • push to 0.5
          Show
          Chris A. Mattmann added a comment - push to 0.5
          Chris A. Mattmann made changes -
          Fix Version/s 0.5 [ 12320441 ]
          Fix Version/s 0.4 [ 12316498 ]
          Hide
          Chris A. Mattmann added a comment -
          • push out to 0.5
          Show
          Chris A. Mattmann added a comment - push out to 0.5
          Hide
          Chris A. Mattmann added a comment -
          • push out to 0.6
          Show
          Chris A. Mattmann added a comment - push out to 0.6
          Chris A. Mattmann made changes -
          Fix Version/s 0.6 [ 12323845 ]
          Fix Version/s 0.5 [ 12320441 ]
          Chris A. Mattmann made changes -
          Fix Version/s 0.7 [ 12323889 ]
          Fix Version/s 0.6 [ 12323845 ]
          Chris A. Mattmann made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          Chris A. Mattmann made changes -
          Link This issue is part of OODT-171 [ OODT-171 ]
          Hide
          Chris A. Mattmann added a comment -
          • patches and code applied in r1564791. Thanks Rishi and Brian!
          Show
          Chris A. Mattmann added a comment - patches and code applied in r1564791. Thanks Rishi and Brian!
          Chris A. Mattmann made changes -
          Status In Progress [ 3 ] Resolved [ 5 ]
          Resolution Fixed [ 1 ]

            People

            • Assignee:
              Chris A. Mattmann
              Reporter:
              Chris A. Mattmann
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development