You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by GitBox <gi...@apache.org> on 2021/05/01 13:50:58 UTC

[GitHub] [accumulo] nicolasalarconrapela opened a new pull request #2068: Update and improvement in README

nicolasalarconrapela opened a new pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068


   - CONTRIBUTING.md
       - Aggregation to the word 'issues-bug' the link to the Issues with 'Bug' label
       - Improvement of the format
   - Moving 'Contributing.md' from the main directory to the '.github/' folder
   - README.md
       - Image of the focused logo
       - Badges centered.
       - Division of the text in new sections
       - Aggregation of the section :
           - 'License'
           - 'Contributing'
           - 'Social media'
             - 'Mailing Lists'
   - Creation of '.github / code_of_conduct.md'


-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#issuecomment-830654865


   @nicolasalarconrapela For the code of conduct page, see [my proposal on the ComDev mailing list](https://lists.apache.org/thread.html/rb718b7f881a1003ed815e77ef0852759cc040c97b9b66edcc61a34e7%40%3Cdev.community.apache.org%3E)


-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624540799



##########
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 think it's better to stick with the Markdown instead of the HTML. I don't think centering is necessarily better or worth it. The Markdown is easier to maintain, and is the convention for many projects on GitHub, especially for the badges.




-- 
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

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

Posted by 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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624542811



##########
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:
       In my humble opinion regarding maintenance (in this case) there would be no problem because the images are referenced in an external link and therefore it does not matter to use markdown or html.
   
   >
   




-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624537200



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

Review comment:
       I just wanted to understand where it came from. You could mention it in the git commit log message. However, I think it'd be better to follow my proposal to create this in a central place for all ASF projects, instead of adding it to the Accumulo repository. See https://github.com/apache/accumulo/pull/2068#issuecomment-830654865




-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624916424



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

Review comment:
       Whoops !!! This change was mine in theory it should never have gotten on ...




-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r625325698



##########
File path: README.md
##########
@@ -20,11 +20,14 @@ limitations under the License.
 [![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
-data sets across a cluster. Accumulo uses [Apache Hadoop]'s HDFS to store its data and
+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

Review comment:
       Since this section doesn't change any wording, we should keep the existing 2 lines, rather than merge them into 1.

##########
File path: README.md
##########
@@ -44,13 +47,18 @@ waiting for the tests to run.
 
 This command produces `assemble/target/accumulo-<version>-bin.tar.gz`
 
+## Contributing
+
+Contributions are welcome to all Apache Accumulo repositories
+
+If you want to contribute, go through our guide [How to contribute](https://accumulo.apache.org/how-to-contribute/)
+
 ## Export Control
 
 <details>
 <summary>Click here to show/hide details</summary>
 
----
-
+<br>

Review comment:
       This change can be undone.

##########
File path: README.md
##########
@@ -44,13 +47,18 @@ waiting for the tests to run.
 
 This command produces `assemble/target/accumulo-<version>-bin.tar.gz`
 
+## Contributing
+
+Contributions are welcome to all Apache Accumulo repositories
+
+If you want to contribute, go through our guide [How to contribute](https://accumulo.apache.org/how-to-contribute/)

Review comment:
       ```suggestion
   Contributions are welcome to all Apache Accumulo repositories.
   
   If you want to contribute, read [our guide on our website][contribute].
   ```
   
   Can put `[contribute]: https://accumulo.apache.org/how-to-contribute` at the end.

##########
File path: README.md
##########
@@ -20,11 +20,14 @@ limitations under the License.
 [![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
-data sets across a cluster. Accumulo uses [Apache Hadoop]'s HDFS to store its data and
+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.
+
+Download the latest version of Apache Accumulo® [here][dl].
+

Review comment:
       ```suggestion
   [Apache Zookeeper] for consensus.
   
   Download the latest version of Apache Accumulo on the [project website][dl].
   
   ```

##########
File path: README.md
##########
@@ -100,3 +108,4 @@ more details on bouncycastle's cryptography features.
 [tl]: https://github.com/apache/accumulo/actions
 [java-export]: https://www.oracle.com/us/products/export/export-regulations-345813.html
 [bouncy-site]: https://bouncycastle.org
+[dl]: https://accumulo.apache.org/downloads/

Review comment:
       ```suggestion
   [dl]: https://accumulo.apache.org/downloads
   [contribute]: https://accumulo.apache.org/how-to-contribute
   ```




-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#issuecomment-831490831


   > I see fit that these guidelines should be saved or mentioned somewhere in case some other user decides to modify the README.
   
   To be clear, these aren't official guidelines. All of these are subject to change, based on future community decisions. Nothing is set in stone, and we don't want these to be set in stone. We certainly don't want to have more documentation about how to maintain the README than the actual content contained within it. These are just my attempt to compile and share a list of relevant concepts from a decade of project history, in order to help guide you. Others in the community may have different opinions, values, and suggestions to offer.


-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624538084



##########
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. 
    
   The main idea is to make it look like this:
   ![image](https://user-images.githubusercontent.com/23703592/116788862-aa202280-aab4-11eb-8e12-c4f93739098e.png)
   
   The only thing that has been modified is to make it look centered (and with that it would become an HTML format) the rest remains unchanged
   
   ---
   > 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.
   
   At the moment VueJs does not sponsor Apache ... Although I never know ... 
   _This kind of 'slip' is my signature, my apologies!_
   It would be a matter of modifying the link .. :)




-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#issuecomment-831108708


   > For the README, consider these guidelines:
   > 
   > 1. Keep it minimal; only show basics, and defer to the project website for more
   > 2. Keep it readable in both plain text Markdown and in the Markdown-rendered HTML
   > 3. Make it look nice on GitHub, with badges, but don't go overboard so that it hurts plain text readability
   > 4. Use footnote links instead of inline links so that the reader doesn't have to interrupt reading to view a URL
   > 5. Don't use relative links to files not present in the tarball distribution
   > 6. Don't use links to resources whose address is likely to change
   > 7. Don't link to the source code repository
   > 8. Avoid emojis, unnecessary graphics, and unnecessary special characters
   
   I see fit that these guidelines should be saved or mentioned somewhere in case some other user decides to modify the README.


-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624546030



##########
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.
   
   I see well that the sections are maintained ... Opinions ... :)
   
   > 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.
   
   It seems good to me I will check the indexing of url's and that they comply with this commitment




-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624532879



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

Review comment:
       It is the same copy from: https://www.apache.org/foundation/policies/conduct. Do you say it by the title? Confusion of mine ...




-- 
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

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

Posted by GitBox <gi...@apache.org>.
ctubbsii commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624873723



##########
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:
       @nicolasalarconrapela We don't just use Markdown because it's shorthand for HTML. We also use it because it's more human-readable. The less HTML, the better. We don't need HTML. This README is also included in the tarball we generate. So, it should be readable in a user's text editor, and the reader should not have to parse HTML/XML tags to read it. Centering the image, in my opinion, does not justify adding HTML that is harder for users to view using a plain text viewer.




-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624544920



##########
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 think centering is necessarily better or worth it.
   
   Honestly, I see it as more minimalist, detailed ... _Hahaha I appeal to democracy ... would there be a way to vote?_
   
   > The Markdown is easier to maintain, .(...) , especially for the badges.
   
   In my humble opinion regarding maintenance (in this case) there would be no problem because the images and badges are referenced in an external link and therefore it does not matter to use markdown or html. Another thing is that there is behind a link automation or something similar.
   
   > and is the convention for many projects on GitHub
   
   There are projects like those of [Facebook](https://github.com/facebook/react-native), [Vue Js](https://github.com/vuejs/vue) that use html in their README




-- 
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

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

Posted by GitBox <gi...@apache.org>.
nicolasalarconrapela commented on a change in pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068#discussion_r624932589



##########
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:
       Perfect !!! I think it's great !!




-- 
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

[GitHub] [accumulo] ctubbsii merged pull request #2068: Update and improvement in README

Posted by GitBox <gi...@apache.org>.
ctubbsii merged pull request #2068:
URL: https://github.com/apache/accumulo/pull/2068


   


-- 
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

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

Posted by GitBox <gi...@apache.org>.
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:
users@infra.apache.org