Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.3.0
    • Fix Version/s: 0.3.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      We need more documentation, particularly for users and programmers.

      1. moredocs.patch
        14 kB
        Ari Rabkin
      2. programmerDocs.patch
        36 kB
        Ari Rabkin

        Activity

        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open Patch Available Patch Available
        1m 12s 1 Ari Rabkin 15/Jul/09 00:51
        Resolved Resolved Reopened Reopened
        14d 14h 12m 1 Ari Rabkin 31/Jul/09 22:03
        Reopened Reopened Patch Available Patch Available
        7m 23s 1 Ari Rabkin 31/Jul/09 22:10
        Patch Available Patch Available Resolved Resolved
        5d 6h 26m 2 Ari Rabkin 03/Aug/09 21:38
        Hide
        Hudson added a comment -
        Show
        Hudson added a comment - Integrated in Chukwa-trunk #112 (See http://hudson.zones.apache.org/hudson/job/Chukwa-trunk/112/ )
        Ari Rabkin made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Ari Rabkin added a comment -

        I just committed this.

        Show
        Ari Rabkin added a comment - I just committed this.
        Hide
        Ari Rabkin added a comment -

        Just updated relnotes, by committing chukwa-333 to trunk. Should be modified again before 0.3 release.

        Show
        Ari Rabkin added a comment - Just updated relnotes, by committing chukwa-333 to trunk. Should be modified again before 0.3 release.
        Ari Rabkin made changes -
        Component/s documentation [ 12312727 ]
        Hide
        Eric Yang added a comment -

        Release note and change logs requires update. Change log is generated from CHANGES.txt, release note is in src/docs/releasenotes.html.

        Show
        Eric Yang added a comment - Release note and change logs requires update. Change log is generated from CHANGES.txt, release note is in src/docs/releasenotes.html.
        Hide
        Ari Rabkin added a comment -

        By the way, I'm keeping the latest-greatest working documentation on my personal website: http://www.cs.berkeley.edu/~asrabkin/chukwa

        Berkeley is basically running Chukwa-trunk, so we actually need the trunk documentation. (We're actually often slightly ahead of Trunk, since I push features and fixes into production here before posting the patches to JIRA)

        Show
        Ari Rabkin added a comment - By the way, I'm keeping the latest-greatest working documentation on my personal website: http://www.cs.berkeley.edu/~asrabkin/chukwa Berkeley is basically running Chukwa-trunk, so we actually need the trunk documentation. (We're actually often slightly ahead of Trunk, since I push features and fixes into production here before posting the patches to JIRA)
        Hide
        Eric Yang added a comment -

        +1 for reuse the same JIRA.

        Show
        Eric Yang added a comment - +1 for reuse the same JIRA.
        Ari Rabkin made changes -
        Status Reopened [ 4 ] Patch Available [ 10002 ]
        Hide
        Ari Rabkin added a comment -

        Ready for review.

        By the way, for this sort of ongoing activity, is there a preference between reusing the same JIRA versus opening new ones? I find reusing the issue more intuitive, but I'm happy to do it the other way if there's a reason.

        Show
        Ari Rabkin added a comment - Ready for review. By the way, for this sort of ongoing activity, is there a preference between reusing the same JIRA versus opening new ones? I find reusing the issue more intuitive, but I'm happy to do it the other way if there's a reason.
        Ari Rabkin made changes -
        Attachment moredocs.patch [ 12415181 ]
        Hide
        Ari Rabkin added a comment -

        This patch documents command-line options for agent and collector.

        Show
        Ari Rabkin added a comment - This patch documents command-line options for agent and collector.
        Ari Rabkin made changes -
        Resolution Fixed [ 1 ]
        Status Resolved [ 5 ] Reopened [ 4 ]
        Hide
        Ari Rabkin added a comment -

        More docs to add

        Show
        Ari Rabkin added a comment - More docs to add
        Ari Rabkin made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        Ari Rabkin added a comment -

        I just committed this. Slightly modified from patch – added documentation for xtrace adaptor in contrib (from CHUKWA-352).

        Show
        Ari Rabkin added a comment - I just committed this. Slightly modified from patch – added documentation for xtrace adaptor in contrib (from CHUKWA-352 ).
        Ari Rabkin made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Ari Rabkin made changes -
        Field Original Value New Value
        Attachment programmerDocs.patch [ 12413500 ]
        Hide
        Ari Rabkin added a comment -

        Added user and programmer guides.

        Moved 0.1.2 docs into subfolder.

        Show
        Ari Rabkin added a comment - Added user and programmer guides. Moved 0.1.2 docs into subfolder.
        Ari Rabkin created issue -

          People

          • Assignee:
            Ari Rabkin
            Reporter:
            Ari Rabkin
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development