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

[GitBox <gi...@apache.org>]

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



##########
File path: README.md
##########
@@ -15,42 +15,97 @@ 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 -->

Review comment:
       I don't see any reason to change the the markdown formatting to raw HTML, or change the layout/style of badges or the logo. And, there definitely shouldn't be a change to link to vuejs's site. I assume that was copied/pasted from another project and is a mistake, but I don't think any of this should be changed at all.

##########
File path: README.md
##########
@@ -15,42 +15,97 @@ 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://vuejs.org" target="_blank" rel="noopener noreferrer">
+        <img src="contrib/accumulo-logo.png" alt="Vue 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

Review comment:
       I'm opposed to expanding the README to duplicate information on the website. We previously took efforts to substantially minimize the README to make it easier to read, and keep more comprehensive information up-to-date on the website instead. The README really should be minimal, so we don't have to maintain the same information in multiple places. A link to the website should be fine.
   
   Keep in mind that the README is also included in the release tarball, so links to files/pages not in the tarball won't work. That includes everything in `.github/`.
   
   Also, links to specific pages on the website should be minimized. Since this file is included in the release tarball at the time of release, it should endeavor to show information that will not be invalidated by website redesigns or reorganizations.

##########
File path: .github/CODE_OF_CONDUCT.md
##########
@@ -0,0 +1,84 @@
+# Contributor Code of Conduct

Review comment:
       Is this a copy from a different source? Is it from https://www.apache.org/foundation/policies/conduct ? Just curious in case we want to keep it up-to-date with the source material, if that gets updated.




-- 
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:
users@infra.apache.org