You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@kyuubi.apache.org by GitBox <gi...@apache.org> on 2022/07/11 08:17:13 UTC

[GitHub] [incubator-kyuubi] yaooqinn opened a new issue, #3039: [Umbrella] Client side Documentation improvement

yaooqinn opened a new issue, #3039:
URL: https://github.com/apache/incubator-kyuubi/issues/3039

   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
   
   
   ### Search before asking
   
   - [X] I have searched in the [issues](https://github.com/apache/incubator-kyuubi/issues) and found no similar issues.
   
   
   ### Describe the proposal
   
   This umbrella aims to improve the client-side documentation for end-users who don't really care about the deployment of the Kyuubi server or engines.
   
   Kyuubi provides standards-based drivers for JDBC, and ODBC enabling developers to build database applications in their language of choice.
   
   In addition, APIs like REST, Thrift, etc., allow developers to access kyuubi directly and flexibly.
   
   
   User Documentation Writing Principles:
   
   - General ones http://www.cypressmedia.net/articles/article/26/six_principles_of_technical_writing
   - Using markdown or reStructuredText(recommended)
   - More about how users or developers shall use an API, feature etc, less about what it is.
   
   ### Task list
   
   - JDBC Drivers
     - Kyuubi Hive JDBC Driver
     - Hive JDBC Driver
     - MySQL Connectors
   - Command Line Interface(CLI)s
     - Kyuubi Beeline
     - Hive Beeline
   - Business Intelligence Tools and SQL IDEs
     - Apache Superset
     - Cloudera Hue
     - DataGrip
     - DBeaver
     - PowerBI
     - Tableau
     - ...
   - ODBC Drivers
   - Thrift APIs
   - RESTful APIs and Clients
     - Admin
     - SQL
     - Batch
   - Web UI
     - Kyuubi Server UI
     - Kyuubi Engine UI
       - Spark UI Extension 
   - Python DB-APIs
     - PyHive
   - Client Commons
     - Client Configuration Guide
     - Logging
     - Access Kerberized Kyuubi with Beeline & BI Tools
     - Advanced Features 
   
   ### Are you willing to submit PR?
   
   - [ ] Yes I am willing to submit a PR!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org

[GitHub] [incubator-kyuubi] yaooqinn closed issue #3039: [Umbrella] Client side Documentation improvement

Posted by GitBox <gi...@apache.org>.
yaooqinn closed issue #3039: [Umbrella] Client side Documentation improvement
URL: https://github.com/apache/incubator-kyuubi/issues/3039


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@kyuubi.apache.org
For additional commands, e-mail: notifications-help@kyuubi.apache.org