You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lens.apache.org by ar...@apache.org on 2015/07/27 13:18:53 UTC
incubator-lens git commit: LENS-689 : Add doc for code module
structure
Repository: incubator-lens
Updated Branches:
refs/heads/master 75001a1be -> 211ef3ba9
LENS-689 : Add doc for code module structure
Project: http://git-wip-us.apache.org/repos/asf/incubator-lens/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-lens/commit/211ef3ba
Tree: http://git-wip-us.apache.org/repos/asf/incubator-lens/tree/211ef3ba
Diff: http://git-wip-us.apache.org/repos/asf/incubator-lens/diff/211ef3ba
Branch: refs/heads/master
Commit: 211ef3ba99d40fea51dfe19f4828d77d3b08defe
Parents: 75001a1
Author: Yash Sharma <ya...@gmail.com>
Authored: Mon Jul 27 16:48:11 2015 +0530
Committer: arshad-matin <ar...@apache.org>
Committed: Mon Jul 27 16:48:11 2015 +0530
----------------------------------------------------------------------
src/site/apt/developer/codestructure.apt | 55 +++++++++++++++++++++++++++
src/site/site.xml | 51 +++++++++++++------------
2 files changed, 81 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/211ef3ba/src/site/apt/developer/codestructure.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/developer/codestructure.apt b/src/site/apt/developer/codestructure.apt
new file mode 100644
index 0000000..871189b
--- /dev/null
+++ b/src/site/apt/developer/codestructure.apt
@@ -0,0 +1,55 @@
+~~
+~~ 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.
+~~
+
+Lens Code Structure
+
+ Here is some detail on how the Apache Lens modules are structured -
+
+ * <<checkstyle>> - Has checkstyle rules imposed on the project.
+
+ * <<lens-api>> - Lens API. Has API primarily for the clients.
+
+ * <<lens-server-api>> - Lens API mainly for server extensions. This contains API for Service, Driver, LensEvent, QueryRewriter etc.
+
+ * <<lens-cube>> - Cube data model and query rewriting from cube QL to HQL done here.
+
+ * <<lens-storage-db>> - Storage definition for DBStorage and DBStorageHandler.
+
+ * <<lens-query-lib>> - The Query lib containing some Serde or OutputFormatter implementations.
+
+ * <<lens-driver-hive>> - Driver implementation for Hive as execution engine.
+
+ * <<lens-driver-jdbc>> - Driver implementation for JDBC as execution engine.
+
+ * <<lens-server>> - The server module - containing the service implementations, REST resources and HttpServer itself.
+
+ * <<lens-client>> - Java client built on top of REST interface.
+
+ * <<lens-cli>> - CLI built using spring shell and lens-client.
+
+ * <<lens-examples>> - Examples containing example schema and queries.
+
+ * <<lens-dist>> - Packaging for binary distribution of lens
+
+ * <<lens-ml-lib>> - Wrapper over Spark ML lib where input to a model is output of a query.
+
+ * <<lens-ml-dist>> - Packaging for ml-lib - which has server, client, spark libraries and ml-lib.
+
+ * <<lens-regression>> - The regression test suite.
+
http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/211ef3ba/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
index 9cf7f71..bd7a80b 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -22,21 +22,21 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd">
- <publishDate position="right"/>
- <version position="right"/>
- <bannerLeft>
- <name>Lens Analytics Platform</name>
- <src>/images/apache-lens-logo.png</src>
- <title>Lens Analytics Platform</title>
- <href>http://lens.incubator.apache.org</href>
- <height>54px</height>
+ <publishDate position="right"/>
+ <version position="right"/>
+ <bannerLeft>
+ <name>Lens Analytics Platform</name>
+ <src>/images/apache-lens-logo.png</src>
+ <title>Lens Analytics Platform</title>
+ <href>http://lens.incubator.apache.org</href>
+ <height>54px</height>
</bannerLeft>
- <bannerRight>
- <name>Apache Incubator</name>
- <src>/images/apache-incubator-logo.png</src>
- <href>http://incubator.apache.org</href>
- </bannerRight>
+ <bannerRight>
+ <name>Apache Incubator</name>
+ <src>/images/apache-incubator-logo.png</src>
+ <href>http://incubator.apache.org</href>
+ </bannerRight>
<body>
<menu name="Lens" >
@@ -47,37 +47,38 @@
<item name="20 Minute Video demo" target="_new"
href="http://cwiki.apache.org/confluence/display/LENS/2015/07/13/20+Minute+video+demo+of+Apache+Lens+through+examples" />
</menu>
- <menu name="Releases" >
+ <menu name="Releases" >
<item name="Download" href="./releases/download.html" />
<item name="Compatibility" href="./releases/compatibility.html" />
<item name="All Releases" href="./releases/release-history.html" />
- </menu>
- <menu name="User Documentation">
+ </menu>
+ <menu name="User Documentation">
<item name="Lens User Guide" href="./user/index.html" />
<item name="OLAP data cube" href="./user/olap-cube.html" />
<item name="REST API" href="./rest.html" />
<item name="Lens CLI" href="./user/cli.html" />
- <item name="Java Client Library" href="./user/java-client.html"/>
- <item name="JDBC Client" href="./user/jdbc-client.html"/>
+ <item name="Java Client Library" href="./user/java-client.html"/>
+ <item name="JDBC Client" href="./user/jdbc-client.html"/>
<item name="Lens ML" href="./user/ml.html" />
- <item name="FAQ" href="./user/faq.html"/>
- </menu>
- <menu name="Developer Documentation">
+ <item name="FAQ" href="./user/faq.html"/>
+ </menu>
+ <menu name="Developer Documentation">
<item name="Contributor Guide" href="./developer/contribute.html" />
<item name="Committer Guide" href="./developer/commit.html" />
<item name="Lens Design" href="./developer/design.html" />
+ <item name="Lens Code Structure" href="./developer/codestructure.html" />
<item name="Driver Developer Guide" href="./developer/driver.html" />
</menu>
- <menu name="Admin Documentation">
+ <menu name="Admin Documentation">
<item name="Admin Overview" href="./admin/index.html"/>
<item name="Deployment" href="./admin/deployment.html"/>
<item name="Configuration" href="./admin/config-server.html"/>
- <item name="Admin CLI" href="./admin/cli.html" />
+ <item name="Admin CLI" href="./admin/cli.html" />
</menu>
<menu ref="reports"/>
<breadcrumbs>
- <item name="Apache" href="http://www.apache.org" />
- <item name="Lens" href="http://lens.incubator.apache.org" />
+ <item name="Apache" href="http://www.apache.org" />
+ <item name="Lens" href="http://lens.incubator.apache.org" />
</breadcrumbs>
</body>
<skin>