Эх сурвалжийг харах

HUE-8888 [docs] Simplify developer landing page

Romain 5 жил өмнө
parent
commit
ac932665a1

+ 1 - 1
README.md

@@ -17,7 +17,7 @@ Many companies and organizations use Hue to quickly answer questions via self-se
 
 are executing 100s of 1000s of queries daily. It also [ships](https://docs.gethue.com/administrator/installation/) in Cloudera Data Platform, Amazon AWS, Open Data Hub...
 
-Hue is also ideal for building your own [Cloud SQL Editor](https://docs.gethue.com/developer/api/) and any [contributions](CONTRIBUTING.md) are welcome.
+Hue is also ideal for building your own [Cloud SQL Editor](https://docs.gethue.com/developer/api/) and any [contributions](https://docs.gethue.com/developer/) are welcome.
 
 
 ![Hue Editor](https://cdn.gethue.com/uploads/2019/12/hue4.6.png)

+ 5 - 12
docs/docs-site/content/developer/_index.md

@@ -6,18 +6,11 @@ chapter = false
 pre = "<b>3. </b>"
 +++
 
-Hue services are generic and let you integrate with other analytics systems for [querying](/user/querying/) and [browsing](/user/browsing/). Here is a list of the main APIs:
+Those are the main categories of development:
 
-* Connect or create SQL [autocompletes](/developer/parsers/) or connectors to [any database](/administrator/configuration/connectors/#databases) (Impala, MySQL, Presto...)
-* Browse additional storage systems (HDFS, S3, ADLS/ABFS, GS...)
-* List any jobs or queries (YARN, SQL queries, Kubernetes...)
-* Integrate with a [Data Catalog](/user/browsing/#data-catalogs) (Apache Atlas, Cloudera Navigator...) or a Query Optimization service
+* **Web application**: ramping-up with on the overall [Hue development](/developer/development) service
+* **SQL parsers**: update or reuse SQL [parsers](/developer/parsers/) or editor scratchpad
+* **Connector**: access your own data services or [data warehouses](/administrator/configuration/connectors/#databases)
 
-In addition, whole new apps can also be created in order to provide end to end solutions.
 
-Majoritively, this section would be useful for learning about:
-
-* Ramping-up with the overall Hue [development](/developer/development) project
-* How to improve the [SQL autocomplete](/developer/parsers/) for your own database
-* How SqlAlchemy is becoming the [standard API](https://github.com/cloudera/hue/blob/master/desktop/libs/notebook/src/notebook/connectors/sql_alchemy.py) for databases other than Hive and Impala
-* Checking and getting started on other [contribution ideas](https://github.com/cloudera/hue/blob/master/CONTRIBUTING.md)
+Also check on how to get started on [contribution ideas](https://github.com/cloudera/hue/blob/master/CONTRIBUTING.md).

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

@@ -8,9 +8,9 @@ weight: 5
 Hue can easily be extended to natively support other databases or be enriched via other data catalogs. Some components of Hue like the SQL parsers or Editor Scratchpad can also be imported independently as dependencies into your own apps.
 
 
-## SQL autocompletion
+## SQL Editor
 
-The [parsers](/developer/parsers/) are the flagship part of the Hue and power extremely advanced autocompletes or other [SQL functionalities](/user/querying/#autocomplete). They are running on the client side and comes with just a few megabytes of JavaScript that are cached by the browser. This provides a very reactive experience to the end user and allows to import them as classic JavaScript modules for your own development needs.
+The [parsers](/developer/parsers/) are the flagship part of Hue and power extremely advanced autocompletes and other [SQL functionalities](/user/querying/#autocomplete). They are running on the client side and comes with just a few megabytes of JavaScript that are cached by the browser. This provides a very reactive experience to the end user and allows to import them as classic JavaScript modules for your own development needs.
 
 While the dynamic content like the list of tables, columns is obviously fetched via [remote endpoints](#sql-querying), all the SQL knowledge of the statements is available.
 
@@ -108,7 +108,7 @@ Which then will output keywords suggestions and all the known locations:
         { value: 'WITH', weight: -1 } ],
       definitions: [] }
 
-### SQL scratchpad
+### Scratchpad
 
 The lightweight SQL Editor also called "Quick Query" comes as a [Web component](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/js/ko/components/contextPopover/ko.quickQueryContext.js).
 

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

@@ -66,7 +66,7 @@ The backends is pluggable by providing alternative [client interfaces](https://g
 
 Various storage systems can be interacted with. The [`fsmanager.py`](https://github.com/cloudera/hue/blob/master/desktop/core/src/desktop/lib/fsmanager.py) is the main router to each API.
 
-**Note** Ceph can be used via the S3 browser.
+**Note** Apache Ozone as well as Ceph can be used via the S3 browser.
 
 ### Hadoop HDFS
 

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

@@ -332,6 +332,6 @@ And cf. above [prerequisites](#prerequisites), any interpreter snippet with `ksq
 
 Note: after [HUE-8758](https://issues.cloudera.org/browse/HUE-8758) we will be able to have multiple interpreters on the same dialect (e.g. pointing to two different databases of the same type).
 
-## Exporting a parser
+## API: Exporting a parser
 
 Parsers generated by Hue are JavaScript modules. This makes it easy to import a parser into your own apps (e.g. Webapp, Node.Js...). How to do it is described in depth in the [API section](/developer/api/#sql-autocompletion).