Details

      Description

      For my latest software project we will be using CAS-PGE, and when I looked up documentation to explain how to setup, install and config PGE I found nothing.

      To help the community collaborate and create some great documentation on this component I have started a wiki page at:

      https://cwiki.apache.org/confluence/display/OODT/CAS-PGE+Help+and+Documentation

      I have stared with some basic organization of the wiki, and dropped in some questions I hope to answer in the following weeks.

      Once the wiki is filled in and complete enough for a Basic User Guide, this issue can be closed once the following GOALS are met.

      1. A README.txt file has been created and included with the PGE components source code, for off-line documentation

      2. PGE Page @ http://oodt.apache.org/components/maven/pge/ includes a link to a page for Basic User Guide Under the Software Documentation Heading like the File Manager does, for online documentation.

        Issue Links

          Activity

          Hide
          Chris A. Mattmann added a comment -
          • with the addition of the docs written by Cam on the wiki, Rishi on the learn by example, along with Brian Foster and the last 20 pages of the wengine guide, we're good here.
          Show
          Chris A. Mattmann added a comment - with the addition of the docs written by Cam on the wiki, Rishi on the learn by example, along with Brian Foster and the last 20 pages of the wengine guide, we're good here.
          Hide
          Chris A. Mattmann added a comment -
          • push out to 0.6
          Show
          Chris A. Mattmann added a comment - push out to 0.6
          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 to 0.5
          Show
          Chris A. Mattmann added a comment - push to 0.5
          Hide
          Brian Foster added a comment -

          Cameron . . . ya it was painfully writing that! . . . took like 2-3 full-time weeks to knock that out . . . the cas-pge doc is for the wengine branched version, which is pretty much same as the trunk, except for reserved metadata fields which are named slightly different and file staging does not exist in the trunk version.

          Show
          Brian Foster added a comment - Cameron . . . ya it was painfully writing that! . . . took like 2-3 full-time weeks to knock that out . . . the cas-pge doc is for the wengine branched version, which is pretty much same as the trunk, except for reserved metadata fields which are named slightly different and file staging does not exist in the trunk version.
          Hide
          Chris A. Mattmann added a comment -
          • can't be a fix for 0.2, 0.2 was already released.
          Show
          Chris A. Mattmann added a comment - can't be a fix for 0.2, 0.2 was already released.
          Hide
          Cameron Goodale added a comment -

          Brian,

          That is exactly what I was looking for. Now I need to read the last 20,
          then read 'em again a few more times to try and boil it down to something
          a new User can grasp. I do see the potential for the rest of the material
          to be used to build an Advanced User Guide for sure. How many man years
          did you spend on this document? It looks incredibly thorough.

          Sincerely,

          Cameron

          Show
          Cameron Goodale added a comment - Brian, That is exactly what I was looking for. Now I need to read the last 20, then read 'em again a few more times to try and boil it down to something a new User can grasp. I do see the potential for the rest of the material to be used to build an Advanced User Guide for sure. How many man years did you spend on this document? It looks incredibly thorough. Sincerely, Cameron
          Show
          Brian Foster added a comment - check out the last 20 or so pages of: https://svn.apache.org/repos/asf/oodt/branches/wengine-branch/wengine/src/main/resources/documentation/UserGuide.doc

            People

            • Assignee:
              Cameron Goodale
              Reporter:
              Cameron Goodale
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Due:
                Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 8h
                8h
                Remaining:
                Remaining Estimate - 8h
                8h
                Logged:
                Time Spent - Not Specified
                Not Specified

                  Development