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

        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/ )
        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.
        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.
        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.
        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.
        Hide
        Ari Rabkin added a comment -

        More docs to add

        Show
        Ari Rabkin added a comment - More docs to add
        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 ).
        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.

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development