瀏覽代碼

HUE-8888 [docs] Simplification of contribution guidelines

Romain 6 年之前
父節點
當前提交
01c4ed98f2
共有 4 個文件被更改,包括 31 次插入32 次删除
  1. 12 27
      CONTRIBUTING.md
  2. 10 4
      docs/ROADMAP.md
  3. 3 1
      docs/docs-site/content/user/browsing/_index.md
  4. 6 0
      docs/docs-site/content/user/querying/_index.md

+ 12 - 27
CONTRIBUTING.md

@@ -11,23 +11,10 @@ In any case, feel free to ask here, on the [forum](https://discourse.gethue.com/
 
 Here is some inspiration on which areas would love to have some contributions:
 
-1. Updating a small piece of [documentation](https://docs.gethue.com).
-2. High level [Roadmap](/docs/ROADMAP.md).
-3. [JIRA](https://issues.cloudera.org/browse/HUE) is the bug tracking system as well as [Github issues](https://github.com/cloudera/hue/issues).
-4. Generally, improving or creating connectors should be the best projects:
-* SQL (Tip: read (how to write a parser)[link]
-  * Hive LLAP
-  * Parser for [Apache Calcite](https://calcite.apache.org)
-  * Parser for PartiQl
-  * Parser for ZetaSql
-  * SqlAlchemy (any improvements to connectors for Druid, Phoenix...)
-  * Sql streams (Kafka SQL, Flink SQL...)
-  * Elastic Search, [Solr](http://gethue.com/sql-editor-for-solr-sql/)
-* Storage: Google Storage
-* Query Optimization
-* Data Catalog
-* Document Sharing (Slack, email...)
-* Result Sharing (Google Spreadsheet, Slack...)
+1. Updating a small piece of [documentation](https://docs.gethue.com)
+2. High level [Roadmap](/docs/ROADMAP.md)
+3. Check [Github issues](https://github.com/cloudera/hue/issues) or [the bug tracking system](https://issues.cloudera.org/browse/HUE)
+4. Improving or creating SQL [autocompletes](https://docs.gethue.com/developer/parsers/) or [connectors](https://docs.gethue.com/developer/sdk/) are great projects
 
 # Submitting an improvement
 
@@ -38,28 +25,26 @@ Here are some example of changes:
 
 ## Building
 
-Have a look at [how to build Hue](https://github.com/cloudera/hue#getting-started).
+Have a look at [how to quick build](https://docs.gethue.com/developer/development/#build-start).
 
 ## Reviews
 
-It is flexible on how to do code reviews and send patches:
+It is flexible:
 
-* Github Pull request.
+* **Github Pull request**
 Prefered way. Just post the [pull request](https://github.com/cloudera/hue/pulls) and reviewers will start from there. The CI will run a bsic set of tests for you.
-* Review Board.
+
+* **Review Board**
 For large changes. Create an account on Hue's [Review Board](https://review.cloudera.org/groups/hue).
 Post the patch against the "hue-rw" repository. Enter "hue" in the "groups" field.
-Example: [https://review.cloudera.org/r/4019/](https://review.cloudera.org/r/4019/)
-
-Blog posts about using [Code Reviews](http://gethue.com/rbtools-example-how-do-easily-do-code-reviews-with-review-board/) and the [extended process](http://gethue.com/the-hue-team-development-process/).
-
+Example: [https://review.cloudera.org/r/4019/](https://review.cloudera.org/r/4019/). Blog posts about using [Code Reviews](http://gethue.com/rbtools-example-how-do-easily-do-code-reviews-with-review-board/) and the [extended process](http://gethue.com/the-hue-team-development-process/).
 
 ## Coding Style
 
 A general rule is to follow the on-going style of the code context.
 
-* Python: Follow [Django/PEP8](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/), with the exception of using 2 spaces per indent level.
-* JavaScript: Follow the style in this [file](https://github.com/cloudera/hue/blob/master/apps/oozie/src/oozie/static/oozie/js/bundle-editor.ko.js#L18).
+* Python: Follow [Django/PEP8](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/), with the exception of using 2 spaces per indent level
+* JavaScript: Check the [EsLint](https://github.com/cloudera/hue/blob/master/.eslintrc.js) style
 
 ## CI & Tests
 

+ 10 - 4
docs/ROADMAP.md

@@ -5,10 +5,15 @@ High Level Roadmap
 
 * Editor
   * [ ] Editor v2 [HUE-8768](https://issues.cloudera.org/browse/HUE-8768)
-  * [ ] SQL Alchemy full support [HUE-8740](https://issues.cloudera.org/browse/HUE-8740)
-  * [ ] Public SQL REST APIs [HUE-1450](https://issues.cloudera.org/browse/HUE-1450)
   * [ ] Query Scheduling [HUE-3797](https://issues.cloudera.org/browse/HUE-3797)
   * [ ] Generify the risk alert and suggestion optimization API [HUE-8824](https://issues.cloudera.org/browse/HUE-8824)
+  * [ ] SQL Dashboards and Query Builder [HUE-3228](https://issues.cloudera.org/browse/HUE-3228)
+  * [ ] Public SQL REST APIs [HUE-1450](https://issues.cloudera.org/browse/HUE-1450)
+  * [ ] Additional/Improved SQL autocomplete
+    * Parser for [Apache Calcite](https://calcite.apache.org) familly, Phoenix, Druid, Presto..
+    * Parser for KSQL, Flink SQL, Elastic Search SQL, Solr SQL, PartiQl, ZetaSql..
+    * SqlAlchemy improvements for Druid, Phoenix, Elastic Search SQL..
+    * Dialect/Connector for KSQL, Flink SQL, Solr SQL, PartiQl, ZetaSql, Elastic Search..
 * Cloud
   * [ ] Configuration of connectors via the interface [HUE-8758](https://issues.cloudera.org/browse/HUE-8758)
   * [ ] Multi clusters [HUE-8330](https://issues.cloudera.org/browse/HUE-8330)
@@ -16,13 +21,14 @@ High Level Roadmap
   * [ ] Modernize CI/CD [HUE-8888](https://issues.cloudera.org/browse/HUE-8888)
   * [ ] SQL queries and requests tracing [HUE-8936](https://issues.cloudera.org/browse/HUE-8936)
   * [ ] Productionize metrics [HUE-9021](https://issues.cloudera.org/browse/HUE-9021)
+  * [ ] Google Storage connector
 * Scale
   * [ ] Task Server workers [HUE-8738](https://issues.cloudera.org/browse/HUE-8738)
   * [ ] Result caching and storage [HUE-8787](https://issues.cloudera.org/browse/HUE-8787)
 * Collaboration
   * [ ] Document sharing and collaboration improvements [HUE-8790](https://issues.cloudera.org/browse/HUE-8790)
   * [ ] Charting and visualization revamp [HUE-6093](https://issues.cloudera.org/browse/HUE-6093)
-  * [ ] SQL Dashboards and Query Builder [HUE-3228](https://issues.cloudera.org/browse/HUE-3228)
+  * [ ] Result Sharing (Google Spreadsheet, Slack...)
 * Core
   * [ ] Reference architecture [HUE-8815](https://issues.cloudera.org/browse/HUE-8815)
   * [ ] Python 3 support [HUE-8737](https://issues.cloudera.org/browse/HUE-8737)
@@ -42,7 +48,7 @@ Done
 * [x] Web Server [NGINX](http://gethue.com/using-nginx-to-speed-up-hue-3-8-0/)
 * [x] Documentation refresh [HUE-8741](https://issues.cloudera.org/browse/HUE-8741)
 * [x] Frontend moved to Webpack [HUE-8687](https://issues.cloudera.org/browse/HUE-8687)
-
+* [x] SQL Alchemy full support [HUE-8740](https://issues.cloudera.org/browse/HUE-8740)
 
 Links
 

+ 3 - 1
docs/docs-site/content/user/browsing/_index.md

@@ -410,10 +410,12 @@ Query capabilities
 Read more about it on [Browsing Impala Query Execution within the SQL Editor
 ](http://gethue.com/browsing-impala-query-execution-within-the-sql-editor/).
 
-### Workflow / Schedules (Oozie)
+### Oozie Workflow / Schedules
 
 List submitted workflows, schedules and bundles.
 
+![Oozie jobs](https://cdn.gethue.com/uploads/2016/04/hue-dash-oozie.png)
+
 ### Livy / Spark
 
 List Livy sessions and submitted statements.

+ 6 - 0
docs/docs-site/content/user/querying/_index.md

@@ -206,6 +206,12 @@ A new experimental panel when enabled can offer post risk analysis and recommend
 
 Turns a list of semi-colon separated queries into an interactive presentation by clicking on the 'Dashboard' icon. It is great for doing demos or reporting.
 
+### Scheduling
+
+Scheduling of queries is currently done via Apache Oozie and will be open to other schedulers with [HUE-3797](https://issues.cloudera.org/browse/HUE-3797).
+
+![Oozie workflows](https://cdn.gethue.comuploads/2016/04/hue-workflows.png)
+
 ## Databases & Datawarehouses
 
 ### List