Bigtop
  1. Bigtop
  2. BIGTOP-1391

Improve README.md so that the markdown rendering is pretty and easy to read

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: backlog
    • Fix Version/s: 0.8.0
    • Component/s: general
    • Labels:

      Description

      Related to https://issues.apache.org/jira/browse/BIGTOP-1312 and https://issues.apache.org/jira/browse/BIGTOP-1383, README.md could use an overhaul.

      If you're coming to this project from github (https://github.com/apache/bigtop), the first thing you see is the README rendered in markdown. But, it's not very easy to read.

      There are several things which can be improved without changing the content:

      • code formatting
      • consistent indentation
      • headings
      • links
        Also, there are some minor errors that can be cleaned up as well.
      1. BIGTOP-1391.patch
        12 kB
        Matt Fenwick

        Activity

        Hide
        jay vyas added a comment -

        commited, thanks matt./

        Show
        jay vyas added a comment - commited, thanks matt./
        Hide
        jay vyas added a comment -

        okay +1 and commiting . thanks for the improvements.

        Show
        jay vyas added a comment - okay +1 and commiting . thanks for the improvements.
        Hide
        Matt Fenwick added a comment - - edited

        @ jay awesome, thanks

        This patch addresses:

        • indentation
        • headers
        • code formatting
        • indentation errors
        • typos, spelling, etc.
        Show
        Matt Fenwick added a comment - - edited @ jay awesome, thanks This patch addresses: indentation headers code formatting indentation errors typos, spelling, etc.
        Hide
        jay vyas added a comment -

        sounds good. feel free to submit a patch for this and ill merge it in. i was going to update the README for BIGTOP-1222 anyways. I think we can do a "double" commit patch here, if others are okay with it - where I layer my update on top of yours.

        Show
        jay vyas added a comment - sounds good. feel free to submit a patch for this and ill merge it in. i was going to update the README for BIGTOP-1222 anyways. I think we can do a "double" commit patch here, if others are okay with it - where I layer my update on top of yours.

          People

          • Assignee:
            Matt Fenwick
            Reporter:
            Matt Fenwick
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

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

                Development