Commit Graph

5 Commits

Author SHA1 Message Date
Cheng Pan
8f59355eb6
Revert "[KYUUBI #5908] [DOCS] Remove workaround for malformed table"
This reverts commit 97a0ba461c.
2023-12-24 01:53:05 +08:00
Cheng Pan
97a0ba461c [KYUUBI #5908] [DOCS] Remove workaround for malformed table
# 🔍 Description
## Issue References 🔗

The `custom.css` was used to address the `sphinx-book-theme` bugs which generated malformed tables, see #1889 #2764 for details.

With the recent upgrading of `sphinx-book-theme 1.1.0`, it's unnecessary.

## Describe Your Solution 🔧

Remove useless `custom.css`

## 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 ⚰️

<img width="1376" alt="image" src="https://github.com/apache/kyuubi/assets/26535726/1ef116f8-6be1-49ee-8f6e-3b844eae284a">

#### Behavior With This Pull Request 🎉

<img width="1376" alt="image" src="https://github.com/apache/kyuubi/assets/26535726/b12e461b-6294-4a4e-b034-fbd093b10ca4">

#### Related Unit Tests

---

# Checklists
## 📝 Author Self Checklist

- [ ] My code follows the [style guidelines](https://kyuubi.readthedocs.io/en/master/contributing/code/style.html) of this project
- [x] I have performed a self-review
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [x] This patch was not authored or co-authored using [Generative Tooling](https://www.apache.org/legal/generative-tooling.html)

## 📝 Committer Pre-Merge Checklist

- [ ] Pull request title is okay.
- [ ] No license issues.
- [ ] Milestone correctly set?
- [ ] Test coverage is ok
- [ ] Assignees are selected.
- [ ] Minimum number of approvals
- [ ] No changes are requested

**Be nice. Be informative.**

Closes #5908 from pan3793/remove-custom-css.

Closes #5908

a958b774c [Cheng Pan] nit
a3f592645 [Cheng Pan] [DOCS] Remove workaround for malformed table

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: liangbowen <liangbowen@gf.com.cn>
2023-12-23 00:10:13 +08:00
Kent Yao
414d1a8620
[KYUUBI #2764] [DOCS] Fix tables in docs being coverd by right toc sidebar
### _Why are the changes needed?_

make table width fit browsers with 100% width, and 1st column where contains the kyuubi conf fit the table with 25% width.

### _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="1716" alt="image" src="https://user-images.githubusercontent.com/8326978/170655840-2309574e-4098-4b0f-b91d-50a30033b9ac.png">

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

Closes #2764 from yaooqinn/layout.

Closes #2764

9391a638 [Kent Yao] [DOCS] Fix tables in docs being coverd by right toc sidebar
33817406 [Kent Yao] [DOCS] Fix tables in docs being coverd by right toc sidebar

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2022-05-27 17:21:42 +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
sychen
677e2a40ab
[KYUUBI #1889] Improve the user experience of the configuration parameters of the document
### _Why are the changes needed?_
https://kyuubi.apache.org/docs/latest/deployment/settings.html
The configuration parameters in the document are too long and a newline is inserted(`<br/>`), which makes it difficult to search.
And if the user copies the configuration parameters, it may become several lines.

Use `<code>` to replace `<br/>`.

https://github.com/apache/incubator-kyuubi/issues/1889

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

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

Closes #1890 from cxzl25/KYUUBI-1889.

Closes #1889

765b0622 [sychen] format metrics.md
abeb0601 [sychen] add newline
28865ad7 [sychen] increase max width
2f9c7e05 [sychen] use <code>

Authored-by: sychen <sychen@trip.com>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
2022-02-11 09:29:50 +08:00