You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ratis.apache.org by "wzhallright (via GitHub)" <gi...@apache.org> on 2023/05/19 07:11:39 UTC

[GitHub] [ratis] wzhallright opened a new pull request, #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

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

   
   ## What changes were proposed in this pull request?
   
   As a noob, I've been hoping for more documentation. I noticed some md files were merged but not added to site.xml.
   According to [RATIS-1630](https://issues.apache.org/jira/browse/RATIS-1630)
   Maybe we can add this markdown to site.xml so we can view the documentation locally.   
   ### after
   ![image](https://github.com/apache/ratis/assets/32935220/d79bec70-00bc-45dc-b03b-8a0fcc498ec7)   
   When i view the document locally. I found some formatting issues like below:    
   ![image](https://github.com/apache/ratis/assets/32935220/46032564-a532-47b1-adcd-d5bd86b8f552)    
   I fixed this at the issue:   
   ![image](https://github.com/apache/ratis/assets/32935220/4f0c9639-e0fd-4dc0-8dd9-5b901c62c41b)
   
   
   ## What is the link to the Apache JIRA
   
   [RATIS-1843](https://issues.apache.org/jira/browse/RATIS-1843)
   
   
   ## How was this patch tested?
   
   (Please explain how this patch was tested. Ex: unit tests, manual tests)
   (If this patch involves UI changes, please attach a screen-shot; otherwise, remove this)
   


-- 
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] wzhallright commented on a diff in pull request #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

Posted by "wzhallright (via GitHub)" <gi...@apache.org>.
wzhallright commented on code in PR #881:
URL: https://github.com/apache/ratis/pull/881#discussion_r1199877052


##########
ratis-docs/src/site/site.xml:
##########
@@ -35,6 +35,9 @@
             <item name="Getting Started" href="start/index.html"/>
             <item name="Concepts" href="concept/index.html"/>
             <item name="Ratis-shell" href="cli.html" />
+            <item name="Snapshot" href="snapshot.html" />
+            <item name="Metrics" href="metrics.html" />
+            <item name="Configurations" href="configurations.html" />

Review Comment:
   @szetszwo Sorted them.Please check again when you have time.Thanks.



-- 
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 merged pull request #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

Posted by "SzyWilliam (via GitHub)" <gi...@apache.org>.
SzyWilliam merged PR #881:
URL: https://github.com/apache/ratis/pull/881


-- 
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] wzhallright commented on pull request #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

Posted by "wzhallright (via GitHub)" <gi...@apache.org>.
wzhallright commented on PR #881:
URL: https://github.com/apache/ratis/pull/881#issuecomment-1554134509

   @SzyWilliam @szetszwo Could you help review this when you have time? Thanks!


-- 
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 #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

Posted by "szetszwo (via GitHub)" <gi...@apache.org>.
szetszwo commented on code in PR #881:
URL: https://github.com/apache/ratis/pull/881#discussion_r1199544897


##########
ratis-docs/src/site/site.xml:
##########
@@ -35,6 +35,9 @@
             <item name="Getting Started" href="start/index.html"/>
             <item name="Concepts" href="concept/index.html"/>
             <item name="Ratis-shell" href="cli.html" />
+            <item name="Snapshot" href="snapshot.html" />
+            <item name="Metrics" href="metrics.html" />
+            <item name="Configurations" href="configurations.html" />

Review Comment:
   Could you sort them in alphabetical order?



-- 
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] wzhallright commented on a diff in pull request #881: RATIS-1843. Add existing markdown documents to site.xml in the ratis-docs project

Posted by "wzhallright (via GitHub)" <gi...@apache.org>.
wzhallright commented on code in PR #881:
URL: https://github.com/apache/ratis/pull/881#discussion_r1199877052


##########
ratis-docs/src/site/site.xml:
##########
@@ -35,6 +35,9 @@
             <item name="Getting Started" href="start/index.html"/>
             <item name="Concepts" href="concept/index.html"/>
             <item name="Ratis-shell" href="cli.html" />
+            <item name="Snapshot" href="snapshot.html" />
+            <item name="Metrics" href="metrics.html" />
+            <item name="Configurations" href="configurations.html" />

Review Comment:
   Sorted them.Please check again when you have time.Thanks.



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