kyuubi/docs
Kent Yao 5032901dfc
[KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions
### _Why are the changes needed?_

Guidelines for Document and Code Contributions.

- code style
- documentation style
- quick starts
- sphinx-copybutton for copy button in code blocks
- add kind:minor,help wanted,good first issue to doc issue template

### _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

<img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png">

- [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4768 from yaooqinn/guide.

Closes #4768

3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst
8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst
a753bdde5 [Kent Yao] Guidelines for Document and Code contributions
f8393fe8d [Kent Yao] Guidelines for Document and Code contributions
8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions
4f3a2128b [Kent Yao] Guidelines for Document and Code contributions

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-04-27 19:58:10 +08:00
..
_static/css [KYUUBI #2764] [DOCS] Fix tables in docs being coverd by right toc sidebar 2022-05-27 17:21:42 +08:00
appendix [KYUUBI #4655] [DOCS] Enrich docs for Kyuubi Hive JDBC driver 2023-04-03 18:51:27 +08:00
client [KYUUBI #4763] [DOCS] Fix the Kyuubi JDBC kerberos parameters 2023-04-25 02:16:28 +08:00
community [KYUUBI #4593] [DOCS] Keep promote the release step update-to-date 2023-03-24 14:53:53 +08:00
connector [KYUUBI #4614] [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) in docs Connectors for Flink SQL Query Engine 2023-03-27 13:04:42 +08:00
contributing [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00
deployment [KYUUBI #1652] Support Flink yarn application mode 2023-04-07 18:51:48 +08:00
extensions [KYUUBI #4641] Add MaxFileSizeStrategy to limit max scan file size 2023-04-23 17:51:44 +08:00
imgs [KYUUBI #4371] Fix typo in kyuubi_ecosystem.drawio 2023-02-20 13:00:45 +08:00
monitor [KYUUBI #4364] Add metrics for user opened connections with session type 2023-02-18 14:52:00 +08:00
overview [KYUUBI #4624] [Docs] Fix table headers in kyuubi_vs_hive.md 2023-03-28 16:40:35 +08:00
quick_start [KYUUBI #4763] [DOCS] Fix the Kyuubi JDBC kerberos parameters 2023-04-25 02:16:28 +08:00
security [KYUUBI #4677] [AUTHZ] Check generated policy file in test suite 2023-04-13 16:08:32 +08:00
tools [KYUUBI #4568] Make kyuubi-ctl doc enable variable 'release' automatic substitution 2023-03-21 20:58:01 +08:00
conf.py [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00
index.rst [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00
make.bat [KYUUBI #4235] [DOCS] Prefer https:// URLs in docs 2023-02-03 14:01:11 +08:00
Makefile
requirements.txt [KYUUBI #4768] [INFRA] Guidelines for Document and Code contributions 2023-04-27 19:58:10 +08:00