kyuubi icon indicating copy to clipboard operation
kyuubi copied to clipboard

[Umbrella] Client side Documentation improvement

Open yaooqinn opened this issue 3 years ago • 0 comments

Code of Conduct

Search before asking

  • [X] I have searched in the 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

    • Authentication
      • SPNEGO
      • BASIC
    • Admin
    • SQL
    • Batch
      • batch API #3076
      • batch sdk
      • batch command line(kyuubi-ctl batch part) #3387
  • 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
      • Using Different Kyuubi Engines
      • Sharing and Isolation for Kyuubi Engines
      • Setting Time to Live for Kyuubi Engines
      • Enabling Kyuubi Engine Pool
      • Running Scala Snippets
      • Plan Only Execution Mode
  • a #3387

  • #3040

Are you willing to submit PR?

  • [ ] Yes I am willing to submit a PR!

yaooqinn avatar Jul 11 '22 08:07 yaooqinn