[KYUUBI #2004] Sync contents for CONTRIBUTING & COMMUNITY between web and main repo

yaooqinn · ulysses-you · commit 114fefefa6dd · 2022-03-03T20:40:33.000+08:00
### _Why are the changes needed?_  Add CONTRIBUTING.md to list COMMUNITY resources that I contributor can use delete contributions and improvement-proposal in main repo ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #2004 from yaooqinn/CONTRIBUTING. Closes #2004 ddbcd52 [Kent Yao] CONTRIBUTING f81c14b [Kent Yao] Merge branch 'master' of github.com:apache/incubator-kyuubi into CONTRIBUTING 3bdbdc9 [Kent Yao] CONTRIBUTING 574ceff [Kent Yao] CONTRIBUTING f0a6b4c [Kent Yao] CONTRIBUTING c55c6a0 [Kent Yao] CONTRIBUTING Authored-by: Kent Yao <yao@apache.org> Signed-off-by: ulysses-you <ulyssesyou@apache.org>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,62 @@
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Contributing to Apache Kyuubi
+
+<img src="https://svn.apache.org/repos/asf/comdev/project-logos/originals/kyuubi-1.svg" alt="Kyuubi logo" width="50%" align="right" />
+
+Thanks for your interest in the Apache Kyuubi project.
+Contributions are welcome and are greatly appreciated!
+Every little bit helps, and a credit will always be given.
+
+This page provides some orientation and resources we have for you to get involved.
+It also offers recommendations on getting the best results when engaging with the community.
+We hope that this will be a pleasant first experience for you to return to continue contributing.
+
+## Get Involved
+
+In the process of using Apache Kyuubi, if you have any questions, suggestions, or improvement ideas, you can participate in the Kyuubi community building through the following suggested channels.
+
+- Join the [Mailing Lists](https://kyuubi.apache.org/mailing_lists.html) - the best way to keep up-to-date with the community.
+- [Issue Tracker](https://kyuubi.apache.org/issue_tracking.html) - tracking bugs, ideas, plans, etc.
+- [Github Discussions](https://github.com/apache/incubator-kyuubi/discussions) - second to mailing list for anything else you want to share or ask
+
+## Contributing Guide
+
+As a community-driven project. All bits of help are welcome.
+
+Contributing code is excellent, but that’s probably not the first place to start.
+There are many ways to make valuable contributions to the project and community.
+
+You can make various types of contributions to Kyuubi, including the following but not limited to,
+
+- Answer questions in the  [Mailing Lists](https://kyuubi.apache.org/mailing_lists.html)
+- [Share your success stories with us](https://github.com/apache/incubator-kyuubi/discussions/925) 
+- Improve Documentation - [![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.apache.org/docs/latest/)
+- Test latest releases - [![Latest tag](https://img.shields.io/github/v/tag/apache/incubator-kyuubi?label=tag)](https://github.com/apache/incubator-kyuubi/tags)
+- Improve test coverage - [![codecov](https://codecov.io/gh/apache/incubator-kyuubi/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/incubator-kyuubi)
+- Report bugs and better help developers to reproduce
+- Review changes
+- Make a pull request
+- Promote to others
+- Click the star button if you like this project
+
+Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.apache.org/contributing.html) first.
+
+## Easter Eggs for Contributors
+
+TBD, please be patient for the surprise.
diff --git a/MATURITY.md b/MATURITY.md
@@ -33,7 +33,7 @@ Mentors and community members are encouraged to contribute to this page and comm
 | ID  | Description                                                                                                                                                                                                                                                     | Status                                                                                                                                                                                                                                                                                                                                                                                              |
 |-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | C10 | The project produces Open Source software for distribution to the public, at no charge.                                                                                                                                                                         | :white_check_mark: The project source code is licensed under the [Apache License, v2.0](https://github.com/apache/incubator-kyuubi/blob/master/LICENSE)                                                                                                                                                                                                                                             |
-| C20 | Anyone can easily discover and access the project's code.                                                                                                                                                                                                       | :x: The source code is available on GitHub directly, :bangbang: Missing link on website                                                                                                                                                                                                                                                                                                             |
+| C20 | Anyone can easily discover and access the project's code.                                                                                                                                                                                                       | :white_check_mark: The source code is available on GitHub directly, linked on website                                                                                                                                                                                                                                                                                                               |
 | C30 | Anyone using standard, widely-available tools, can build the code in a reproducible way.                                                                                                                                                                        | :x: The source code is automatically built for each Pull Request commit, with license checks, style checks, doc builds, unit and end to end tests, via GitHub actions and Travis. Development environment setup and build instructions to do the same locally are documented on the [website](https://kyuubi.apache.org/developer-tools.html). :bangbang: The site is not synced with the codebase. |
 | C40 | The full history of the project's code is available via a source code control system, in a way that allows anyone to recreate any released version.                                                                                                             | :white_check_mark: The project uses git to manage source code, documentation and website, all releases are tagged. The commit history is available from the beginning of the project.                                                                                                                                                                                                               |
 | C50 | The source code control system establishes the provenance of each line of code in a reliable way, based on strong authentication of the committer. When third parties contribute code, commit messages provide reliable information about the code provenance.  | :white_check_mark: The project uses GitHub repository managed by Apache Infra, it ensuring the provenance of each line of code to a committer. All code is checked in after review and approval via GitHub pull requests.                                                                                                                                                                           |
diff --git a/README.md b/README.md
@@ -105,21 +105,7 @@ For 1.2 and earlier versions, please check the [Readthedocs](https://kyuubi.read
 
 Ready? [Getting Started](https://kyuubi.apache.org/docs/latest/quick_start/quick_start.html) with Kyuubi.
 
-## Contributing
-
-All bits of help are welcome. You can make various types of contributions to Kyuubi, including the following but not limited to,
-
-- Help new users in chat channel or share your success stories with us - [![Gitter](https://badges.gitter.im/kyuubi-on-spark/Lobby.svg)](https://gitter.im/kyuubi-on-spark/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-- Improve Documentation - [![Documentation Status](https://readthedocs.org/projects/kyuubi/badge/?version=latest)](https://kyuubi.apache.org/docs/latest/)
-- Test releases - [![Latest tag](https://img.shields.io/github/v/tag/apache/incubator-kyuubi?label=tag)](https://github.com/apache/incubator-kyuubi/tags)
-- Improve test coverage - [![codecov](https://codecov.io/gh/apache/incubator-kyuubi/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/incubator-kyuubi)
-- Report bugs and better help developers to reproduce
-- Review changes
-- Make a pull request
-- Promote to others
-- Click the star button if you like this project
-
-Before you start, we recommend that you check the [Contribution Guidelines](https://kyuubi.apache.org/docs/latest/community/contributions.html) first.
+## [Contributing](./CONTRIBUTING.md)
 
 ## Aside
 
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -18,5 +18,5 @@
 @import url("theme.css");
 
 .wy-nav-content {
-    max-width: 90%;
+    max-width: 100%;
 }
diff --git a/docs/community/CONTRIBUTING.md b/docs/community/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
diff --git a/docs/community/contributions.md b/docs/community/contributions.md
diff --git a/docs/community/improvement-proposals.md b/docs/community/improvement-proposals.md
diff --git a/docs/community/index.rst b/docs/community/index.rst
@@ -24,8 +24,7 @@ Community
     :numbered: 4
     :glob:
 
+    CONTRIBUTING
     collaborators
-    contributions
-    improvement-proposals
     release
 

Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,5 @@`
`18`	`18`	`@import url("theme.css");`
`19`	`19`
`20`	`20`	`.wy-nav-content {`
`21`		`- max-width: 90%;`
	`21`	`+ max-width: 100%;`
`22`	`22`	`}`