Repository: lens Updated Branches: refs/heads/master 66b7f47ff -> c33ef9991
LENS-1218 : Document Lens UI in install and run steps Project: http://git-wip-us.apache.org/repos/asf/lens/repo Commit: http://git-wip-us.apache.org/repos/asf/lens/commit/c33ef999 Tree: http://git-wip-us.apache.org/repos/asf/lens/tree/c33ef999 Diff: http://git-wip-us.apache.org/repos/asf/lens/diff/c33ef999 Branch: refs/heads/master Commit: c33ef999112a0c784a2b78701af40cb17127d84d Parents: 66b7f47 Author: Rajat Khandelwal <[email protected]> Authored: Fri Jul 22 07:52:41 2016 +0530 Committer: Amareshwari Sriramadasu <[email protected]> Committed: Fri Jul 22 07:52:41 2016 +0530 ---------------------------------------------------------------------- src/site/apt/developer/contribute.apt | 28 ++++++++++++++++++++------ src/site/apt/lenshome/install-and-run.apt | 24 +++++++++------------- 2 files changed, 32 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lens/blob/c33ef999/src/site/apt/developer/contribute.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/developer/contribute.apt b/src/site/apt/developer/contribute.apt index a2fd59e..8ea7a6d 100644 --- a/src/site/apt/developer/contribute.apt +++ b/src/site/apt/developer/contribute.apt @@ -114,14 +114,30 @@ Developer Documentation : How to contribute to Apache Lens? +---+ Once one of the above sets of commands completes successfully, the build will produce - <lens-dist/target/apache-lens-<version>-bin/apache-lens-<version>-bin/server> and - <lens-dist/target/apache-lens-<version>-bin/apache-lens-<version>-bin/client>. Former can be used as the Lens server - installation directory and later can be used as Lens client installation directory to - {{{/lenshome/install-and-run.html#Running_Lens} run}} lens server and lens client. + <lens-dist/target/apache-lens-<version>-bin/apache-lens-<version>-bin/server>, + <lens-dist/target/apache-lens-<version>-bin/apache-lens-<version>-bin/client>, and + <lens-dist/target/apache-lens-<version>-bin/apache-lens-<version>-bin/ui>. These can be used as the Lens server + installation directory, Lens client installation directory, and Lens UI installation directory respectively. + {{{/lenshome/install-and-run.html#Running_Lens} run}} lens server, lens client and UI. - The build will also produce debians for both client and server in <lens-dist/target>. Client debian uses + Lens UI is written in <nodejs>, and can be run directly from the module itself. In fact, it's recommended to run + from there since the npm dependencies are already fetched in <lens-ui> module by <mvn clean package> step above. + ++---+ + cd lens-ui + npm start ++---+ + + For making changes in lens-ui code, it can be started in dev mode where it'll watch for your changes and re-bundle + whenever changes are made. To run ui server in dev mode, use the following command: + ++---+ + npm run dev ++---+ + + The build will also produce debians for server, client and ui in <lens-dist/target>. Client debian uses </usr/local/lens/client> as the Lens client installation directory and Server debian uses </usr/local/lens/server> as - the Lens server installation directory. + the Lens server installation directory. UI debian uses </usr/local/lens/ui> as the installation directory. Apache Lens depends on Hive. Please {{{#Building_Hive_from_Source} build}} Hive from Source or install it using the documentation {{{/lenshome/install-and-run.html#Installing_Hive} here}}. After installing Lens and Hive, http://git-wip-us.apache.org/repos/asf/lens/blob/c33ef999/src/site/apt/lenshome/install-and-run.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/lenshome/install-and-run.apt b/src/site/apt/lenshome/install-and-run.apt index f133822..b9727c4 100644 --- a/src/site/apt/lenshome/install-and-run.apt +++ b/src/site/apt/lenshome/install-and-run.apt @@ -48,10 +48,11 @@ Installing and Running Lens âââ NOTICE âââ README âââ LICENSE* - âââ server + âââ server + âââ ui +---+ - <apache-lens-<verison>-bin/client> can be used as the Lens client installation directory and <apache-lens-<verison>-bin/server> can be used as the Lens server installation directory to {{{#Running_Lens}run}} lens client and lens server respectively. + <apache-lens-<verison>-bin/client> can be used as the Lens client installation directory, <apache-lens-<verison>-bin/server> can be used as the Lens server installation directory, and <apache-lens-<verison>-bin/ui> can be used as the Lens UI installation directory to {{{#Running_Lens}run}} lens client, lens server and lens ui respectively. ** Installing Hive @@ -159,9 +160,6 @@ Installing and Running Lens You can try out examples described below or use the REST api <link> for each service. - Lens server also comes with simple UI service which can be used to browse catalog and submit queries. Once the server - starts up, you can open the UI service on http://<serverhost>:19999/index.html and browse. - The command to stop the server: +---+ @@ -228,7 +226,7 @@ Installing and Running Lens Examples folder contains sample resource files, data files and query files which will be used by <<run-examples.sh>> script. -*** Starting Lens Client +*** Starting Lens CLI Client +---+ @@ -236,13 +234,11 @@ Installing and Running Lens +---+ +*** Starting Lens UI ++---+ + npm install # One time setup step. Brings all the dependencies. + npm start + npm stop # to stop the ui - - - - - - - - ++---+
