[GitHub] [accumulo] ctubbsii commented on a change in pull request #2068: Update and improvement in README

[GitBox]

ctubbsii commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624874888



##########
File path: README.md
##########
@@ -15,42 +15,89 @@ See the License for the specific language governing 
permissions and
 limitations under the License.
 -->
 
-[![Apache Accumulo][logo]][accumulo]
---
-[![Build Status][ti]][tl] [![Maven Central][mi]][ml] [![Javadoc][ji]][jl] 
[![Apache License][li]][ll]
-
-[Apache Accumulo][accumulo] is a sorted, distributed key/value store that 
provides robust,
-scalable data storage and retrieval. With Apache Accumulo, users can store and 
manage large
+<!-- LOGO -->
+<p align="center">
+    <a href="https://accumulo.apache.org/"; target="_blank" rel="noopener 
noreferrer">
+        <img src="contrib/accumulo-logo.png" alt="Accumulo logo">
+    </a>
+</p>
+
+<!-- BADGES -->
+<p align="center">
+    <!-- Build Status -->
+    <a href="https://github.com/apache/accumulo/actions";>
+        <img src="https://github.com/apache/accumulo/workflows/QA/badge.svg"; 
alt="Build Status">
+    </a>
+    <!-- Maven Central -->
+    <a 
href="https://maven-badges.herokuapp.com/maven-central/org.apache.accumulo/accumulo-core";>
+        <img 
src="https://maven-badges.herokuapp.com/maven-central/org.apache.accumulo/accumulo-core/badge.svg";
+            alt="Maven Central">
+    </a>
+    <!-- JavaDocs -->
+    <a href="https://www.javadoc.io/doc/org.apache.accumulo/accumulo-core";>
+        <img 
src="https://www.javadoc.io/badge/org.apache.accumulo/accumulo-core.svg"; 
alt="JavaDocs">
+    </a>
+    <!-- Apache License -->
+    <a href="https://www.apache.org/licenses/LICENSE-2.0";>
+        <img src="https://img.shields.io/badge/license-ASL-blue.svg"; 
alt="Apache License">
+    </a>
+</p>
+
+# About
+
+[Apache Accumulo®][accumulo] is a sorted, distributed key/value store that 
provides robust, scalable data storage and retrieval.
+
+With Apache Accumulo, users can store and manage large
 data sets across a cluster. Accumulo uses [Apache Hadoop]'s HDFS to store its 
data and
-[Apache Zookeeper] for consensus. Check out the [Accumulo project 
website][accumulo] for
-news and general information.
+[Apache Zookeeper] for consensus.
+
+Visit our 🌐 [project website][accumulo] for news and general information
+
+Download the latest version of Apache Accumulo® 
[here](https://accumulo.apache.org/downloads/).
+
+# Getting Started
+
+Follow the [quick start] to install and run Accumulo
+
+# Documentation
 
-## Getting Started
+Read the [Accumulo documentation][docs]
+
+# Examples
 
-* Follow the [quick start] to install and run Accumulo
-* Read the [Accumulo documentation][docs]
 * Run the [Accumulo examples][examples] to learn how to write Accumulo clients
 * View the [Javadocs][javadocs] to learn the [Accumulo API][api]
 
 More resources can be found on the [project website][accumulo].
 
-## Building
+# Building
+
+Accumulo uses [Maven] to compile, [test], and package its source.
 
-Accumulo uses [Maven] to compile, [test], and package its source. The following
-command will build the binary tar.gz from source. Add `-DskipTests` to build 
without
-waiting for the tests to run.
+The following
+command :
 
     mvn package
 
-This command produces `assemble/target/accumulo-<version>-bin.tar.gz`
+will build the binary `tar.gz` 
(`assemble/target/accumulo-<version>-bin.tar.gz`) from source.
+> _Add `-DskipTests` to build without waiting for the tests to run._

Review comment:
       This shouldn't be a blockquote. It's not quoting anything/anyone.

##########
File path: README.md
##########
@@ -15,42 +15,89 @@ See the License for the specific language governing 
permissions and
 limitations under the License.
 -->
 
-[![Apache Accumulo][logo]][accumulo]
---
-[![Build Status][ti]][tl] [![Maven Central][mi]][ml] [![Javadoc][ji]][jl] 
[![Apache License][li]][ll]
-
-[Apache Accumulo][accumulo] is a sorted, distributed key/value store that 
provides robust,
-scalable data storage and retrieval. With Apache Accumulo, users can store and 
manage large
+<!-- LOGO -->
+<p align="center">
+    <a href="https://accumulo.apache.org/"; target="_blank" rel="noopener 
noreferrer">
+        <img src="contrib/accumulo-logo.png" alt="Accumulo logo">
+    </a>
+</p>
+
+<!-- BADGES -->
+<p align="center">
+    <!-- Build Status -->
+    <a href="https://github.com/apache/accumulo/actions";>
+        <img src="https://github.com/apache/accumulo/workflows/QA/badge.svg"; 
alt="Build Status">
+    </a>
+    <!-- Maven Central -->
+    <a 
href="https://maven-badges.herokuapp.com/maven-central/org.apache.accumulo/accumulo-core";>
+        <img 
src="https://maven-badges.herokuapp.com/maven-central/org.apache.accumulo/accumulo-core/badge.svg";
+            alt="Maven Central">
+    </a>
+    <!-- JavaDocs -->
+    <a href="https://www.javadoc.io/doc/org.apache.accumulo/accumulo-core";>
+        <img 
src="https://www.javadoc.io/badge/org.apache.accumulo/accumulo-core.svg"; 
alt="JavaDocs">
+    </a>
+    <!-- Apache License -->
+    <a href="https://www.apache.org/licenses/LICENSE-2.0";>
+        <img src="https://img.shields.io/badge/license-ASL-blue.svg"; 
alt="Apache License">
+    </a>
+</p>
+
+# About
+
+[Apache Accumulo®][accumulo] is a sorted, distributed key/value store that 
provides robust, scalable data storage and retrieval.
+
+With Apache Accumulo, users can store and manage large
 data sets across a cluster. Accumulo uses [Apache Hadoop]'s HDFS to store its 
data and
-[Apache Zookeeper] for consensus. Check out the [Accumulo project 
website][accumulo] for
-news and general information.
+[Apache Zookeeper] for consensus.
+
+Visit our 🌐 [project website][accumulo] for news and general information

Review comment:
       Emoji characters may not show up in a user's system if they don't have a 
font with a visible glyph for it. Please avoid them.

##########
File path: README.md
##########
@@ -79,9 +126,14 @@ more details on bouncycastle's cryptography features.
 
 </details>
 
+<br/>
+
+# License

Review comment:
       Do all of these sections really deserve to be `h1` headers? I don't 
think we need all these sections.

##########
File path: README.md
##########
@@ -79,9 +126,14 @@ more details on bouncycastle's cryptography features.
 
 </details>
 
+<br/>
+
+# License
+
+[Apache License, Version 2.0](./LICENSE).

Review comment:
       This is what the LICENSE file is for. It's not necessary to include it 
here as well.

##########
File path: CHANGELOG.md
##########
@@ -0,0 +1,35 @@
+# CHANGELOG

Review comment:
       Please remove this file. As a community, we decided a long time ago to 
eliminate maintaining a separate CHANGELOG. This concept predates development 
using version control systems, and is substantially less useful than the 
curated release notes that we create to highlight the changes we think users 
should be aware of. A separate CHANGELOG file creates extra maintenance burden 
on us, and adds no value that isn't already available from the git history and 
the release notes.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org