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

        Matt Fenwick created issue -
        Matt Fenwick made changes -
        Field Original Value New Value
        Status Open [ 1 ] Patch Available [ 10002 ]
        Matt Fenwick made changes -
        Status Patch Available [ 10002 ] Open [ 1 ]
        Matt Fenwick made changes -
        Attachment BIGTOP-1391.patch [ 12659465 ]
        Matt Fenwick made changes -
        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.
        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.
        jay vyas made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Konstantin Boudnik made changes -
        Assignee Matt Fenwick [ mattfenwick ]

          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