Просмотр исходного кода

[docs] Add proper references to pypi

Romain Rigaux 4 лет назад
Родитель
Сommit
bd1c5d144c

+ 1 - 1
CONTRIBUTING.md

@@ -11,7 +11,7 @@ Here is some inspiration:
 
 1. Updating a small piece of [documentation](https://docs.gethue.com). Pick a page and click on "Edit The Page".
 2. High level [Roadmap](/docs/ROADMAP.md)
-3. Check [Github issues](https://github.com/cloudera/hue/issues), especially [Good First Issues](https://github.com/cloudera/hue/pulls?q=is%3Apr+is%3Aopen+label%3A%22good+first+issue%22).
+3. Check [Github issues](https://github.com/cloudera/hue/issues), especially [Good First Issues](https://github.com/cloudera/hue/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
 4. Core areas: improving [SQL Components](https://docs.gethue.com/developer/components/) like Scratchpad and Parsers, [APIs](https://docs.gethue.com/developer/api/), Kubernetes service or [SQL connectors](https://docs.gethue.com/administrator/configuration/connectors/)
 
 # Submitting an improvement

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

@@ -10,6 +10,6 @@ Those are the main categories of development:
 
 * **[Develop](/developer/development)**: Ramping-up with on the Hue development service and SQL parsers
 * **[Components](/developer/components)**: Packaged library of reusable SQL parsers and SQL Editor
-* **[API](/developer/api)**: Directly interact with the API server via REST
+* **[API](/developer/api)**: Directly interact with the API server
 
-Also check on how to get started on [contribution ideas](https://github.com/cloudera/hue/blob/master/CONTRIBUTING.md).
+Also check on how to get started on [contribution](https://github.com/cloudera/hue/blob/master/CONTRIBUTING.md) ideas.

+ 7 - 7
docs/docs-site/content/developer/api/cli/_index.md

@@ -5,9 +5,13 @@ draft: false
 weight: 2
 ---
 
-A wrapper around the REST API.
+Easily leverage the Query Service via the CLI.
 
-Install:
+- Execute an SQL statement or saved query
+- List, download, upload files
+
+
+Install from https://pypi.org/project/gethue/:
 
     pip install gethue
 
@@ -23,10 +27,6 @@ And use:
     Auth: success 200
     Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjMxMjE5MDkxLCJqdGkiOiJkNGJkY2Q5M2NjMjg0MDlkYWJlYWZhNGRlNjlkOTMzMyIsInVzZXJfaWQiOjJ9.Gr8bW_JaZ8yzQ3eEZYp3jKbdsSgLAXxqvSRbeU6jhLg
 
-    > compose query
-
-  > compose query autocomplete
-
-List, view, download, upload files:
+List remote storage files:
 
     compose storage list s3a://demo-gethue