This is an automated email from the ASF dual-hosted git repository. szetszwo pushed a commit to branch RATIS-5 in repository https://gitbox.apache.org/repos/asf/ratis-hadoop-projects.git
commit be562a8758564d306706ed0e0d3673399bb52e0e Author: Anu Engineer <[email protected]> AuthorDate: Fri Dec 1 16:34:34 2017 -0800 Some minor typo fixes and edits to web site --- content/community.md | 11 +++++------ content/download.md | 4 +++- content/getting_started.md | 10 +++++----- content/post/0.1.0-alpha.md | 2 +- layouts/index.html | 16 ++++++---------- 5 files changed, 20 insertions(+), 23 deletions(-) diff --git a/content/community.md b/content/community.md index 86c81ec..9ed5cb0 100644 --- a/content/community.md +++ b/content/community.md @@ -19,10 +19,9 @@ title: Community #### Developers -If you'd like to contribute to Apache Ratis, please subscribe to the -Ratis developer mailing list. +If you'd like to contribute to Apache Ratis, please subscribe to the Ratis developer mailing list. -The Rais developer mailing list is: <[email protected]>. +The Ratis developer mailing list is: <[email protected]>. - [Subscribe to List](mailto: [email protected]) - [Unsubscribe from @@ -37,15 +36,15 @@ questions and discussion. Please use dev mailing list to address developers on a specific technical question. -The Ratis user mailing list is : <[email protected]>. +The Ratis user mailing list is: <[email protected]>. - [Subscribe to List](mailto: [email protected]) - [Unsubscribe from List](mailto: [email protected]) - [Archives](http://mail-archives.apache.org/mod_mbox/ratis-user/) -In order to post to the list, it is necessary to first subscribe to it. +To post to the list, it is necessary to subscribe to it. ### Slack There is also a slack instance for discussion at https://apacheratisdev.slack.com. -Write to the mailing list if you need invite. +Please write to the mailing list if you need an invite. diff --git a/content/download.md b/content/download.md index 33a51fc..19c21a6 100644 --- a/content/download.md +++ b/content/download.md @@ -15,7 +15,9 @@ title: Download limitations under the License. See accompanying LICENSE file. --> -Ratis is a *library* which is supposed to be used from java code. +Ratis is a java *library* that can be used directly from your applications. It is an embeddable [RAFT](https://raft.github.io/";) protcol library. + +To use it from maven, Please use the following configuration. {{< highlight xml>}} diff --git a/content/getting_started.md b/content/getting_started.md index 0e9d438..c4ff100 100644 --- a/content/getting_started.md +++ b/content/getting_started.md @@ -15,15 +15,15 @@ title: Getting started limitations under the License. See accompanying LICENSE file. --> -Ratis is a *library* which is expected to be used form java code. It's not a standalone server application like Zookeeper or Consul. +Ratis is a [RAFT](https://raft.github.io/";) protocol *library* in java. It's not a standalone server application like Zookeeper or Consul. -But to demonstrate how to use Ratis from the code, the project providers multiple examples where an example state machine / server log is implemented. +To demonstrate how to use Ratis from the code, Please look at the following examples. -As of now we have two examples: + * [Arithmetic example](https://github.com/apache/incubator-ratis/tree/master/ratis-examples/src/main/java/org/apache/ratis/examples/arithmetic): This is a simple distributed calculator that replicates the values defined and allows user to perform arithmetic operations on these replicated values. - * Arithmetic example: where the Ratis statemachine implementation stores the values of the variables and you can modify the variables arithmetic expressions. - * FileStore example: where the Ratis statemachine implemetation stores files with a simplified (read/write) interfaces. + * [FileStore example](https://github.com/apache/incubator-ratis/tree/master/ratis-examples/src/main/java/org/apache/ratis/examples/filestore): This is an example of using Ratis for reading and writing files. +<!-- TODO: We should have the following as documentation in the github. --> The source code the examples could be found in the ratis-examples subproject. Arithmetic example also has some simple cli script to start it: diff --git a/content/post/0.1.0-alpha.md b/content/post/0.1.0-alpha.md index 5545c3d..a6662c5 100644 --- a/content/post/0.1.0-alpha.md +++ b/content/post/0.1.0-alpha.md @@ -1,6 +1,6 @@ --- title: Release 0.1.0-alpha is available -date: 2007-05-02 +date: 2017-12-02 --- <!--- Licensed under the Apache License, Version 2.0 (the "License"); diff --git a/layouts/index.html b/layouts/index.html index 1083ccd..66a4481 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -28,11 +28,10 @@ <i class="fa fa-5x fa-fw m-y-3 text-info fa-child"></i> <h4>Pluggable transport</h4> <p> - Transport layer of Ratis is separated from the RAFT implementation and can be used with any - transport. + Ratis provides a pluggable transport layer. By default gRPC, Netty+Protobuf and Hadoop RPC based transports are provided. </p> <p> - By default gRPC, Netty+Protobuf and Hadoop RPC based transports are provided. + </p> <p></p> </div> @@ -40,20 +39,17 @@ <span class="glyphicon glyphicon-log-in" aria-hidden="true"></span> <h4>Pluggable state machine</h4> <p> - Ratis is a RAFT library which can use for many use cases. A custom state machine should be defined - by the - user of the library and Ratis will replicate the state between the servers. + Ratis supports a log and state machine. State machine typically contains the data that you want to make highly avialable. Ratis makes it easy to use your own state machine. </p> </div> <div class="col-md-4 col-sm-4 feature-item"> <span class="glyphicon glyphicon-tasks" aria-hidden="true"></span> <h4>Pluggable raft log</h4> - <p>RAFT log is also pluggable, users may provide their own log implementation. The default + <p>RAFT log is also pluggable, users can provide their own log implementation. The default implementation - stores log in local files</p> + stores log in local files.</p> <p> - Application could choose to not written all the data to log and state machine data and log data can - be separately managed + Application can define the polices of how to write data and where it should be written easily. </p> </div>
