Bigtop
  1. Bigtop
  2. BIGTOP-1031

README has outdated/ambiguous information

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.6.0
    • Fix Version/s: 0.7.0
    • Component/s: documentation
    • Environment:

      All

      Description

      Readme has some incorrect/obsolete paths and the "packaging" example is somewhat confusing since, in fact, "packaging" is a maven term as well as a bigtop smoke. Also, "cd" to the directory is unnecessary (just use mvn -f to specify pom). Also, add more examples.

      1. BIGTOP-1031.2.patch
        6 kB
        jay vyas
      2. BIGTOP-1031.1.patch
        3 kB
        jay vyas
      3. README.patch
        3 kB
        jay vyas

        Activity

        Hide
        jay vyas added a comment -

        This is a patch for the README in bigtop which has an extra example, as well as corrected paths and simpler mvn invocations.

        Show
        jay vyas added a comment - This is a patch for the README in bigtop which has an extra example, as well as corrected paths and simpler mvn invocations.
        Hide
        Mark Grover added a comment -

        Hi Jay, thanks for contributing! It looks good to me. May I request you to provide a patch via git format-patch, please?

        This the workflow I personally follow:
        1. Ensure that you have all of your change as 1 commit which has the correct commit message - something like BIGTOP-1031: README has outdated/ambiguous information
        2. Then run a command like: git format-patch HEAD^..HEAD --stdout > BIGTOP-1031.1.patch
        3. Upload the BIGTOP-1031.1.patch file to this JIRA

        git format-patch works better for all of us because it's easy to attribute the commit to you in the git history since it contains your name and email address.

        Show
        Mark Grover added a comment - Hi Jay, thanks for contributing! It looks good to me. May I request you to provide a patch via git format-patch , please? This the workflow I personally follow: 1. Ensure that you have all of your change as 1 commit which has the correct commit message - something like BIGTOP-1031 : README has outdated/ambiguous information 2. Then run a command like: git format-patch HEAD^..HEAD --stdout > BIGTOP-1031 .1.patch 3. Upload the BIGTOP-1031 .1.patch file to this JIRA git format-patch works better for all of us because it's easy to attribute the commit to you in the git history since it contains your name and email address.
        Hide
        jay vyas added a comment -

        Updated patch using "git format-patch BIGTOP-1031.1.patch" with correct commit mesage.

        Show
        jay vyas added a comment - Updated patch using "git format-patch BIGTOP-1031 .1.patch" with correct commit mesage.
        Hide
        jay vyas added a comment -

        Thanks mister grover! I've attempted to do the patch correctly above
        Is this ok?

        Show
        jay vyas added a comment - Thanks mister grover! I've attempted to do the patch correctly above Is this ok?
        Hide
        Mark Grover added a comment -

        Thanks Jay! It's looking good except that I wasn't able to apply it on the bigtop trunk. Any chance you haven't pulled in a while? If so, can you please pull bigtop trunk and rebase your patch on top of that?

        Thanks again and sorry about the hassle!

        Show
        Mark Grover added a comment - Thanks Jay! It's looking good except that I wasn't able to apply it on the bigtop trunk. Any chance you haven't pulled in a while? If so, can you please pull bigtop trunk and rebase your patch on top of that? Thanks again and sorry about the hassle!
        Hide
        jay vyas added a comment -

        Here is a new patch for master which updates the README to the same state as the old patch did for 0.6.0

        Show
        jay vyas added a comment - Here is a new patch for master which updates the README to the same state as the old patch did for 0.6.0
        Hide
        Mark Grover added a comment -

        +1

        Show
        Mark Grover added a comment - +1
        Hide
        Mark Grover added a comment -

        And, committed!
        https://git-wip-us.apache.org/repos/asf?p=bigtop.git;a=commit;h=b2c03ce0353abff02af0a84553ae30f4e04aca88

        Congratulations on your first Bigtop commit, Jay. Looking forward to many more!

        Show
        Mark Grover added a comment - And, committed! https://git-wip-us.apache.org/repos/asf?p=bigtop.git;a=commit;h=b2c03ce0353abff02af0a84553ae30f4e04aca88 Congratulations on your first Bigtop commit, Jay. Looking forward to many more!

          People

          • Assignee:
            jay vyas
            Reporter:
            jay vyas
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development