DRILL-6328: Consolidated developer docs in the docs folder. closes #1220
Project: http://git-wip-us.apache.org/repos/asf/drill/repo Commit: http://git-wip-us.apache.org/repos/asf/drill/commit/f8d7acc8 Tree: http://git-wip-us.apache.org/repos/asf/drill/tree/f8d7acc8 Diff: http://git-wip-us.apache.org/repos/asf/drill/diff/f8d7acc8 Branch: refs/heads/master Commit: f8d7acc8274da20a7cd0c44aafdf3f84cc4927aa Parents: 4848a56 Author: Timothy Farkas <[email protected]> Authored: Tue Apr 17 17:36:57 2018 -0700 Committer: Vitalii Diravka <[email protected]> Committed: Sun Apr 29 23:20:55 2018 +0300 ---------------------------------------------------------------------- INSTALL.md | 46 -------------------------------------------- README.md | 4 ++-- docs/dev/DevDocs.md | 9 +++++++++ docs/dev/Environment.md | 46 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 57 insertions(+), 48 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/drill/blob/f8d7acc8/INSTALL.md ---------------------------------------------------------------------- diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 21334e6..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,46 +0,0 @@ -# How to build and run Apache Drill - -## Prerequisites - -Currently, the Apache Drill build process is known to work on Linux, Windows and OSX. To build, you need to have the following software installed on your system to successfully complete a build. - * Java 8 - * Maven 3.3.1 or greater - -## Confirm settings - # java -version - java version "1.8.0_161" - Java(TM) SE Runtime Environment (build 1.8.0_161-b12) - Java HotSpot(TM) 64-Bit Server VM (build 25.161-b12, mixed mode) - - # mvn --version - Apache Maven 3.3.1 (cab6659f9874fa96462afef40fcf6bc033d58c1c; 2015-03-13T13:10:27-07:00) - -## Checkout - - git clone https://github.com/apache/drill.git - -## Build - - cd drill - mvn clean install - -## Explode tarball in installation directory - - mkdir /opt/drill - tar xvzf distribution/target/*.tar.gz --strip=1 -C /opt/drill - -## Start SQLLine (which starts Drill in embedded mode) - - cd /opt/drill - bin/sqlline -u jdbc:drill:zk=local -n admin -p admin - -## Run a query - - SELECT - employee_id, - first_name - FROM cp.`employee.json`; - -## More information - -For more information including how to run a Apache Drill cluster, visit the [Apache Drill Documentation](http://drill.apache.org/docs/) http://git-wip-us.apache.org/repos/asf/drill/blob/f8d7acc8/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 6f1bf8c..a30cf07 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ Apache Drill is a distributed MPP query layer that supports SQL and alternative query languages against NoSQL and Hadoop data storage systems. It was inspired in part by [Google's Dremel](http://research.google.com/pubs/pub36632.html). -## Quickstart +## Developers -Please read INSTALL.md for setting up and running Apache Drill. +Please read [Environment.md](docs/dev/Environment.md) for setting up and running Apache Drill. For complete developer documentation see [DevDocs.md](docs/dev/DevDocs.md). ## More Information Please see the [Apache Drill Website](http://drill.apache.org/) or the [Apache Drill Documentation](http://drill.apache.org/docs/) for more information including: http://git-wip-us.apache.org/repos/asf/drill/blob/f8d7acc8/docs/dev/DevDocs.md ---------------------------------------------------------------------- diff --git a/docs/dev/DevDocs.md b/docs/dev/DevDocs.md new file mode 100644 index 0000000..2b5b31f --- /dev/null +++ b/docs/dev/DevDocs.md @@ -0,0 +1,9 @@ +# Drill Developer Docs + +## Environment + +For information about configuring your development enviornment see [Environment.md](Environment.md). + +## Testing + +For information about how to do Integration and Unit Testing in Drill see [Testing.md](Testing.md). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/drill/blob/f8d7acc8/docs/dev/Environment.md ---------------------------------------------------------------------- diff --git a/docs/dev/Environment.md b/docs/dev/Environment.md new file mode 100644 index 0000000..21334e6 --- /dev/null +++ b/docs/dev/Environment.md @@ -0,0 +1,46 @@ +# How to build and run Apache Drill + +## Prerequisites + +Currently, the Apache Drill build process is known to work on Linux, Windows and OSX. To build, you need to have the following software installed on your system to successfully complete a build. + * Java 8 + * Maven 3.3.1 or greater + +## Confirm settings + # java -version + java version "1.8.0_161" + Java(TM) SE Runtime Environment (build 1.8.0_161-b12) + Java HotSpot(TM) 64-Bit Server VM (build 25.161-b12, mixed mode) + + # mvn --version + Apache Maven 3.3.1 (cab6659f9874fa96462afef40fcf6bc033d58c1c; 2015-03-13T13:10:27-07:00) + +## Checkout + + git clone https://github.com/apache/drill.git + +## Build + + cd drill + mvn clean install + +## Explode tarball in installation directory + + mkdir /opt/drill + tar xvzf distribution/target/*.tar.gz --strip=1 -C /opt/drill + +## Start SQLLine (which starts Drill in embedded mode) + + cd /opt/drill + bin/sqlline -u jdbc:drill:zk=local -n admin -p admin + +## Run a query + + SELECT + employee_id, + first_name + FROM cp.`employee.json`; + +## More information + +For more information including how to run a Apache Drill cluster, visit the [Apache Drill Documentation](http://drill.apache.org/docs/)
