浏览代码

HUE-6682 [doc] Simplify the README to be friendler to users

Romain Rigaux 8 年之前
父节点
当前提交
6e894bb0e9
共有 5 个文件被更改,包括 77 次插入114 次删除
  1. 19 97
      README.md
  2. 23 17
      docs/dev/testing.rst
  3. 二进制
      docs/images/dashboard.png
  4. 二进制
      docs/images/sql-editor.png
  5. 35 0
      docs/sdk/sdk.md

+ 19 - 97
README.md

@@ -1,26 +1,27 @@
 ![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/hue_logo.png "Hue Logo")
 ![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/hue_logo.png "Hue Logo")
 
 
 
 
-Welcome to the repository for Hue
------------
-
-Hue is an open source Web interface for analyzing data with any Apache Hadoop: [gethue.com](http://gethue.com)
+Query. Explore. Repeat.
+-----------------------
 
 
-![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/sql-editor.png "Hue Screenshot")
+Hue is an open source Query Tool for browsing, querying and visualizing data with focus on SQL and Search: [gethue.com](http://gethue.com)
 
 
 It features:
 It features:
 
 
-   * SQL editors for Hive, Impala, MySQL, Oracle, PostgreSQL, SparkSQL, Solr SQL, Phoenix...
-   * Dynamic Search dashboards with Solr
-   * Spark and Hadoop notebooks
-   * Scheduling of jobs and workflows through an Oozie Editor and Dashboard
+   * [Editors](http://gethue.com/sql-editor/) for Hive, Impala, Pig, MapReduce, Spark and any SQL like MySQL, Oracle, SparkSQL, Solr SQL, Phoenix and more.
+   * [Dashboards](http://gethue.com/search-dashboards/) to dynamically interact and visualize data with Solr or SQL
+   * [Scheduler](http://gethue.com/scheduling/) of jobs and workflows
+   * [Browsers](http://gethue.com/browsers/) for Jobs, HDFS, S3 files, SQL Tables, Indexes, Git files, Sentry permissions, Sqoop and more.
+
 
 
-More user and developer documentation is available at [gethue.com](http://gethue.com).
+![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/sql-editor.png "Hue Editor")
+
+![alt text](https://raw.githubusercontent.com/cloudera/hue/master/docs/images/dashboard.png "Hue Dashboard")
 
 
 
 
 Getting Started
 Getting Started
------------
-To build and get the development server running:
+---------------
+Add the development packages, build and get the development server running:
 ```
 ```
 $ git clone https://github.com/cloudera/hue.git
 $ git clone https://github.com/cloudera/hue.git
 $ cd hue
 $ cd hue
@@ -32,30 +33,6 @@ Now Hue should be running on [http://localhost:8000](http://localhost:8000) !
 The configuration in development mode is ``desktop/conf/pseudo-distributed.ini``.
 The configuration in development mode is ``desktop/conf/pseudo-distributed.ini``.
 
 
 
 
-Note: to start the production server (but lose the automatic reloading after source modification):
-```
-$ build/env/bin/supervisor
-```
-To run the tests:
-
-Install the mini cluster (only once):
-```
-$ ./tools/jenkins/jenkins.sh slow
-```
-
-Run all the tests:
-```
-$ build/env/bin/hue test all
-```
-
-Or just some parts of the tests, e.g.:
-```
-$ build/env/bin/hue test specific impala
-$ build/env/bin/hue test specific impala.tests:TestMockedImpala
-$ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow
-```
-
-
 Docker
 Docker
 ------
 ------
 Start Hue in a single click with the [Docker Guide](https://github.com/cloudera/hue/tree/master/tools/docker) or the
 Start Hue in a single click with the [Docker Guide](https://github.com/cloudera/hue/tree/master/tools/docker) or the
@@ -64,8 +41,7 @@ Start Hue in a single click with the [Docker Guide](https://github.com/cloudera/
 
 
 Development Prerequisites
 Development Prerequisites
 -------------------------
 -------------------------
-You'll need these library development packages and tools installed on
-your system:
+You'll need these library development packages and tools installed on your system:
 
 
 __Ubuntu:__
 __Ubuntu:__
 
 
@@ -85,28 +61,14 @@ sudo apt-get install oracle-java7-installer
 
 
 __CentOS/RHEL:__
 __CentOS/RHEL:__
 
 
+* sudo yum install ant asciidoc cyrus-sasl-devel cyrus-sasl-gssapi cyrus-sasl-plain gcc gcc-c++ krb5-devel libffi-devel libxml2-devel libxslt-devel make  mysql mysql-devel openldap-devel python-devel sqlite-devel gmp-devel
+
 * Oracle's JDK [(read more here)](https://www.digitalocean.com/community/tutorials/how-to-install-java-on-centos-and-fedora)
 * Oracle's JDK [(read more here)](https://www.digitalocean.com/community/tutorials/how-to-install-java-on-centos-and-fedora)
-* ant
-* asciidoc
-* cyrus-sasl-devel
-* cyrus-sasl-gssapi
-* cyrus-sasl-plain
-* gcc
-* gcc-c++
-* krb5-devel
-* libffi-devel
-* libtidy (for unit tests only)
-* libxml2-devel
-* libxslt-devel
-* make
+
 * mvn (from [``apache-maven``](https://gist.github.com/sebsto/19b99f1fa1f32cae5d00) package or maven3 tarball)
 * mvn (from [``apache-maven``](https://gist.github.com/sebsto/19b99f1fa1f32cae5d00) package or maven3 tarball)
-* mysql
-* mysql-devel
-* openldap-devel
-* python-devel
-* sqlite-devel
+* libtidy (for unit tests only)
 * openssl-devel (for version 7+)
 * openssl-devel (for version 7+)
-* gmp-devel
+
 
 
 __MacOS:__
 __MacOS:__
 
 
@@ -118,46 +80,6 @@ __MacOS:__
 * openssl (Homebrew)
 * openssl (Homebrew)
 * Required for Mac OS X 10.11+ (El Capitan), after ``brew install openssl``, run: ``export LDFLAGS=-L/usr/local/opt/openssl/lib && export CPPFLAGS=-I/usr/local/opt/openssl/include``
 * Required for Mac OS X 10.11+ (El Capitan), after ``brew install openssl``, run: ``export LDFLAGS=-L/usr/local/opt/openssl/lib && export CPPFLAGS=-I/usr/local/opt/openssl/include``
 
 
-__All, just in case you want to run the Jasmine tests:__
-
-* NodeJS (https://nodejs.org/)
-* PhantomJS (npm install -g phantomjs-prebuilt)
-
-
-File Layout
------------
-The Hue "framework" is in ``desktop/core/`` and contains the Web components.
-``desktop/libs/`` is the API for talking to various Hadoop services.
-The installable apps live in ``apps/``.  Please place third-party dependencies in the app's ext-py/
-directory.
-
-The typical directory structure for inside an application includes:
-```
-  src/
-    for Python/Django code
-      models.py
-      urls.py
-      views.py
-      forms.py
-      settings.py
-
-  conf/
-    for configuration (``.ini``) files to be installed
-
-  static/
-    for static HTML/js resources and help doc
-
-  templates/
-    for data to be put through a template engine
-
-  locales/
-    for localizations in multiple languages
-```
-
-For the URLs within your application, you should make your own ``urls.py``
-which will be automatically rooted at ``/yourappname/`` in the global
-namespace.  See ``apps/about/src/about/urls.py`` for an example.
-
 
 
 Main Stack
 Main Stack
 -----------
 -----------

+ 23 - 17
docs/dev/testing.rst

@@ -1,23 +1,22 @@
 The short story
 The short story
 ===============
 ===============
 
 
-Python-based tests:
-
-  "build/env/bin/hue test all" runs all the tests.
-
-You should be running that before you push.
-
-Windmill-tests:
-
-  build/env/bin/hue test windmill
-
-runs all the windmill tests.  It uses port 8999.
-
-  build/env/bin/hue runserver_plus
-
-followed by
-
-  build/env/bin/windmill -e test=core/src/desktop/windmilltests.py firefox http://localhost:8000/
+Install the mini cluster (only once):
+```
+$ ./tools/jenkins/jenkins.sh slow
+```
+
+Run all the tests:
+```
+$ build/env/bin/hue test all
+```
+
+Or just some parts of the tests, e.g.:
+```
+$ build/env/bin/hue test specific impala
+$ build/env/bin/hue test specific impala.tests:TestMockedImpala
+$ build/env/bin/hue test specific impala.tests:TestMockedImpala.test_basic_flow
+```
 
 
 Jasmine tests (from your browser):
 Jasmine tests (from your browser):
 
 
@@ -64,6 +63,13 @@ Point to an Impalad and trigger the Impala tests:
   build/env/bin/hue test impala impalad-01.gethue.com
   build/env/bin/hue test impala impalad-01.gethue.com
 
 
 
 
+Run the Jasmine tests
+=====================
+
+* NodeJS (https://nodejs.org/)
+* PhantomJS (npm install -g phantomjs-prebuilt)
+
+
 Special environment variables
 Special environment variables
 =============================
 =============================
 
 

二进制
docs/images/dashboard.png


二进制
docs/images/sql-editor.png


+ 35 - 0
docs/sdk/sdk.md

@@ -104,6 +104,41 @@ Many apps will evolve to have a bit of custom JavaScript and
 CSS styles.  Apps that need to talk to an external service
 CSS styles.  Apps that need to talk to an external service
 will pull in the code necessary to talk to that service.
 will pull in the code necessary to talk to that service.
 
 
+File Layout
+-----------
+The Hue "framework" is in ``desktop/core/`` and contains the Web components.
+``desktop/libs/`` is the API for talking to various Hadoop services.
+The installable apps live in ``apps/``.  Please place third-party dependencies in the app's ext-py/
+directory.
+
+The typical directory structure for inside an application includes:
+```
+  src/
+    for Python/Django code
+      models.py
+      urls.py
+      views.py
+      forms.py
+      settings.py
+
+  conf/
+    for configuration (``.ini``) files to be installed
+
+  static/
+    for static HTML/js resources and help doc
+
+  templates/
+    for data to be put through a template engine
+
+  locales/
+    for localizations in multiple languages
+```
+
+For the URLs within your application, you should make your own ``urls.py``
+which will be automatically rooted at ``/yourappname/`` in the global
+namespace.  See ``apps/about/src/about/urls.py`` for an example.
+
+
 Pre-requisites
 Pre-requisites
 ==============
 ==============