Uploaded image for project: 'Bigtop'
  1. Bigtop
  2. BIGTOP-1391

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

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: 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.

        Attachments

          Activity

            People

            • Assignee:
              mattfenwick Matt Fenwick
              Reporter:
              mattfenwick 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