Browse Source

HUE-8756 [docs] Pass updating the content and reorganazing the configuration toc

Romain Rigaux 6 years ago
parent
commit
17b3889d29

+ 4 - 3
docs/ROADMAP.md

@@ -13,11 +13,12 @@ High Level Roadmap
 * [ ] Frontend moved to Webpack [HUE-8687](https://issues.cloudera.org/browse/HUE-8687)
 * [ ] Frontend moved to Webpack [HUE-8687](https://issues.cloudera.org/browse/HUE-8687)
 * [ ] Result caching
 * [ ] Result caching
 * [ ] Editor v2
 * [ ] Editor v2
-* [ ] [core] Integrate with Apache Ranger [HUE-8748](https://issues.cloudera.org/browse/HUE-8748)
-* [ ] [core] Integrate with Apache Atlas [HUE-8749](https://issues.cloudera.org/browse/HUE-8749)
-* [ ] [core] Integrate with Apache Knox [HUE-8750](https://issues.cloudera.org/browse/HUE-8750)
+* [ ] Integrate with Apache Ranger [HUE-8748](https://issues.cloudera.org/browse/HUE-8748)
+* [ ] Integrate with Apache Atlas [HUE-8749](https://issues.cloudera.org/browse/HUE-8749)
+* [ ] Integrate with Apache Knox [HUE-8750](https://issues.cloudera.org/browse/HUE-8750)
 * [ ] SQL Dashboards and Query Builder [HUE-3228](https://issues.cloudera.org/browse/HUE-3228)
 * [ ] SQL Dashboards and Query Builder [HUE-3228](https://issues.cloudera.org/browse/HUE-3228)
 * [ ] Gunicorn [HUE-8739](https://issues.cloudera.org/browse/HUE-8739)
 * [ ] Gunicorn [HUE-8739](https://issues.cloudera.org/browse/HUE-8739)
+* [ ] Configuration of connectors via the interface [HUE-8758](https://issues.cloudera.org/browse/HUE-8758)
 * [x] Web Server [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/)
 * [x] Web Server [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/)
 * [ ] SQL Alchemy full support [HUE-8740](https://issues.cloudera.org/browse/HUE-8740)
 * [ ] SQL Alchemy full support [HUE-8740](https://issues.cloudera.org/browse/HUE-8740)
 * [x] Documentation refresh [HUE-8741](https://issues.cloudera.org/browse/HUE-8741)
 * [x] Documentation refresh [HUE-8741](https://issues.cloudera.org/browse/HUE-8741)

+ 2 - 2
docs/docs-site/config.toml

@@ -50,12 +50,12 @@ url = "https://github.com/cloudera/hue"
 weight = 10
 weight = 10
 
 
 [[menu.shortcuts]]
 [[menu.shortcuts]]
-name = "<i class='fas fa-fw fa-camera'></i> Demo"
+name = "<i class='fas fa-fw fa-play'></i> Demo"
 url = "http://demo.gethue.com"
 url = "http://demo.gethue.com"
 weight = 11
 weight = 11
 
 
 [[menu.shortcuts]]
 [[menu.shortcuts]]
-name = "<i class='fas fa-fw fa-bookmark'></i> Gethue.com"
+name = "<i class='fas fa-fw fa-bookmark'></i> gethue.com"
 identifier = "hugodoc"
 identifier = "hugodoc"
 url = "http://gethue.com"
 url = "http://gethue.com"
 weight = 20
 weight = 20

+ 2 - 2
docs/docs-site/content/_index.md

@@ -10,11 +10,11 @@ pre = "<b>1. </b>"
 
 
 The manual to install, use and develop Hue.
 The manual to install, use and develop Hue.
 
 
-Hue is an open source workbench for self-service operation and development of SQL applications
+Hue is a mature open source workbench for self-service operation and development of SQL applications
 in a Data Warehouse: [gethue.com](http://gethue.com).
 in a Data Warehouse: [gethue.com](http://gethue.com).
 
 
 Thousands of companies and organizations use Hue to open-up and query their data and make smarter decisions. Hue is heavily
 Thousands of companies and organizations use Hue to open-up and query their data and make smarter decisions. Hue is heavily
-used by hundreds of Cloudera customers executing millions of queries daily.
+used by hundreds of Cloudera customers and community users executing millions of queries daily.
 
 
 
 
 Administrate
 Administrate

+ 2 - 3
docs/docs-site/content/administrator/_index.md

@@ -9,11 +9,10 @@ pre = "<b>1. </b>"
 ### Guide
 ### Guide
 
 
 The following instructions describe how to install Hue and configure it to points to external services
 The following instructions describe how to install Hue and configure it to points to external services
-(e.g. Databases, Hadoop...).
+(e.g. Databases, Hadoop, S3, ...).
 
 
 Hue consists of a web service that runs on a special node in your cluster.
 Hue consists of a web service that runs on a special node in your cluster.
-Choose one node where you want to run Hue. This guide refers to that node as
-the _Hue Server_. For optimal performance, this should be one of the nodes
+Choose one node where you want to run Hue. For optimal performance, this should be one of the nodes
 within your cluster, though it can be a remote node as long as there are no
 within your cluster, though it can be a remote node as long as there are no
 overly restrictive firewalls.
 overly restrictive firewalls.
 
 

+ 5 - 5
docs/docs-site/content/administrator/administration/reference.md

@@ -9,7 +9,7 @@ A recommended setup consists in:
 
 
 * 2 Hues and 1 Load Balancer
 * 2 Hues and 1 Load Balancer
 * Databases: MySQL InnoDB, PostgreSQL, Oracle
 * Databases: MySQL InnoDB, PostgreSQL, Oracle
-* Authentication: [LDAP or Username/Passord](#user-management)
+* Authentication: [LDAP or Username/Password](../user-management/)
 
 
 ### Monitoring
 ### Monitoring
 
 
@@ -20,14 +20,14 @@ Performing a `GET /desktop/debug/is_alive` will return a 200 response if running
 
 
 Hue is often run with:
 Hue is often run with:
 
 
-* Cherrypy with Httpd
+* Cherrypy with HTTPD (built-in when using Cloudera Manager)
+* [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/) (recommended)
 * [Apache mod Python](http://gethue.com/how-to-run-hue-with-the-apache-server/)
 * [Apache mod Python](http://gethue.com/how-to-run-hue-with-the-apache-server/)
-* [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/)
 
 
 ### Task Server
 ### Task Server
 
 
 The task server is currently a work in progress to outsource all the blocking or resource intensive operations
 The task server is currently a work in progress to outsource all the blocking or resource intensive operations
-outside of the API server. Follow (HUE-8738)[https://issues.cloudera.org/browse/HUE-8738) for more information
+outside of the API server. Follow [HUE-8738](https://issues.cloudera.org/browse/HUE-8738) for more information
 on when first usable task will be released.
 on when first usable task will be released.
 
 
 Until then, here is how to try the task server service.
 Until then, here is how to try the task server service.
@@ -68,4 +68,4 @@ or when Django Celery Beat is enabled:
 
 
 A Web proxy lets you centralize all the access to a certain URL and prettify the address (e.g. ec2-54-247-321-151.compute-1.amazonaws.com --> demo.gethue.com).
 A Web proxy lets you centralize all the access to a certain URL and prettify the address (e.g. ec2-54-247-321-151.compute-1.amazonaws.com --> demo.gethue.com).
 
 
-Here is one way to do it with [Apache](http://gethue.com/i-put-a-proxy-on-hue/).
+Here is one way to do it with [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/) or [Apache](http://gethue.com/i-put-a-proxy-on-hue/).

+ 0 - 2
docs/docs-site/content/administrator/administration/user-management.md

@@ -56,8 +56,6 @@ superusers and users.
     username. For superusers, the user and group are username and
     username. For superusers, the user and group are username and
     supergroup.</td></tr></table>
     supergroup.</td></tr></table>
 
 
-
-
 3.  Click **Add User** to save the information you specified and close
 3.  Click **Add User** to save the information you specified and close
     the **Add User** wizard or click **Next**.
     the **Add User** wizard or click **Next**.
 4.  In the **Names and Groups** screen, add optional information.
 4.  In the **Names and Groups** screen, add optional information.

+ 32 - 27
docs/docs-site/content/administrator/connectors/editor/_index.md → docs/docs-site/content/administrator/configuration/editor/_index.md

@@ -1,13 +1,14 @@
 ---
 ---
-title: "SQL"
+title: "SQL Connectors"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
 weight: 1
 weight: 1
 ---
 ---
 
 
 The goal of the Editor is to open-up data to more users by making self service querying easy and productive.
 The goal of the Editor is to open-up data to more users by making self service querying easy and productive.
+It has one of the best SQL autocomplete and many [more features](/user/editor/).
 
 
-It is available in Editor or Notebook mode and focuses on SQL. Dialects can be added to the main `[notebook]` section like this:
+It is available in Editor or Notebook. Dialects can be added to the main `[notebook]` section like this:
 
 
     [notebook]
     [notebook]
 
 
@@ -19,35 +20,14 @@ It is available in Editor or Notebook mode and focuses on SQL. Dialects can be a
           # The backend connection to use to communicate with the server.
           # The backend connection to use to communicate with the server.
           interface=hiveserver2
           interface=hiveserver2
 
 
-        [[[mysqlalche]]]
-          name = MySQL alchemy
+        [[[mysql]]]
+          name = MySQL
           interface=sqlalchemy
           interface=sqlalchemy
           options='{"url": "mysql://root:root@localhost:3306/hue"}'
           options='{"url": "mysql://root:root@localhost:3306/hue"}'
 
 
+## Connectors
 
 
-Download and export options with limited scalability can be limited in the number of rows or bytes transferred using the following options respectively in your hue.ini:
-
-        [beeswax]
-        # A limit to the number of rows that can be downloaded from a query before it is truncated.
-        # A value of -1 means there will be no limit.
-        download_row_limit=-1
-
-        # A limit to the number of bytes that can be downloaded from a query before it is truncated.
-        # A value of -1 means there will be no limit.
-        download_bytes_limit=-1
-
-In addition, it is possible to disable the download and export feature in the editor, dashboard, as well as in the file browser with the following option in your hue.ini:
-
-        [desktop]
-        # Global setting to allow or disable end user downloads in all Hue.
-        # e.g. Query result in Editors and Dashboards, file in File Browser...
-        enable_download=false
-
-The download feature in the file browser can be disabled separately with the following options in your hue.ini:
-
-        [filebrowser]
-        show_download_button=false
-
+Native connectors (via the `hiveserver2` interface) are recommended for Hive and Impala, otherwise SqlAlchemy is prefered.
 
 
 ### Impala
 ### Impala
 
 
@@ -365,3 +345,28 @@ You can leave out the username and password in the JDBC options, and Hue will in
     [[[pig]]]
     [[[pig]]]
       name=Pig
       name=Pig
       interface=oozie
       interface=oozie
+
+## Editor
+
+Download and export options with limited scalability can be limited in the number of rows or bytes transferred using the following options respectively in your hue.ini:
+
+        [beeswax]
+        # A limit to the number of rows that can be downloaded from a query before it is truncated.
+        # A value of -1 means there will be no limit.
+        download_row_limit=-1
+
+        # A limit to the number of bytes that can be downloaded from a query before it is truncated.
+        # A value of -1 means there will be no limit.
+        download_bytes_limit=-1
+
+In addition, it is possible to disable the download and export feature in the editor, dashboard, as well as in the file browser with the following option in your hue.ini:
+
+        [desktop]
+        # Global setting to allow or disable end user downloads in all Hue.
+        # e.g. Query result in Editors and Dashboards, file in File Browser...
+        enable_download=false
+
+The download feature in the file browser can be disabled separately with the following options in your hue.ini:
+
+        [filebrowser]
+        show_download_button=false

+ 35 - 111
docs/docs-site/content/administrator/configuration/external/_index.md

@@ -1,125 +1,34 @@
 ---
 ---
-title: "External services"
+title: "Other services"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
-weight: 2
+weight: 4
 ---
 ---
 
 
-### HDFS
-
-Hue supports one HDFS cluster. That cluster should be defined
-under the `[[[default]]]` sub-section.
-
-    fs_defaultfs::
-      This is the equivalence of `fs.defaultFS` (aka `fs.default.name`) in
-      Hadoop configuration.
-
-    webhdfs_url::
-      You can also set this to be the HttpFS url. The default value is the HTTP
-      port on the NameNode.
-
-    hadoop_conf_dir::
-      This is the configuration directory of the HDFS, typically
-      `/etc/hadoop/conf`.
-
-### S3
-
-Hue's filebrowser can now allow users to explore, manage, and upload data in an S3 account, in addition to HDFS.
-
-Read more about it in the [S3 User Documentation](/user/browsers/#s3).
-
-In order to add an S3 account to Hue, you'll need to configure Hue with valid S3 credentials, including the access key ID and secret access key: [AWSCredentials](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)
-
-These keys can securely stored in a script that outputs the actual access key and secret key to stdout to be read by Hue (this is similar to how Hue reads password scripts). In order to use script files, add the following section to your hue.ini configuration file:
-
-
-    [aws]
-    [[aws_accounts]]
-    [[[default]]]
-    access_key_id_script=/path/to/access_key_script
-    secret_access_key_script= /path/to/secret_key_script
-    allow_environment_credentials=false
-    region=us-east-1
-
-
-Alternatively (but not recommended for production or secure environments), you can set the access_key_id and secret_access_key values to the plain-text values of your keys:
-
-    [aws]
-    [[aws_accounts]]
-    [[[default]]]
-    access_key_id=s3accesskeyid
-    secret_access_key=s3secretaccesskey
-    allow_environment_credentials=false
-    region=us-east-1
-
-The region should be set to the AWS region corresponding to the S3 account. By default, this region will be set to 'us-east-1'.
-
-
-**Using Ceph**
-New end points have been added in [HUE-5420](https://issues.cloudera.org/browse/HUE-5420)
-
-
-### ADLS
-
-Hue's file browser can now allow users to explore, manage, and upload data in an ADLS, in addition to HDFS and S3.
-
-Read more about it in the [ADLS User Documentation](/user/browsers/#adls).
-
-In order to add an ADLS account to Hue, you'll need to configure Hue with valid ADLS credentials, including the client ID, client secret and tenant ID.
-These keys can securely stored in a script that outputs the actual access key and secret key to stdout to be read by Hue (this is similar to how Hue reads password scripts). In order to use script files, add the following section to your hue.ini configuration file:
-
-    [adls]
-    [[azure_accounts]]
-    [[[default]]]
-    client_id_script=/path/to/client_id_script.sh
-    client_secret_script=/path/to/client_secret_script.sh
-    tenant_id_script=/path/to/tenant_id_script.sh
-
-    [[adls_clusters]]
-    [[[default]]]
-    fs_defaultfs=adl://<account_name>.azuredatalakestore.net
-    webhdfs_url=https://<account_name>.azuredatalakestore.net
-
-Alternatively (but not recommended for production or secure environments), you can set the client_secret value in plain-text:
-
-    [adls]
-    [[azure_account]]
-    [[[default]]]
-    client_id=adlsclientid
-    client_secret=adlsclientsecret
-    tenant_id=adlstenantid
-
-    [[adls_clusters]]
-    [[[default]]]
-    fs_defaultfs=adl://<account_name>.azuredatalakestore.net
-    webhdfs_url=https://<account_name>.azuredatalakestore.net
-
-
 ## YARN Cluster
 ## YARN Cluster
 
 
 Hue supports one or two Yarn clusters (two for HA). These clusters should be defined
 Hue supports one or two Yarn clusters (two for HA). These clusters should be defined
 under the `[[[default]]]` and `[[[ha]]]` sub-sections.
 under the `[[[default]]]` and `[[[ha]]]` sub-sections.
 
 
-    resourcemanager_host:
-      The host running the ResourceManager.
-
-    resourcemanager_port:
-      The port for the ResourceManager REST service.
+    # Configuration for YARN (MR2)
+    # ------------------------------------------------------------------------
+    [[yarn_clusters]]
 
 
-    logical_name:
-      NameNode logical name.
+      [[[default]]]
 
 
-    submit_to:
-      To enable the section, set to True.
+        resourcemanager_host=yarn-rm.com
+        resourcemanager_api_url=http://yarn-rm.com:8088/
+        proxy_api_url=http://yarn-proxy.com:8088/
+        resourcemanager_port=8032
+        history_server_api_url=http://yarn-rhs-com:19888/
 
 
 ## Oozie
 ## Oozie
 
 
 In the `[liboozie]` section of the configuration file, you should
 In the `[liboozie]` section of the configuration file, you should
 specify:
 specify:
 
 
-    oozie_url:
-      The URL of the Oozie service. It is the same as the `OOZIE_URL`
-      environment variable for Oozie.
+    [liboozie]
+      oozie_url=http://oozie-server.com:11000/oozie
 
 
 
 
 ## Solr
 ## Solr
@@ -127,14 +36,29 @@ specify:
 In the `[search]` section of the configuration file, you should
 In the `[search]` section of the configuration file, you should
 specify:
 specify:
 
 
-    solr_url:
-      The URL of the Solr service.
+    [search]
+      # URL of the Solr Server
+      solr_url=http://solr-server.com:8983/solr/
 
 
+## Spark
 
 
-## HBase
+The `[spark]` section details how to point to [https://livy.incubator.apache.org/](https://livy.incubator.apache.org/) in order to execute interactive Spark snippets in Scala or Python.
 
 
-In the `[hbase]` section of the configuration file, you should
-specify:
+    [spark]
+      # Host address of the Livy Server.
+      ## livy_server_host=localhost
+
+      # Port of the Livy Server.
+      ## livy_server_port=8998
+
+## Catalog
+
+In the `[metadata]` section, Hue is supporting Cloudera Navigator data catalog and soon Apache Atlas ([HUE-8749](https://issues.cloudera.org/browse/HUE-8749)).
+
+## Query Optimization
+
+In the `[metadata]` section, Hue is supporting Cloudera Navigator Optimiser and soon other services. The goal is to provide recommendation on how to write better queries and get risk alerts on dangerous operations.
+
+## Kafka
 
 
-    hbase_clusters:
-      Comma-separated list of HBase Thrift servers for clusters in the format of "(name|host:port)".
+The configuration is in `[kafka]` but the service is still experiemental.

+ 14 - 50
docs/docs-site/content/administrator/connectors/files/_index.md → docs/docs-site/content/administrator/configuration/files/_index.md

@@ -1,28 +1,28 @@
 ---
 ---
-title: "Files and Object Store"
+title: "Files and Stores"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
-weight: 2
+weight: 3
 ---
 ---
 
 
-### HDFS
+## HDFS
 
 
 Hue supports one HDFS cluster. That cluster should be defined
 Hue supports one HDFS cluster. That cluster should be defined
 under the `[[[default]]]` sub-section.
 under the `[[[default]]]` sub-section.
 
 
-    fs_defaultfs::
-      This is the equivalence of `fs.defaultFS` (aka `fs.default.name`) in
-      Hadoop configuration.
+    [hadoop]
 
 
-    webhdfs_url::
-      You can also set this to be the HttpFS url. The default value is the HTTP
-      port on the NameNode.
+      # Configuration for HDFS NameNode
+      # ------------------------------------------------------------------------
+      [[hdfs_clusters]]
 
 
-    hadoop_conf_dir::
-      This is the configuration directory of the HDFS, typically
-      `/etc/hadoop/conf`.
+        [[[default]]]
+          fs_defaultfs=hdfs://hdfs-name-node.com:8020
+          webhdfs_url=http://hdfs-name-node.com:20101/webhdfs/v1
 
 
-### S3
+HA is supported by pointing to the HttpFs service instead of the NameNode.
+
+## S3
 
 
 Hue's filebrowser can now allow users to explore, manage, and upload data in an S3 account, in addition to HDFS.
 Hue's filebrowser can now allow users to explore, manage, and upload data in an S3 account, in addition to HDFS.
 
 
@@ -59,7 +59,7 @@ The region should be set to the AWS region corresponding to the S3 account. By d
 New end points have been added in [HUE-5420](https://issues.cloudera.org/browse/HUE-5420)
 New end points have been added in [HUE-5420](https://issues.cloudera.org/browse/HUE-5420)
 
 
 
 
-### ADLS
+## ADLS
 
 
 Hue's file browser can now allow users to explore, manage, and upload data in an ADLS, in addition to HDFS and S3.
 Hue's file browser can now allow users to explore, manage, and upload data in an ADLS, in addition to HDFS and S3.
 
 
@@ -95,42 +95,6 @@ Alternatively (but not recommended for production or secure environments), you c
     webhdfs_url=https://<account_name>.azuredatalakestore.net
     webhdfs_url=https://<account_name>.azuredatalakestore.net
 
 
 
 
-## YARN Cluster
-
-Hue supports one or two Yarn clusters (two for HA). These clusters should be defined
-under the `[[[default]]]` and `[[[ha]]]` sub-sections.
-
-    resourcemanager_host:
-      The host running the ResourceManager.
-
-    resourcemanager_port:
-      The port for the ResourceManager REST service.
-
-    logical_name:
-      NameNode logical name.
-
-    submit_to:
-      To enable the section, set to True.
-
-## Oozie
-
-In the `[liboozie]` section of the configuration file, you should
-specify:
-
-    oozie_url:
-      The URL of the Oozie service. It is the same as the `OOZIE_URL`
-      environment variable for Oozie.
-
-
-## Solr
-
-In the `[search]` section of the configuration file, you should
-specify:
-
-    solr_url:
-      The URL of the Solr service.
-
-
 ## HBase
 ## HBase
 
 
 In the `[hbase]` section of the configuration file, you should
 In the `[hbase]` section of the configuration file, you should

+ 1 - 2
docs/docs-site/content/administrator/configuration/hue/_index.md

@@ -5,7 +5,7 @@ draft: false
 weight: 1
 weight: 1
 ---
 ---
 
 
-
+This section is about configuring the Hue server itself.
 These configuration variables are under the `[desktop]` section in
 These configuration variables are under the `[desktop]` section in
 the `hue.ini` configuration file.
 the `hue.ini` configuration file.
 
 
@@ -218,4 +218,3 @@ When idle_session_timeout is set, users will automatically be logged out after N
 ## Auditing
 ## Auditing
 
 
 Read more about [Auditing User Administration Operations with Hue and Cloudera Navigator](http://gethue.com/auditing-user-administration-operations-with-hue-and-cloudera-navigator-2/).
 Read more about [Auditing User Administration Operations with Hue and Cloudera Navigator](http://gethue.com/auditing-user-administration-operations-with-hue-and-cloudera-navigator-2/).
-

+ 0 - 11
docs/docs-site/content/administrator/connectors/_index.md

@@ -1,11 +0,0 @@
----
-title: "Connectors"
-date: 2019-03-13T18:28:09-07:00
-draft: false
-weight: 2
----
-
-The source of truth sits in the main [hue.ini](https://github.com/cloudera/hue/blob/master/desktop/conf.dist/hue.ini).
-It consists in several [ini sections](https://en.wikipedia.org/wiki/INI_file#Sections). Lines needs to be uncommented to be active.
-
-Hue is using Hadoop `impersonation` to be able to communicate properly with certain services. This is described in the following [Service Configuration](../configuration/external/).

+ 2 - 0
docs/docs-site/content/administrator/installation/docker.md

@@ -6,3 +6,5 @@ weight: 3
 ---
 ---
 
 
 Alternatively to building Hue into an image, the [Hue Docker Guide](https://github.com/cloudera/hue/tree/testing/tools/docker) is available.
 Alternatively to building Hue into an image, the [Hue Docker Guide](https://github.com/cloudera/hue/tree/testing/tools/docker) is available.
+
+It details how to start a Hue in one command line or build a container image with all the dependencies.

+ 5 - 5
docs/docs-site/content/administrator/installation/starting.md

@@ -1,12 +1,11 @@
 ---
 ---
-title: "Starting the server"
+title: "Running"
 date: 2019-03-13T18:28:08-07:00
 date: 2019-03-13T18:28:08-07:00
 draft: false
 draft: false
 weight: 4
 weight: 4
 ---
 ---
 
 
-After your cluster is running with the plugins enabled, you can start Hue on
-your Hue Server by running:
+After the installation, you can start Hue on your Hue Server by doing:
 
 
     build/env/bin/supervisor
     build/env/bin/supervisor
 
 
@@ -15,10 +14,11 @@ components. Your Hue installation is now running.
 
 
 After installation, you can use Hue by navigating to `http://myserver:8888/`.
 After installation, you can use Hue by navigating to `http://myserver:8888/`.
 
 
-The [user guide](/user/index.html) will help users go through the various installed applications.
+Next step is to [configure](/configuration/index.html) Hue to point to the external services.
+Then, the [user guide](/user/index.html) will help users go through the various installed applications.
 
 
 
 
-Supported Browsers
+**Supported Browsers**
 
 
 The two latest LTS versions of each browsers:
 The two latest LTS versions of each browsers:
 
 

+ 14 - 6
docs/docs-site/content/developer/_index.md

@@ -8,12 +8,20 @@ pre = "<b>3. </b>"
 
 
 Hue service integration is generic and lets you integrate with other analytics systems. Here is a list of the main APIs:
 Hue service integration is generic and lets you integrate with other analytics systems. Here is a list of the main APIs:
 
 
-* Connect or create SQL connectors to any Database
-* List any files from any filesytem
-* List any job or query list
-* Integrate with a Data Catalog
+* Connect or create SQL connectors to any database (Impala, MySQL, Presto...)
+* List any files from any filesytem (HDFS, S3, ADLS, GSF...)
+* List any job or query list (YARN, SQL queries, Kubernetes...)
+* Integrate with a Data Catalog (Cloudera Navigator, Apache Atlas...)
 
 
-REST APIs are not all public yet but this is work in progress in [HUE-1450](https://issues.cloudera.org/browse/HUE-1450).
-Upcoming APIs: how to add new vizualizations, new SQL grammar and highlighting, workflow systems.
 In addition, whole new apps can also be created in order to provide end to end solutions.
 In addition, whole new apps can also be created in order to provide end to end solutions.
 
 
+Upcoming & Contribution ideas
+
+* How to add new SQL grammar and highlighting
+* Better Query Builder
+* Better Dashboard & Reporting
+* Framework to add new vizualizations
+* Framework to embed vizualizations
+* How to integrate smart query troubleshooting/recommendation systems (Cloudera Navigator Optimizer...)
+* Generic workflow system (Apache Oozie, Apache Airflow, Celery Tasks...)
+* Check the [Roadmap](https://github.com/cloudera/hue/blob/master/docs/ROADMAP.md)

+ 3 - 3
docs/docs-site/content/developer/api/_index.md

@@ -2,7 +2,7 @@
 title: "APIs"
 title: "APIs"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
-weight: 2
+weight: 3
 ---
 ---
 
 
 Hue can be accessed directly via a Django Python Shell or by its REST API (recommended).
 Hue can be accessed directly via a Django Python Shell or by its REST API (recommended).
@@ -44,7 +44,7 @@ And finally launch the shell by:
 
 
 Then use the Python code to access a certain user information:
 Then use the Python code to access a certain user information:
 
 
-    Python 2.7.6 (default, Oct 26 2016, 20:30:19) 
+    Python 2.7.6 (default, Oct 26 2016, 20:30:19)
     Type "copyright", "credits" or "license" for more information.
     Type "copyright", "credits" or "license" for more information.
 
 
     IPython 5.2.0 -- An enhanced Interactive Python.
     IPython 5.2.0 -- An enhanced Interactive Python.
@@ -90,7 +90,7 @@ Then use the Python code to access a certain user information:
 
 
 ## REST
 ## REST
 
 
-The API is being made public via [HUE-1450](https://issues.cloudera.org/browse/HUE-1450).
+REST APIs are not all public yet but this is work in progress in [HUE-1450](https://issues.cloudera.org/browse/HUE-1450).
 
 
 ### Metadata Catalog
 ### Metadata Catalog
 
 

+ 1 - 1
docs/docs-site/content/developer/browsers/_index.md

@@ -1,5 +1,5 @@
 ---
 ---
-title: "File / Job Browsers"
+title: "Browsers"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
 weight: 3
 weight: 3

+ 2 - 3
docs/docs-site/content/developer/development/_index.md

@@ -2,12 +2,11 @@
 title: "Development"
 title: "Development"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
-weight: 2
+weight: 1
 ---
 ---
 
 
 
 
-This section goes into greater detail on useful features within
-the Hue environment.
+This section goes into greater detail on how to build and reuse the components of Hue.
 
 
 ## Building
 ## Building
 
 

+ 15 - 12
docs/docs-site/content/developer/editor/_index.md

@@ -1,8 +1,8 @@
 ---
 ---
-title: "SQL Editor / Notebook"
+title: "Editor / Notebook"
 date: 2019-03-13T18:28:09-07:00
 date: 2019-03-13T18:28:09-07:00
 draft: false
 draft: false
-weight: 1
+weight: 2
 ---
 ---
 
 
 They provide SQL integration with any database via several connectors (native, JDBC, SQL Alchemy...).
 They provide SQL integration with any database via several connectors (native, JDBC, SQL Alchemy...).
@@ -13,23 +13,26 @@ Connectors are pluggable and can new engines can be supported. Feel free to comm
 
 
 ## SQL
 ## SQL
 
 
-The [SQL Editor page](http://gethue.com/custom-sql-query-editors/) also describes the configuration steps.
+The [Editor Configuration](/administrator/configuration/editor/) also describes the configuration steps.
 
 
-Close to 100% of [Hive and Impala grammar](desktop/core/src/desktop/static/desktop/js/autocomplete/jison) is supported which makes the
-autocomplete extremly powerful. Other languages defaults to a generic SQL grammar.
+Close to 100% of [Hive and Impala grammar](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/static/desktop/js/autocomplete/jison) is supported which makes the autocomplete extremly powerful. Other languages defaults to a generic SQL grammar.
+
+**Coming Soon**
+How to write your own SQL parser.
 
 
 ### HiveServer2 API
 ### HiveServer2 API
 Hive, Impala, SparkSQL
 Hive, Impala, SparkSQL
 
 
 ### SQL Alchemy
 ### SQL Alchemy
-SQL Alchemy supports comes with [HUE-8740](https://issues.cloudera.org/browse/HUE-8740).
+SQL Alchemy is the prefered way if the HiveServer2 API is not supported by the database. More enterprise support will come with [HUE-8740](https://issues.cloudera.org/browse/HUE-8740).
 
 
 ### Python Connectors
 ### Python Connectors
 MySQL, Oracle, PostgreSQL, Phoenix, Presto, Kylin, Redshift, BigQuery, Drill
 MySQL, Oracle, PostgreSQL, Phoenix, Presto, Kylin, Redshift, BigQuery, Drill
 
 
 ### JDBC
 ### JDBC
-Use the query editor with any [JDBC](http://gethue.com/custom-sql-query-editors/) or Django-compatible database.
-View the [JDBC connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/jdbc.py).
+Use the query editor with any JDBC compatible database. View the [JDBC connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/jdbc.py).
+
+**Note** Going forward, SQL Alchemy is prefered as more "Python native".
 
 
 ### Solr SQL
 ### Solr SQL
 [Solr connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/solr.py)
 [Solr connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/solr.py)
@@ -38,6 +41,8 @@ View the [JDBC connector](https://github.com/cloudera/hue/blob/master/desktop/li
 
 
 ## Jobs
 ## Jobs
 
 
+The Job Browser is generic and can list any type of jobs, queries and provide bulk operations like kill, pause, delete... and access to logs and recommendations.
+
 ### Oozie
 ### Oozie
 MapReduce, Pig, Java, Shell, Sqoop, DistCp [Oozie connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/oozie_batch.py)
 MapReduce, Pig, Java, Shell, Sqoop, DistCp [Oozie connector](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/oozie_batch.py)
 
 
@@ -59,7 +64,7 @@ The API was influenced by Solr but is now generic:
 
 
 [Dashboard API](https://github.com/cloudera/hue/blob/master/desktop/libs/dashboard/src/dashboard/dashboard_api.py)
 [Dashboard API](https://github.com/cloudera/hue/blob/master/desktop/libs/dashboard/src/dashboard/dashboard_api.py)
 
 
-## SQL
+### SQL
 
 
 [SQL API](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/dashboard_api.py)
 [SQL API](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/dashboard_api.py)
 
 
@@ -72,12 +77,10 @@ When HS2, RDBMS, and JDBC Are Not Enough
 
 
 If the built-in HiveServer2 (Hive, Impala, Spark SQL), RDBMS (MySQL, PostgreSQL, Oracle, SQLite), and JDBC interfaces don’t meet your needs, you can implement your own connector to the notebook app: [Notebook Connectors](https://github.com/cloudera/hue/tree/master/desktop/libs/notebook/src/notebook/connectors). Each connector API subclasses the [Base API](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/base.py) and must implement the methods defined within; refer to the [JdbcApi](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/jdbc.py) or [RdbmsApi](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/rdbms.py) for representative examples.
 If the built-in HiveServer2 (Hive, Impala, Spark SQL), RDBMS (MySQL, PostgreSQL, Oracle, SQLite), and JDBC interfaces don’t meet your needs, you can implement your own connector to the notebook app: [Notebook Connectors](https://github.com/cloudera/hue/tree/master/desktop/libs/notebook/src/notebook/connectors). Each connector API subclasses the [Base API](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/base.py) and must implement the methods defined within; refer to the [JdbcApi](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/jdbc.py) or [RdbmsApi](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/rdbms.py) for representative examples.
 
 
-## Search
-
 ### Solr
 ### Solr
 
 
 [Solr Dashboard API](https://github.com/cloudera/hue/blob/master/apps/search/src/search/dashboard_api.py)
 [Solr Dashboard API](https://github.com/cloudera/hue/blob/master/apps/search/src/search/dashboard_api.py)
 
 
 ### Elastic Search
 ### Elastic Search
 
 
-A similar backend to Solr would need to be developed: [HUE-7828](https://issues.cloudera.org/browse/HUE-7828)
+A connector similar to Solr or SQL Alchemy binding would need to be developed [HUE-7828](https://issues.cloudera.org/browse/HUE-7828)

+ 1 - 1
docs/docs-site/content/releases/_index.md

@@ -6,4 +6,4 @@ chapter = false
 pre = "<b>4. </b>"
 pre = "<b>4. </b>"
 +++
 +++
 
 
-List of all the product releases.
+Hue is a mature product continuously evolving that is more than 10 years old. Here is the list of all the product releases.

+ 3 - 23
docs/docs-site/content/user/editor/_index.md

@@ -9,29 +9,9 @@ The goal of Hue's Editor is to make data querying easy and productive.
 
 
 It focuses on SQL but also supports job submissions. It comes with an intelligent autocomplete, search & tagging of data and query assistance.
 It focuses on SQL but also supports job submissions. It comes with an intelligent autocomplete, search & tagging of data and query assistance.
 
 
-The [custom SQL Editor page](http://gethue.com/custom-sql-query-editors/) also describes the configuration steps. Any editor can be `starred`
-next to its name so that it becomes the default editor and the landing page when logging in.
-
-First, in your hue.ini file, you will need to add the relevant database connection information under the librdbms section:
-
-    [librdbms]
-      [[databases]]
-        [[[postgresql]]]
-        nice_name=PostgreSQL
-        name=music
-        engine=postgresql_psycopg2
-        port=5432
-        user=hue
-        password=hue
-        options={}
-
-Secondly, we need to add a new interpreter to the notebook app. This will allow the new database type to be registered as a snippet-type in the Notebook app. For query editors that use a Django-compatible database, the name in the brackets should match the database configuration name in the librdbms section (e.g. – postgresql). The interface will be set to rdbms. This tells Hue to use the librdbms driver and corresponding connection information to connect to the database. For example, with the above postgresql connection configuration in the librdbms section, we can add a PostgreSQL interpreter with the following notebook configuration:
-
-    [notebook]
-      [[interpreters]]
-        [[[postgresql]]]
-        name=PostgreSQL
-        interface=rdbms
+Any editor can be `starred` next to its name so that it becomes the default editor and the landing page when logging in.
+
+Configuration of the connectors is currently done by the [Administrator](/administrator/configuration/editor/).
 
 
 ## Concepts
 ## Concepts
 ### Running Queries
 ### Running Queries

+ 1 - 2
docs/docs-site/layouts/partials/menu-footer.html

@@ -1,2 +1 @@
-<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> with <a href="http://gohugo.io/">Hugo</a></p>
-
+<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn">Learn</a> and <a href="http://gohugo.io/">Hugo</a></p>