[GitHub] [ratis] szetszwo commented on a diff in pull request #696: RATIS-1639. Added getting started document

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

szetszwo commented on code in PR #696:
URL: https://github.com/apache/ratis/pull/696#discussion_r929074638


##########
ratis-docs/src/site/markdown/index.md:
##########
@@ -17,12 +17,27 @@
 
 # Apache Ratis
 Apache Ratis is a highly customizable Raft protocol implementation in Java.
-Raft is a easily understandable consensus algorithm to manage replicated state.
-Apache Ratis could be used in any Java application where state should be replicated between multiple instances.
+[Raft](https://raft.github.io/) is an easily understandable consensus algorithm to manage replicated state. 
+
+The Ratis project was started at 2017 as an incubator project, and has graduated at Feb 17, 2021. Originally, Ratis is built for using Raft in [Apache Ozone](https://ozone.apache.org) where Ratis is used to replicate raw data and to provide high availability, and the correctness and performance of Ratis has been heavily tested with Ozone. 

Review Comment:
   Revised as below:
   ```
   The Ratis project was started at 2016,
   entered Apache incubation in 2017,
   and graduated as a top level Apache project on Feb 17, 2021.
   Originally, Ratis was built for using Raft in [Apache Ozone](https://ozone.apache.org)
   in order to replicate raw data and to provide high availability.
   The correctness and performance of Ratis has been heavily tested with Ozone.
   ```
   
   BTW, let's break the long lines to multiple short lines so that it is easier to provide comments.



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

To unsubscribe, e-mail: issues-unsubscribe@ratis.apache.org

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