You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@ratis.apache.org by GitBox <gi...@apache.org> on 2022/11/21 07:28:51 UTC

[GitHub] [ratis] SzyWilliam opened a new pull request, #788: RATIS-1750. Add snapshot section in dev guide

SzyWilliam opened a new pull request, #788:
URL: https://github.com/apache/ratis/pull/788

   See https://issues.apache.org/jira/browse/RATIS-1750.
   
   This PR proposes to add the snapshot section in developer's guide.
   I choose to add snapshot section first since snapshot mechanism is rather complicated, and some requires early decisions, like the decision between `installSnapshot` or `installSnapshotNotification`. 


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

[GitHub] [ratis] SzyWilliam commented on pull request #788: RATIS-1750. Add snapshot section in dev guide

Posted by GitBox <gi...@apache.org>.

SzyWilliam commented on PR #788:
URL: https://github.com/apache/ratis/pull/788#issuecomment-1321576672

   @szetszwo @codings-dan Could you please help review this PR❤️? Please correct me if there are any misunderstandings.


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

[GitHub] [ratis] szetszwo commented on a diff in pull request #788: RATIS-1750. Add snapshot section in dev guide

Posted by GitBox <gi...@apache.org>.

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


##########
ratis-docs/src/site/markdown/devguide.md:
##########
@@ -0,0 +1,242 @@
+<!---
+  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.
+-->
+
+# Developer's Guide
+
+## Snapshot
+
+### Overview

Review Comment:
   Let's call this `Snapshot Guide` and change the sections to one level up.
   ```diff
   +++ b/ratis-docs/src/site/markdown/devguide.md
   @@ -15,11 +15,9 @@
      limitations under the License.
    -->
    
   -# Developer's Guide
   +# Snapshot Guide
    
   -## Snapshot
   -
   -### Overview
   +## Overview
   ```



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

[GitHub] [ratis] szetszwo merged pull request #788: RATIS-1750. Add snapshot section in dev guide

Posted by GitBox <gi...@apache.org>.

szetszwo merged PR #788:
URL: https://github.com/apache/ratis/pull/788


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

[GitHub] [ratis] SzyWilliam commented on pull request #788: RATIS-1750. Add snapshot section in dev guide

Posted by GitBox <gi...@apache.org>.

SzyWilliam commented on PR #788:
URL: https://github.com/apache/ratis/pull/788#issuecomment-1328411350

   @szetszwo @codings-dan Thanks for the reviews! Made corresponding changes on PR, PTAL~


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