You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ratis.apache.org by el...@apache.org on 2018/01/03 22:46:46 UTC
incubator-ratis git commit: RATIS-5 Addressing comments / ASF
guideline issues.
Repository: incubator-ratis
Updated Branches:
refs/heads/RATIS-5 68432788a -> 5855924bb
RATIS-5 Addressing comments / ASF guideline issues.
Project: http://git-wip-us.apache.org/repos/asf/incubator-ratis/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ratis/commit/5855924b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ratis/tree/5855924b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ratis/diff/5855924b
Branch: refs/heads/RATIS-5
Commit: 5855924bb234b2f941f92c5778c38204291d336f
Parents: 6843278
Author: Márton Elek <el...@apache.org>
Authored: Wed Jan 3 23:43:28 2018 +0100
Committer: Márton Elek <el...@apache.org>
Committed: Wed Jan 3 23:43:28 2018 +0100
----------------------------------------------------------------------
content/download.md | 54 -----------------------
content/getting_started.md | 43 ++++++++++++++++++-
content/post/0.1.0-alpha.md | 2 +
layouts/index.html | 90 +++++++++++++++++++++++++++++++--------
layouts/partials/footer.html | 4 +-
layouts/partials/header.html | 50 ++++++++++------------
static/style.css | 17 +++++++-
7 files changed, 157 insertions(+), 103 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/content/download.md
----------------------------------------------------------------------
diff --git a/content/download.md b/content/download.md
deleted file mode 100644
index 19c21a6..0000000
--- a/content/download.md
+++ /dev/null
@@ -1,54 +0,0 @@
----
-title: Download
----
-<!---
- Licensed 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. See accompanying LICENSE file.
--->
-
-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>}}
-<dependency>
- <artifactId>ratis-server</artifactId>
- <groupId>org.apache.ratis</groupId>
-</dependency>
-{{< /highlight >}}
-
-
-You also need to include *one* of the transports:
-
-{{< highlight xml>}}
-<dependency>
- <artifactId>ratis-netty</artifactId>
- <groupId>org.apache.ratis</groupId>
-</dependency>
-{{< /highlight >}}
-
-{{< highlight xml>}}
- <dependency>
- <groupId>org.apache.ratis</groupId>
- <artifactId>ratis-grpc</artifactId>
-</dependency>
-{{< /highlight >}}
-
-{{< highlight xml>}}
- <dependency>
- <groupId>org.apache.ratis</groupId>
- <artifactId>ratis-hadoop-shaded</artifactId>
- </dependency>
-{{< /highlight >}}
-
-Please note that hadoop dependencies are shaded, so it's safe to use hadoop transport with different versions of hadoop.
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/content/getting_started.md
----------------------------------------------------------------------
diff --git a/content/getting_started.md b/content/getting_started.md
index c4ff100..0ed63a6 100644
--- a/content/getting_started.md
+++ b/content/getting_started.md
@@ -15,7 +15,9 @@ title: Getting started
limitations under the License. See accompanying LICENSE file.
-->
-Ratis is a [RAFT](https://raft.github.io/") protocol *library* in java. 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.
+
+### Examples
To demonstrate how to use Ratis from the code, Please look at the following examples.
@@ -34,3 +36,42 @@ Arithmetic example also has some simple cli script to start it:
4. Create a new variable in the state machine: ``` ./client.sh assign --name a --value 3```
5. Assign a new variable: ```./client.sh assign --name b --value a+5```
6. Get a variable from the state machine: ```./client.sh get --name b```
+
+### Maven usage
+
+To use in our project you can access the latest binaries from maven central:
+
+
+{{< highlight xml>}}
+<dependency>
+ <artifactId>ratis-server</artifactId>
+ <groupId>org.apache.ratis</groupId>
+</dependency>
+{{< /highlight >}}
+
+
+You also need to include *one* of the transports:
+
+{{< highlight xml>}}
+<dependency>
+ <artifactId>ratis-netty</artifactId>
+ <groupId>org.apache.ratis</groupId>
+</dependency>
+{{< /highlight >}}
+
+{{< highlight xml>}}
+ <dependency>
+ <groupId>org.apache.ratis</groupId>
+ <artifactId>ratis-grpc</artifactId>
+</dependency>
+{{< /highlight >}}
+
+{{< highlight xml>}}
+ <dependency>
+ <groupId>org.apache.ratis</groupId>
+ <artifactId>ratis-hadoop-shaded</artifactId>
+ </dependency>
+{{< /highlight >}}
+
+Please note that Hadoop dependencies are shaded, so it's safe to use hadoop transport with different versions of Apache Hadoop.
+
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/content/post/0.1.0-alpha.md
----------------------------------------------------------------------
diff --git a/content/post/0.1.0-alpha.md b/content/post/0.1.0-alpha.md
index e4c8e9f..850f401 100644
--- a/content/post/0.1.0-alpha.md
+++ b/content/post/0.1.0-alpha.md
@@ -1,6 +1,8 @@
---
title: Release 0.1.0-alpha is available
date: 2017-05-02
+type: release
+linked: true
---
<!---
Licensed under the Apache License, Version 2.0 (the "License");
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/layouts/index.html
----------------------------------------------------------------------
diff --git a/layouts/index.html b/layouts/index.html
index 66a4481..3359be1 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -12,17 +12,46 @@
limitations under the License. See accompanying LICENSE file.
-->
{{ partial "header.html" . }}
-<div class="feature-list-group">
+<div class="main-section">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-8 col-md-offset-2">
+ <div class="panel panel-default">
+ <div class="panel-heading">Disclaimer</div>
+ <div class="panel-body">
+ <img class="pull-right" src="apache_incubator.png" alt="Apache Incubator"></img>
+ Apache Ratis is an effort undergoing <a href="https://incubator.apache.org">incubation</a> at
+ <a href="https://www.apache.org">The Apache Software Foundation (ASF)</a>, sponsored by the Apache Incubator PMC.
+ Incubation is required of all newly accepted projects until a further review indicates that the infrastructure,
+ communications, and decision making process have stabilized in a manner consistent with other successful ASF projects.
+ While incubation status is not necessarily a reflection of the completeness or stability of the code,
+ it does indicate that the project has yet to be fully endorsed by the ASF.
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+<div class="whatis bg-light">
<div class="container">
<div class="row header">
- <h3>What is Apache Ratis™?</h3>
+ <h2>What is Apache Ratis™?</h2>
<p class="lead">
- Apache Ratis is a higly customizable RAFT protocol implementation in java.
+ Apache Ratis is a higly customizable Raft protocol implementation in Java.</p>
+ <p class="lead"><a href="https://raft.github.io/">Raft</a> is a easily understandable consensus algorithm to manage replicated log.</p>
+ <p class="lead">Apache Ratis could be used in any Java application where a state should be replicated between multiple instances.</p>
</p>
<p></p>
</div>
+ </div>
+</div>
+
+<div class="main-section feature-list-group">
+ <div class="container">
<div class="row feature-list">
+ <h2>Features</h2>
<div class="col-md-4 col-sm-4 feature-item">
<span class="glyphicon glyphicon-transfer" aria-hidden="true"></span>
<i class="fa fa-5x fa-fw m-y-3 text-info fa-child"></i>
@@ -31,7 +60,7 @@
Ratis provides a pluggable transport layer. By default gRPC, Netty+Protobuf and Hadoop RPC based transports are provided.
</p>
<p>
-
+
</p>
<p></p>
</div>
@@ -61,7 +90,7 @@
</div><!-- /.feature-list-group -->
-<a name="download"></a>
+<a name="news"></a>
<div class="main-section bg-light">
<div class="container">
<div class="row header">
@@ -79,10 +108,45 @@
<div class="main-section">
<div class="container">
<div class="row header">
- {{range where .Site.Pages "Title" "Download"}}
- <h2>{{.Title}}</h2>
- {{.Content}}
- {{end}}
+ <h2>Download</h2>
+
+ <p>Apache Ratis is a java <b>library</b> that can be used directly from your applications.</p>
+
+ <p>It is released as source code tarballs. The downloads are distributed via mirror sites and should be checked
+ for tampering using <a href="https://www.apache.org/info/verification.html">GPG or SHA-256</a></p>
+ <p>
+
+ <p>The source tarball contains detailed instruction about how can it be built.</p>
+
+ <p>The binaries are also uploaded to the maven central for convenience. (See the getting started guide for more details)</p>
+ <table class="table table-striped">
+ <thead>
+ <tr>
+ <th>Version</th>
+ <th>Release date</th>
+ <th>Source download</th>
+ <th>Announcement</th>
+ </tr>
+ </thead>
+ {{range first 5 (where .Site.Pages ".Params.type" "release")}}
+ <tr>
+ <td>{{.BaseFileName }}</td>
+ <td>{{dateFormat "2006 Jan 2 " .Date}}</td>
+ <td>
+ <a href="https://www.apache.org/dyn/closer.cgi/incubator/ratis/{{.BaseFileName }}/apache-ratis-incubating-{{.BaseFileName }}-src.tar.gz">source</a>
+ (<a href="https://dist.apache.org/repos/dist/release/incubator/ratis/{{.BaseFileName }}/apache-ratis-incubating-{{.BaseFileName }}-src.tar.gz.asc">checksum</a>
+ <a href="https://dist.apache.org/repos/dist/release/incubator/ratis/{{.BaseFileName }}/apache-ratis-incubating-{{.BaseFileName }}-src.tar.gz.mds">signature</a>)
+ </td>
+
+ <td>
+ <a href="/post/{{.BaseFileName }}.html">Announcement</a>
+ </td>
+ </tr>
+ {{end}}
+ </table>
+ </p>
+
+
</div>
</div>
</div>
@@ -124,14 +188,6 @@
</div>
<a name="source"></a>
-<div class="main-section">
- <div class="container">
- <div class="row header">
- <p><img src="apache_incubator.png" alt="Apache Incubator"></img></p>
- <p>Apache Ratis is currently undergoing <a href="https://incubator.apache.org">Incubation</a> at the Apache Software Foundation.</p>
- </div>
- </div>
-</div>
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/layouts/partials/footer.html
----------------------------------------------------------------------
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
index 8d6bd14..916ce63 100644
--- a/layouts/partials/footer.html
+++ b/layouts/partials/footer.html
@@ -15,8 +15,8 @@
<div class="container">
<div class="col-md-12 trademark">
- <p>© 2017 <a href="http://apache.org">The Apache Software Foundation</a>.
- Apache, Apache Ratis, the Apache feather logo, Apache Ratis logo are trademarks of The Apache Software Foundation.
+ <p>© 2018 <a href="http://apache.org">The Apache Software Foundation</a>,
+ Apache, Apache Ratis, the Apache feather logo, Apache Ratis logo, Apache Incubator logo are trademarks of The Apache Software Foundation.
<p>
</div>
</div><!-- /.container -->
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/layouts/partials/header.html
----------------------------------------------------------------------
diff --git a/layouts/partials/header.html b/layouts/partials/header.html
index ae7e811..5749d26 100644
--- a/layouts/partials/header.html
+++ b/layouts/partials/header.html
@@ -37,31 +37,26 @@
<body>
<!-- breadcrumbs -->
+
<div class="topnav">
- <div class="container breadcrumb-container">
- <ul class="breadcrumb">
+ <div class="container">
+ <ul class="breadcrumb col-md-6">
<li>
- <div class="dropdown">
- <img class="asf-logo" src="asf_feather.png"/>
- <a data-toggle="dropdown" href="#">Apache Software Foundation <span class="caret"></span></a>
- <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
- <li><a href="http://www.apache.org">Apache Homepage</a></li>
- <li><a href="http://www.apache.org/licenses/">License</a></li>
- <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
- <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
- <li><a href="http://www.apache.org/security/">Security</a></li>
- </ul>
- </div>
+ <img class="asf-logo" src="asf_feather.png"/>
+ <a href="https://www.apache.org">Apache Software Foundation</span></a>
</li>
-
-
- <li><img class="asf-logo" src="logo-white.png"/><a href="#">Apache Ratis</a></li>
-
-
+ <li><img class="asf-logo" src="logo-white.png"/><a href="{{.Site.BaseURL}}">Apache Ratis™</a></li>
</ul>
+ <div class="col-md-6">
+ <ul class="pull-right breadcrumb">
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ </div>
</div>
- <!-- navbar -->
<nav class="navbar navbar-default navbar-static-top" role="navigation">
<div class="container">
<div class="navbar-header">
@@ -72,25 +67,24 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
- </div><!-- /.navbar-header -->
+ </div>
<div id="ratis-menu" class="collapse navbar-collapse">
<ul class="nav navbar-nav navbar-right">
- <li><a href="#">Home</a></li>
<li><a href="#download">Download</a></li>
<li><a href="#gettingstarted">Getting started</a></li>
<li><a href="#source">Source</a></li>
<li><a href="#community">Community</a></li>
</ul>
- </div><!-- /#ratis-menu -->
+ </div>
<div class="jumbotron">
<h1>
- Open source java implementation for RAFT consensus protocol.
+ Open source java implementation for Raft consensus protocol.
</h1>
<p>
- <a class="btn btn-default download" role="button" href="#download">Download Ratis</a>
+ <a class="btn btn-default download" role="button" href="#download">Download Apache Ratis</a>
</p>
<p>
@@ -98,8 +92,8 @@
href="#gettingstarted">Getting started
</a>
</p>
- </div><!-- /.jumbotron -->
-
+ </div>
</div>
- </nav><!-- /.navbar -->
-</div><!-- /.topnav -->
+
+ </nav>
+</div>
http://git-wip-us.apache.org/repos/asf/incubator-ratis/blob/5855924b/static/style.css
----------------------------------------------------------------------
diff --git a/static/style.css b/static/style.css
index cbd8c04..af3952b 100644
--- a/static/style.css
+++ b/static/style.css
@@ -136,7 +136,7 @@
color: #777777;
font-weight: normal;
line-height: 1.42857143;
- margin-bottom: 55px; }
+ }
.feature-list-group .feature-list {
margin-bottom: 25px; }
.feature-list-group .feature-item h4 {
@@ -316,3 +316,18 @@ body {
padding-bottom: 20px;
padding-top: 10px;
}
+
+.whatis h2 {
+ padding-bottom: 20px;
+ padding-top: 10px;
+}
+
+.whatis P{
+ color: #777777
+}
+
+div .row {
+ padding-left: 30px;
+ padding-right: 30px;
+
+}
\ No newline at end of file