Browse Source

HUE-8888 [docs] Refresh the readme to promote Docker and SQL

Romain 6 years ago
parent
commit
4e0dc7d415
3 changed files with 18 additions and 7 deletions
  1. 4 4
      CONTRIBUTING.md
  2. 12 2
      README.md
  3. 2 1
      tools/docker/README.md

+ 4 - 4
CONTRIBUTING.md

@@ -5,7 +5,7 @@ The Hue project gladly welcomes [pull requests](https://github.com/cloudera/hue/
 
 
 This document contains instructions on how to help get involved with Hue.
 This document contains instructions on how to help get involved with Hue.
 
 
-In any case, feel free to ask here, on the [forum](Help Forum: https://discourse.gethue.com/) or [@gethue](https://twitter.com/gethue).
+In any case, feel free to ask here, on the [forum](https://discourse.gethue.com/) or [@gethue](https://twitter.com/gethue).
 
 
 # What to improve
 # What to improve
 
 
@@ -17,12 +17,12 @@ Here is some inspiration on which areas would love to have some contributions:
 4. Generally, improving or creating connectors should be the best projects:
 4. Generally, improving or creating connectors should be the best projects:
 * SQL (Tip: read (how to write a parser)[link]
 * SQL (Tip: read (how to write a parser)[link]
   * Hive LLAP
   * Hive LLAP
-  * Parser for Calcite
+  * Parser for [Apache Calcite](https://calcite.apache.org)
   * Parser for PartiQl
   * Parser for PartiQl
   * Parser for ZetaSql
   * Parser for ZetaSql
   * SqlAlchemy (any improvements to connectors for Druid, Phoenix...)
   * SqlAlchemy (any improvements to connectors for Druid, Phoenix...)
-  * Kafka Sql
-  * Elastic Search
+  * Sql streams (Kafka SQL, Flink SQL...)
+  * Elastic Search, [Solr](http://gethue.com/sql-editor-for-solr-sql/)
 * Storage: Google Storage
 * Storage: Google Storage
 * Query Optimization
 * Query Optimization
 * Data Catalog
 * Data Catalog

+ 12 - 2
README.md

@@ -23,8 +23,16 @@ It features:
 
 
 Who is using Hue
 Who is using Hue
 ----------------
 ----------------
-Thousands of companies and organizations use Hue to open-up their data and provide self service querying. Just at Cloudera, Hue is heavily used by 1000 customers executing millions of queries daily. Hue also ships in Amazon AWS and its open source version is used by hundred of companies.
+Thousands of companies and organizations use Hue to open-up their data and provide self service querying. Hue is heavily used by
 
 
+* 1000+ paying customers
+* top Fortune 500
+
+who are executing 100s of 1000 of queries daily.
+
+It also ships in Amazon AWS and its open source version is used by hundred of companies.
+
+Hue is ideal for building your own [Cloud SQL Editor](https://docs.gethue.com/developer/parsers/) and any [contributions](CONTRIBUTING.md) are welcome.
 
 
 Getting Started
 Getting Started
 ---------------
 ---------------
@@ -42,9 +50,11 @@ Read more in the [installation documentation](http://cloudera.github.io/hue/late
 
 
 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/hue) or the
 [video blog post](http://gethue.com/getting-started-with-hue-in-2-minutes-with-docker/).
 [video blog post](http://gethue.com/getting-started-with-hue-in-2-minutes-with-docker/).
 
 
+    docker run -it -p 8888:8888 gethue/hue:latest
+
 
 
 Kubernetes
 Kubernetes
 ----------
 ----------

+ 2 - 1
tools/docker/README.md

@@ -9,8 +9,9 @@ Available on [Docker Hub](https://hub.docker.com/u/gethue/) as well.
 
 
 ## Services
 ## Services
 
 
-* [Hue](hue)
+* [Hue](hue) (core)
 * [Nginx](nginx)
 * [Nginx](nginx)
+* [Documentation website](documentation)
 
 
 ## Kubernetes
 ## Kubernetes