szetszwo commented on code in PR #174:
URL: https://github.com/apache/ozone-site/pull/174#discussion_r2653642650


##########
docs/03-core-concepts/02-replication/03-ratis.md:
##########
@@ -1,3 +1,28 @@
+---
+sidebar_label: Ratis
+---
+
 # Ratis
 
-**TODO:** File a subtask under 
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this 
page or section.
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+[Apache Ratis](https://ratis.apache.org/) is a highly customizable open-source 
Java implementation of the [Raft consensus protocol](https://raft.github.io/). 
Raft is an easily understandable consensus algorithm designed to manage 
replicated state. Unlike ZooKeeper or other Raft implementations such as etcd, 
Ratis is designed as a library rather than a standalone consensus server, which 
simplifies its management and integration.

Review Comment:
   Use short lines -- it will be easier to see the diff and comment on it.
   ```md
   [Apache Ratis](https://ratis.apache.org/) is a highly customizable 
open-source Java implementation of the [Raft consensus 
protocol](https://raft.github.io/).
   Raft is an easily understandable consensus algorithm designed to manage 
replicated state.
   Unlike ZooKeeper or other Raft implementations such as etcd,
   Ratis is designed as a library rather than a standalone consensus server,
   which simplifies its management and integration.
   ```



##########
docs/03-core-concepts/02-replication/03-ratis.md:
##########
@@ -1,3 +1,28 @@
+---
+sidebar_label: Ratis
+---
+
 # Ratis
 
-**TODO:** File a subtask under 
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this 
page or section.
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+
+[Apache Ratis](https://ratis.apache.org/) is a highly customizable open-source 
Java implementation of the [Raft consensus protocol](https://raft.github.io/). 
Raft is an easily understandable consensus algorithm designed to manage 
replicated state. Unlike ZooKeeper or other Raft implementations such as etcd, 
Ratis is designed as a library rather than a standalone consensus server, which 
simplifies its management and integration.
+
+Ozone leverages Ratis to replicate system states across multiple nodes, 
ensuring high availability and redundancy. Each piece of data written by 
clients is replicated to 3 Ozone Datanodes by Ratis. Within Ozone, Ratis is 
employed in critical components such as the [Ozone 
Manager](../03-namespace/01-overview.md), [Storage Container 
Manager](../01-architecture.md), and Datanodes. It forms the central pillar for 
the High Availability (HA) mechanisms of both the Ozone Manager (OM-HA) and 
Storage Container Manager (SCM-HA).

Review Comment:
   Similarly, use short lines.
   
   > ...  Each piece of data written by clients is replicated to 3 Ozone 
Datanodes by Ratis. ...
   
   Since we have other replication type (EC, ONE), revise it as:
   - "When using Ratis for replication, each piece of data written by clients 
is replicated to 3 Datanodes."
   



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to