Repository: incubator-s2graph
Updated Branches:
refs/heads/master 8dfb829c1 -> 94862407f
[S2GRAPH-94]: Add description for project layout on REAME.
JIRA:
[S2GRAPH-94] https://issues.apache.org/jira/browse/S2GRAPH-94
Pull Request:
Closes #73
Authors:
Jong Wook Kim: [email protected]
Project: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/commit/94862407
Tree: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/tree/94862407
Diff: http://git-wip-us.apache.org/repos/asf/incubator-s2graph/diff/94862407
Branch: refs/heads/master
Commit: 94862407ff597f859f6358f0b98036bcd1e3d69d
Parents: 8dfb829
Author: DO YUNG YOON <[email protected]>
Authored: Thu Sep 1 05:48:57 2016 +0900
Committer: DO YUNG YOON <[email protected]>
Committed: Thu Sep 1 05:48:57 2016 +0900
----------------------------------------------------------------------
CHANGES | 3 +++
README.md | 30 ++++++++++++++++++++++--------
2 files changed, 25 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-s2graph/blob/94862407/CHANGES
----------------------------------------------------------------------
diff --git a/CHANGES b/CHANGES
index f6fa782..f55b3b2 100644
--- a/CHANGES
+++ b/CHANGES
@@ -165,6 +165,9 @@ Release 0.12.1 - unreleased
S2GRAPH-92: Add proper license headers on files with unknown licenses
(Committed by DOYUNG YOON).
S2GRAPH-100: Add BUILD.md to explain how to package from source, then add
it into REAME.md (Committed by DOYUNG YOON).
+
+ S2GRAPH-94: Add description for project layout on REAME.
+ (Contributed by Jong Wook Kim<[email protected]>, committed by
DOYUNG YOON).
S2GRAPH-103: Remove dependencies on custom fork of asynchbase (Committed
by DOYUNG YOON).
http://git-wip-us.apache.org/repos/asf/incubator-s2graph/blob/94862407/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8955196..82fff4c 100644
--- a/README.md
+++ b/README.md
@@ -39,19 +39,33 @@ Quick Start
===========
Once built from source, the following resources are expected under
`target/apache-s2graph-$version-incubating-bin`. This should be the same
structure as in the binary distribution.
-1. DISCLAIMER
-2. LICENSE
-3. NOTICE
-4. bin
-5. conf
-6. lib
-7. logs
-8. var
+1. `DISCLAIMER`
+2. `LICENSE`
+3. `NOTICE`
+4. `bin`
+5. `conf`
+6. `lib`
+7. `logs`
+8. `var`
`sh bin/start-s2graph.sh` will launch the S2Graph server along with a
standalone [HBase server](https://hbase.apache.org/) as the data storage and
[H2](http://www.h2database.com/html/main.html) as the metastore
Finally, join the mailing list by sending a message to
[[email protected]](mailto:[email protected]?subject=send
this email to subscribe) or
[[email protected]](mailto:[email protected]?subject=send
this email to subscribe)!
+Project Layout
+==============
+
+Here is what you can find in each subproject.
+
+1. `s2core`: The core library, containing the data abstractions for graph
entities, storage adapters and utilities.
+2. `s2rest_play`: The REST server built with [Play
framework](https://www.playframework.com/), providing the write and query API.
+3. `s2rest_netty`: The REST server built directly using Netty, implementing
only the query API.
+4. `loader`: A collection of Spark jobs for bulk loading streaming data into
S2Graph.
+5. `spark`: Spark utilities for `loader` and `s2counter_loader`.
+6. `s2counter_core`: The core library providing data structures and logics for
`s2counter_loader`.
+7. `s2counter_loader`: Spark streaming jobs that consume Kafka WAL logs and
calculate various top-*K* results on-the-fly.
+
+The first three projects are for OLTP-style workloads, currently the main
target of S2Graph. The other four projects could be helpful for OLAP-style or
streaming workloads, especially for integrating S2Graph with [Apache
Spark](https://spark.apache.org/) and/or [Kafka](https://kafka.apache.org/).
Note that, the latter four projects are currently out-of-date, which we are
planning to update and provide documentations in the upcoming releases.
Your First Graph
================
