apache/kyuubi

[TASK][EASY] Kyuubi documentation improvements

Open

#5,387 opened on Oct 9, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (996 forks)batch import
hacktoberfest

Repository metrics

Stars
 (2,332 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Code of Conduct

Search before creating

  • I have searched in the task list and found no similar tasks.

Mentor

  • I have sufficient knowledge and experience of this task, and I volunteer to be the mentor of this task to guide contributors to complete the task.

Skill requirements

  • Basic knowledge of Apache Kyuubi
  • Good English tech article writing skills

Background and Goals

This is kind of an umbrella task, anyone who can improve the Kyuubi docs by sending PRs directly, for example

  • fix typos or grammar issues
  • polish the expressions or statements
  • write articles to introduce how to integrate Kyuubi with other popular projects or services
  • write articles to introduce the user case
  • ...

Implementation steps

The maintainers/committers would classify your PR into different levels based on the content of certain PRs, e.g.

"fix typos or grammar issues" is generally a TRIVIAL task.

"write articles to introduce how to integrate Kyuubi with some AWS services" could be an EASY or MEDIUM task

Additional context

Introduction of https://github.com/apache/kyuubi/issues/6232

Contributor guide