[
https://issues.apache.org/jira/browse/BIGTOP-1391?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Matt Fenwick updated BIGTOP-1391:
---------------------------------
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.
was:
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.
> Improve README.md so that the markdown rendering is pretty and easy to read
> ---------------------------------------------------------------------------
>
> Key: BIGTOP-1391
> URL: https://issues.apache.org/jira/browse/BIGTOP-1391
> Project: Bigtop
> Issue Type: Improvement
> Components: General
> Affects Versions: backlog
> Reporter: Matt Fenwick
> Priority: Minor
> Labels: documentation
> Fix For: 0.8.0
>
> Attachments: BIGTOP-1391.patch
>
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
