You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@asterixdb.apache.org by bu...@apache.org on 2016/04/08 02:45:07 UTC

incubator-asterixdb git commit: Clean up .gitignore and README.md.

Repository: incubator-asterixdb
Updated Branches:
  refs/heads/master be7323100 -> e19ff29f9


Clean up .gitignore and README.md.

Change-Id: I8006c12fd076baf8fedf0775842aade5d05f0d0d
Reviewed-on: https://asterix-gerrit.ics.uci.edu/791
Reviewed-by: Till Westmann <ti...@apache.org>
Tested-by: Jenkins <je...@fulliautomatix.ics.uci.edu>


Project: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/commit/e19ff29f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/tree/e19ff29f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/diff/e19ff29f

Branch: refs/heads/master
Commit: e19ff29f9005bf54d4f4b17cd5ca5e7bbf4c6bf1
Parents: be73231
Author: Yingyi Bu <yi...@couchbase.com>
Authored: Thu Apr 7 17:17:18 2016 -0700
Committer: Yingyi Bu <bu...@gmail.com>
Committed: Thu Apr 7 17:39:43 2016 -0700

----------------------------------------------------------------------
 .gitignore          |  24 +++++------
 README.md           |  98 +++++++++++++++++++++++++++++++++++++++++++
 asterixdb/README.md | 107 -----------------------------------------------
 3 files changed, 110 insertions(+), 119 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/blob/e19ff29f/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 8530a4b..6453783 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,18 +12,18 @@ ittest
 asterix_logs
 build
 bin
-asterix-app/src/test/resources/externallib/
-asterix-app/rttest/
-asterix-app/mdtest/
-asterix-app/opttest/
-asterix-app/parserts/
-asterix-app/library/
-asterix-app/opt_parserts/
-asterix-app/runtime_parserts/
-asterix-app/data/csv/beer.csv
-asterix-installer/ittest/
-asterix-installer/repliationtest/
-asterix-installer/src/test/resources/clusterts/asterix-installer-0.8.9-SNAPSHOT-binary-assembly/
+asterixdb/asterix-app/src/test/resources/externallib/
+asterixdb/asterix-app/rttest/
+asterixdb/asterix-app/mdtest/
+asterixdb/asterix-app/opttest/
+asterixdb/asterix-app/parserts/
+asterixdb/asterix-app/library/
+asterixdb/asterix-app/opt_parserts/
+asterixdb/asterix-app/runtime_parserts/
+asterixdb/asterix-app/data/csv/beer.csv
+asterixdb/asterix-installer/ittest/
+asterixdb/asterix-installer/repliationtest/
+asterixdb/asterix-installer/src/test/resources/clusterts/asterix-installer-*-SNAPSHOT-binary-assembly/
 build
 asterix_logs
 bin/

http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/blob/e19ff29f/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8dc935a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,98 @@
+<!--
+ ! 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.
+ !-->
+#AsterixDB
+
+AsterixDB is a BDMS (Big Data Management System) with a rich feature set that sets it apart from other Big Data platforms.  Its feature set makes it well-suited to modern needs such as web data warehousing and social data storage and analysis. AsterixDB has:
+
+ * A semistructured NoSQL style data model (ADM) resulting from extending JSON with object database ideas
+ * An expressive and declarative query language (AQL) that supports a broad range of queries and analysis over semistructured data
+ * A parallel runtime query execution engine, Hyracks, that has been scale-tested on up to 1000+ cores and 500+ disks
+ * Partitioned LSM-based data storage and indexing to support efficient ingestion and management of semistructured data
+ * Support for query access to externally stored data (e.g., data in HDFS) as well as to data stored natively by AsterixDB
+ * A rich set of primitive data types, including spatial and temporal data in addition to integer, floating point, and textual data
+ * Secondary indexing options that include B+ trees, R trees, and inverted keyword (exact and fuzzy) index types
+ * Support for fuzzy and spatial queries as well as for more traditional parametric queries
+ * Basic transactional (concurrency and recovery) capabilities akin to those of a NoSQL store
+
+Learn more about AsterixDB at [http://asterixdb.incubator.apache.org] (http://asterixdb.incubator.apache.org)
+
+
+##Building AsterixDB
+
+To build AsterixDB from source, you should have a platform with the following:
+
+* A Unix-ish environment (Linux, OS X, will all do).
+* git
+* Maven 3.1.1 or newer.
+* Java 8 or newer.
+
+Additionally to run all the integration tests you should be running `sshd` locally, and have passwordless ssh logins enabled for the account which is running the tests.
+
+Instructions for building the master:
+
+* Checkout AsterixDB master:
+
+        $git clone https://github.com/apache/incubator-asterixdb.git
+
+* Build AsterixDB master:
+
+        $cd incubator-asterixdb
+        $mvn clean package -DskipTests
+
+
+##Running AsterixDB (on your machine from your build)
+Here are steps to get AsterixDB running on your machine:
+
+* Create a directory as the home for AsterixDB installer program, i.e., managix:
+
+        $mkdir ~/managix
+
+* Copy AsterixDB binary artifact into the installer directory and unzip it:
+
+        $cp asterixdb/asterix-installer/target/asterix-installer-*-binary-assembly.zip ~/managix/
+        $cd ~/managix
+        $unzip asterix-installer-*-binary-assembly.zip
+
+* Configure the installer:
+
+        $bin/managix configure
+
+* Validate if the computer environment is suitable:
+
+        $bin/managix validate
+
+* Create and start your instance:
+
+        $bin/managix create -n test -c clusters/local/local.xml
+
+* Good to go and run queries in your browser at:
+
+        http://localhost:19001
+
+* Read more documentations to learn the data model, query language, and how to create a cluster instance:
+  [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html)
+
+##Documentation
+
+AsterixDB's official documentation resides at [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html). This is built from the maven project under `asterix-doc/` as a maven site. The documentation on the official website refers to the most stable build version, so for pre-release versions one should refer to the compiled documentation.
+
+##Support/Contact
+
+If you have any questions, please feel free to ask on our mailing list, [users@asterixdb.incubator.apache.org](mailto:users@asterixdb.incubator.apache.org). Join the list by sending an email to [users-subscribe@asterixdb.incubator.apache.org](mailto:users-subscribe@asterixdb.incubator.apache.org). If you are interested in the internals or developement of AsterixDB, also please feel free to subscribe to our developer mailing list, [dev@asterixdb.incubator.apache.org](mailto:dev@asterixdb.incubator.apache.org), by sending an email to [dev-subscribe@asterixdb.incubator.apache.org](mailto:dev-subscribe@asterixdb.incubator.apache.org).
+

http://git-wip-us.apache.org/repos/asf/incubator-asterixdb/blob/e19ff29f/asterixdb/README.md
----------------------------------------------------------------------
diff --git a/asterixdb/README.md b/asterixdb/README.md
deleted file mode 100644
index 688ffea..0000000
--- a/asterixdb/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-<!--
- ! 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.
- !-->
-#AsterixDB
-
-AsterixDB is a BDMS (Big Data Management System) with a rich feature set that sets it apart from other Big Data platforms.  Its feature set makes it well-suited to modern needs such as web data warehousing and social data storage and analysis. AsterixDB has:
-
- * A semistructured NoSQL style data model (ADM) resulting from extending JSON with object database ideas
- * An expressive and declarative query language (AQL) that supports a broad range of queries and analysis over semistructured data
- * A parallel runtime query execution engine, Hyracks, that has been scale-tested on up to 1000+ cores and 500+ disks
- * Partitioned LSM-based data storage and indexing to support efficient ingestion and management of semistructured data
- * Support for query access to externally stored data (e.g., data in HDFS) as well as to data stored natively by AsterixDB
- * A rich set of primitive data types, including spatial and temporal data in addition to integer, floating point, and textual data
- * Secondary indexing options that include B+ trees, R trees, and inverted keyword (exact and fuzzy) index types
- * Support for fuzzy and spatial queries as well as for more traditional parametric queries
- * Basic transactional (concurrency and recovery) capabilities akin to those of a NoSQL store
-
-Learn more about AsterixDB at [http://asterixdb.incubator.apache.org] (http://asterixdb.incubator.apache.org)
-
-
-##Building AsterixDB
-
-To build AsterixDB from source, you should have a platform with the following:
-
-* A Unix-ish environment (Linux, OS X, will all do).
-* git
-* Maven 3.1.1 or newer.
-* Java 8 or newer.
-
-Additionally to run all the integration tests you should be running `sshd` locally, and have passwordless ssh logins enabled for the account which is running the tests.
-
-Instructions for building the master:
-
-* Checkout Hyracks master:
-
-        $git clone https://github.com/apache/incubator-asterixdb-hyracks.git
-
-* Checkout AsterixDB master:
-
-        $git clone https://github.com/apache/incubator-asterixdb.git
-
-* Build and install Hyracks master to maven local repo:
-
-        $cd hyracks
-        $mvn clean install -DskipTests
-
-* Build AsterixDB master:
-
-        $cd ../asterixdb
-        $mvn clean package -DskipTests
-
-
-##Running AsterixDB (on your machine from your build)
-Here are steps to get AsterixDB running on your machine:
-
-* Create a directory as the home for AsterixDB installer program, i.e., managix:
-
-        $mkdir ~/managix
-
-* Copy AsterixDB binary artifact into the installer directory and unzip it:
-
-        $cp asterix-installer/target/asterix-installer-*-binary-assembly.zip ~/managix/
-        $cd ~/managix
-        $unzip asterix-installer-*-binary-assembly.zip
-
-* Configure the installer:
-
-        $bin/managix configure
-
-* Validate if the computer environment is suitable:
-
-        $bin/managix validate
-
-* Create and start your instance:
-
-        $bin/managix create -n test -c clusters/local/local.xml
-
-* Good to go and run queries in your browser at:
-
-        http://localhost:19001
-
-* Read more documentations to learn the data model, query language, and how to create a cluster instance:
-  [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html)
-
-##Documentation
-
-AsterixDB's official documentation resides at [https://ci.apache.org/projects/asterixdb/index.html] (https://ci.apache.org/projects/asterixdb/index.html). This is built from the maven project under `asterix-doc/` as a maven site. The documentation on the official website refers to the most stable build version, so for pre-release versions one should refer to the compiled documentation.
-
-##Support/Contact
-
-If you have any questions, please feel free to ask on our mailing list, [users@asterixdb.incubator.apache.org](mailto:users@asterixdb.incubator.apache.org). Join the list by sending an email to [users-subscribe@asterixdb.incubator.apache.org](mailto:users-subscribe@asterixdb.incubator.apache.org). If you are interested in the internals or developement of AsterixDB, also please feel free to subscribe to our developer mailing list, [dev@asterixdb.incubator.apache.org](mailto:dev@asterixdb.incubator.apache.org), by sending an email to [dev-subscribe@asterixdb.incubator.apache.org](mailto:dev-subscribe@asterixdb.incubator.apache.org).
-