You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by bo...@apache.org on 2023/02/13 05:15:30 UTC
[kyuubi] branch master updated: [KYUUBI #4308] [DOCS] Make README more welcoming
This is an automated email from the ASF dual-hosted git repository.
bowenliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 3b0137ae7 [KYUUBI #4308] [DOCS] Make README more welcoming
3b0137ae7 is described below
commit 3b0137ae7840458cfed10e65de9a6841d8e26197
Author: liangbowen <li...@gf.com.cn>
AuthorDate: Mon Feb 13 13:15:18 2023 +0800
[KYUUBI #4308] [DOCS] Make README more welcoming
### _Why are the changes needed?_
- Make Readme more welcoming to readers, in
- Elegancy: clear, center aligned Kyuubi logo in front
- Maturity: always good to see numbers of contributors, lines and PRs
- Guidance: quick starting point to project homepage and documentation for next steps
- Sociability: showing star number of the project
Preview link: https://github.com/bowenliang123/incubator-kyuubi/blob/readme-welcome/README.md
Before:
<img width="917" alt="image" src="https://user-images.githubusercontent.com/1935105/218124450-1cb099bb-87fb-41ad-8048-0a8c4653c754.png">
After:
<img width="913" alt="image" src="https://user-images.githubusercontent.com/1935105/218263680-8237f838-b0b9-42c4-b814-b909651aaef2.png">
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
- [x] Add screenshots for manual tests if appropriate
- [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request
Closes #4308 from bowenliang123/readme-welcome.
Closes #4308
35fafffb [Bowen Liang] add links for badges
55721d17 [liangbowen] remove licence badge and add total lines badge
42971575 [Bowen Liang] Update README.md
5909b1d6 [liangbowen] make Readme more welcoming
Lead-authored-by: liangbowen <li...@gf.com.cn>
Co-authored-by: Bowen Liang <li...@gf.com.cn>
Signed-off-by: liangbowen <li...@gf.com.cn>
---
README.md | 48 ++++++++++++++++++++++++++++++++----------------
1 file changed, 32 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index 16fc794ee..0b46abf85 100644
--- a/README.md
+++ b/README.md
@@ -15,27 +15,43 @@
- limitations under the License.
-->
-# Apache Kyuubi
-
-<img src="https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg" alt="Kyuubi logo" height="120px" align="right" />
+<p align="center">
+ <img src="https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg" alt="Kyuubi logo" height="120px"/>
+</p>
+
+<p align="center">
+ <a href="https://kyuubi.apache.org/releases.html">
+ <img src="https://img.shields.io/github/v/release/apache/kyuubi" />
+ </a>
+ <a href="https://github.com/apache/kyuubi/pulls">
+ <img src="https://img.shields.io/github/issues-pr-closed/apache/kyuubi" />
+ </a>
+ <a href="https://github.com/apache/kyuubi/pulse">
+ <img src="https://img.shields.io/tokei/lines/github/apache/kyuubi" />
+ </a>
+ <a href="https://github.com/apache/kyuubi/graphs/contributors">
+ <img src="https://img.shields.io/github/contributors/apache/kyuubi" />
+ </a>
+ <a class="github-button" href="https://github.com/apache/kyuubi" data-icon="octicon-star" aria-label="Star apache/kyuubi on GitHub">
+ <img src="https://img.shields.io/github/stars/apache/kyuubi?style=social" />
+ </a>
+</p>
+<p align="center">
+ <a href="https://kyuubi.apache.org/">Project</a>
+ -
+ <a href="https://kyuubi.readthedocs.io/">Documentation</a>
+ -
+ <a href="https://kyuubi.apache.org/powered_by.html">Who's using</a>
+</p>
-[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
-[![Release](https://img.shields.io/github/v/release/apache/kyuubi?label=release)](https://github.com/apache/kyuubi/releases)
-[![](https://tokei.rs/b1/github.com/apache/kyuubi)](https://github.com/apache/kyuubi)
-[![codecov](https://codecov.io/gh/apache/kyuubi/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/kyuubi)
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/apache/kyuubi/Kyuubi/master?style=plastic)
-[![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.readthedocs.io/en/master/)
-![GitHub top language](https://img.shields.io/github/languages/top/apache/kyuubi)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/apache/kyuubi)](https://github.com/apache/kyuubi/graphs/commit-activity)
-[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/apache/kyuubi.svg)](http://isitmaintained.com/project/apache/kyuubi "Average time to resolve an issue")
-[![Percentage of issues still open](http://isitmaintained.com/badge/open/apache/kyuubi.svg)](http://isitmaintained.com/project/apache/kyuubi "Percentage of issues still open")
+# Apache Kyuubi
+Apache Kyuubi™ is a distributed and multi-tenant gateway to provide serverless
+SQL on data warehouses and lakehouses.
+<https://kyuubi.apache.org/>
## What is Kyuubi?
-Apache Kyuubi™ is a distributed and multi-tenant gateway to provide serverless
-SQL on data warehouses and lakehouses.
-
Kyuubi provides a pure SQL gateway through Thrift JDBC/ODBC interface for end-users to manipulate large-scale data with pre-programmed and extensible Spark SQL engines. This "out-of-the-box" model minimizes the barriers and costs for end-users to use Spark at the client side. At the server-side, Kyuubi server and engines' multi-tenant architecture provides the administrators a way to achieve computing resource isolation, data security, high availability, high client concurrency, etc.
![](./docs/imgs/kyuubi_positioning.png)