Commit Graph

15 Commits

Author SHA1 Message Date
Kent Yao
d516a5d360 [KYUUBI #6068] Remove community section from user docs
# 🔍 Description
## Issue References 🔗

## Describe Your Solution 🔧

The content of the community section is a bylaw, which is settled on the website.

This PR removes it and moves the release guide into the contributing fold for the moment.

The release guide is also bylaw which is suite better in website repo.

## Types of changes 🔖

- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Test Plan 🧪

#### Behavior Without This Pull Request ⚰️

#### Behavior With This Pull Request 🎉

#### Related Unit Tests

---

# Checklist 📝

- [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

**Be nice. Be informative.**

Closes #6068 from yaooqinn/community.

Closes #6068

8e18da63f [Kent Yao] Remove community section from user docs

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2024-02-21 05:20:42 +00:00
jarvis
e644cd986c
[KYUUBI #5146] [DOC] Fix link of IntelliJ IDEA Setup Guide
### _Why are the changes needed?_

update error link

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

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

Closes #5146 from liunaijie/master.

Closes #5146

9d07aa753 [jarvis] [Doc] update link

Authored-by: jarvis <liunaijie1996@163.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-08-09 16:39:44 +08:00
liangbowen
22e9fd7d68 [KYUUBI #4226] Fix word spelling typos in docs
### _Why are the changes needed?_

- fix word spelling typos in docs

### _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.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4226 from bowenliang123/doc-word-typo.

Closes #4226

393de90d [liangbowen] update
365cdc4b [liangbowen] fix word typos in docs

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-02-02 11:43:03 +08:00
liangbowen
69d625a1be [KYUUBI #4200] [Improvement] [Docs] Introduce Markdown formatting with spotless-maven-plugin and flexmark for docs
### _Why are the changes needed?_

- to consolidate styles in markdown files from manual written or auto-generated
- apply markdown formatting rules with flexmark from [spotless-maven-plugin](https://github.com/diffplug/spotless/tree/main/plugin-maven#markdown) to *.md files in `/docs`
- use `flexmark` to format markdown generation in `TestUtils` of common module used by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, as the same way in `FlexmarkFormatterFunc ` of `spotless-maven-plugin` using with `COMMONMARK` as `FORMATTER_EMULATION_PROFILE` (https://github.com/diffplug/spotless/blob/maven/2.30.0/lib/src/flexmark/java/com/diffplug/spotless/glue/markdown/FlexmarkFormatterFunc.java)
- using `flexmark` of` 0.62.2`, as the last version requiring Java 8+ (checked from pom file and bytecode version)

```
<markdown>
    <includes>
        <include>docs/**/*.md</include>
    </includes>
    <flexmark></flexmark>
</markdown>
```

- Changes applied to markdown doc files,
  -  no style change or breakings in built docs by `make html`
  - removal all the first blank in licences and comments to conform markdown style rules
  - tables regenerated by flexmark following as in [GitHub Flavored Markdown](https://help.github.com/articles/organizing-information-with-tables/) (https://github.com/vsch/flexmark-java/wiki/Extensions#tables)

### _How was this patch tested?_
- [x] regenerate docs using `make html` successfully and check all the markdown pages available
- [x] regenerate `settings.md` and `functions.md` by `AllKyuubiConfiguration` and `KyuubiDefinedFunctionSuite`, and pass the checks by both themselves and spotless check via `dev/reformat`
- [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4200 from bowenliang123/markdown-formatting.

Closes #4200

1eeafce4 [liangbowen] revert minor changes in AllKyuubiConfiguration
4f892857 [liangbowen] use flexmark in markdown doc generation
8c978abd [liangbowen] changes on markdown files
a9190556 [liangbowen] apply markdown formatting rules with `spotless-maven-plugin` to markdown files with in `/docs`

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-01-30 11:14:41 +08:00
Ruguo Yu
87582a7458
[KYUUBI #4165] [DOCS] Update the docs link
### _Why are the changes needed?_
Some links of the website are not available.

### _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 #4165 from yuruguo/update_doc-url.

Closes #4165

f7a847c3 [Ruguo Yu] [DOCS] Update the docs link

Authored-by: Ruguo Yu <jiang7chengzitc@163.com>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2023-01-16 10:52:01 +08:00
runzhliu
3f8189994b [KYUUBI #4142][DOCS] Update the docs link in README
### _Why are the changes needed?_

Some links of the website are not available.

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

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4146 from runzhliu/dev.

Closes #4142

fb44ba18f [runzhliu] Update docs

Authored-by: runzhliu <runzhliu@163.com>
Signed-off-by: Fu Chen <cfmcgrady@gmail.com>
2023-01-12 10:14:20 +08:00
Tianlin Liao
8e8d8be8d2
[KYUUBI #4020] remove incubating from kyuubi source code
### _Why are the changes needed?_

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

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #4069 from lightning-L/kyuubi-4020.

Closes #4020

97406ca0 [Tianlin Liao] [KYUUBI #4020] remove incubating from kyuubi source code

Authored-by: Tianlin Liao <tiliao@ebay.com>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2023-01-04 09:43:20 +08:00
Nietzsche_w
8a7ab57204
[KYUUBI #3266] Update CONTRIBUTE.md
### _Why are the changes needed?_

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

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3266 from wuqiao/master.

Closes #3266

0c23e73c [Nietzsche_w] Update README.md
7d7f2b01 [Nietzsche_w] Update CONTRIBUTING.md
b0d9f7f1 [Nietzsche_w] Update README.md

Authored-by: Nietzsche_w <wuqiaocauc@163.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-08-18 17:48:01 +08:00
Kent Yao
e1921fc8c0
[KYUUBI #2751] [DOC] Replace sphinx_rtd_theme with sphinx_book_theme
### _Why are the changes needed?_

make documentation style to fit official web site

### _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
![image](https://user-images.githubusercontent.com/8326978/170434595-d5ec5068-ab2d-484e-9371-9331311cc0f1.png)
- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2751 from yaooqinn/doc2.

Closes #2751

b8123525 [Kent Yao] Switch

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-05-27 02:22:36 +08:00
gabry.wu
03d4bbe95e [KYUUBI #2512] Fix broken link of IntelliJ IDEA Setup Guide
### _Why are the changes needed?_
close https://github.com/apache/incubator-kyuubi/issues/2511
fix link of IntelliJ IDEA Setup Guide

### _How was this patch tested?_
- [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] 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 #2512 from gabrywu/kyuubi2511.

Closes #2512

d653d8f2 [gabry.wu] remove unnecessary changes
d6f5c8d7 [gabrywu] fix link of IntelliJ IDEA Setup Guide

Lead-authored-by: gabry.wu <gabrywu@apache.org>
Co-authored-by: gabrywu <gabrywu@apache.org>
Signed-off-by: Fei Wang <fwang12@ebay.com>
2022-04-29 13:00:00 +08:00
Ada Wong
2225b9a175
[KYUUBI #2143] [KYUBBI #2142][DOCS] Add IDEA setup guide
### _Why are the changes needed?_

Add IDEA setup guide for developers.

### _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 #2143 from deadwind4/KYUUBI-2142.

Closes #2143

f0450c05 [Ada Wong] Update formatter for Java
be77cfe5 [Ada Wong] [KYUBBI #2142][DOCS] Add IDEA setup guide

Authored-by: Ada Wong <rsl4@foxmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-03-16 14:43:21 +08:00
ulysses-you
95a4974ee6
[KYUUBI #1563] Fix broken link and add new link in CONTRIBUTION.md
### _Why are the changes needed?_

closes https://github.com/apache/incubator-kyuubi/issues/1563

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

- [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #2076 from ulysses-you/KYUUBI-1563.

Closes #1563

8a464f2f [ulysses] Update CONTRIBUTING.md
798913a1 [ulysses-you] sync

Lead-authored-by: ulysses-you <ulyssesyou18@gmail.com>
Co-authored-by: ulysses <ulyssesyou18@gmail.com>
Signed-off-by: Kent Yao <yao@apache.org>
2022-03-09 19:10:30 +08:00
Kent Yao
114fefefa6
[KYUUBI #2004] Sync contents for CONTRIBUTING & COMMUNITY between web and main repo
<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->

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

ddbcd521 [Kent Yao] CONTRIBUTING
f81c14b3 [Kent Yao] Merge branch 'master' of github.com:apache/incubator-kyuubi into CONTRIBUTING
3bdbdc9b [Kent Yao] CONTRIBUTING
574ceff2 [Kent Yao] CONTRIBUTING
f0a6b4c4 [Kent Yao] CONTRIBUTING
c55c6a02 [Kent Yao] CONTRIBUTING

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2022-03-03 20:40:33 +08:00
Kent Yao
c6bf6ebf9e
PR ISSUE and Contribution Guide (#287) 2021-01-14 20:28:30 +08:00
Kent Yao
82839fcb5f
Create CONTRIBUTING.md 2018-03-07 15:51:46 +08:00