-
Notifications
You must be signed in to change notification settings - Fork 980
Use "(none)" placeholder for default value of un-preset configs on confing doc page #5916
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5916 +/- ##
============================================
- Coverage 61.57% 61.54% -0.03%
Complexity 23 23
============================================
Files 616 616
Lines 36386 36386
Branches 4978 4978
============================================
- Hits 22404 22395 -9
- Misses 11570 11572 +2
- Partials 2412 2419 +7 ☔ View full report in Codecov by Sentry. |
Could this be an unnotified breaking change, for example, the return value from retrieving an unset configuration? BTW, (none) is only manually used on Spark's doc side. For its code side, it uses FYI, apache/spark#19974 |
|
BTW, it seems that |
Let me think again. And if you have worries on this PR, feel free to revert it any time. |
|
If it's only related to doc change, I guess we can either optimize the CSS style or map to (none) in the test scope for doc generation. Let's revert it first as it might contain unexpected behaviors |
# 🔍 Description ## Issue References 🔗 This pull request fixes #5916 as a revert ## Describe Your Solution 🔧 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. ## Types of changes 🔖 - [x] 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 --- # Checklists ## 📝 Author Self Checklist - [x] 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 - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] 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 - [x] Pull request title is okay. - [x] No license issues. - [x] Milestone correctly set? - [x] Test coverage is ok - [x] Assignees are selected. - [x] Minimum number of approvals - [x] No changes are requested **Be nice. Be informative.** Closes #5928 from yaooqinn/revert. Closes #5916 5c43c02 [Kent Yao] [KYUUBI #5916] Revert #5916 Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
…-preset configs on confing doc page
# 🔍 Description
## Issue References 🔗
As descirbed.
## Describe Your Solution 🔧
- Replace the placeholder for default value of un-preset configs on doc page, changed from `<undefined>` to `(none)`
- The `(none)` placeholder style is also used in the docs of
- Spark : https://spark.apache.org/docs/latest/configuration.html
- Flink : https://nightlies.apache.org/flink/flink-docs-master/docs/deployment/config/
- Trino (as `NONE`): https://trino.io/docs/current/admin/properties.html
- Only affects the config doc page, no functional changes.
## 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 ⚰️
No functional changes.
Config doc page:

#### Behavior With This Pull Request 🎉
No functional changes.
Config doc page:

#### Related Unit Tests
---
# Checklists
## 📝 Author Self Checklist
- [x] 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
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] 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
- [x] 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 apache#5916 from bowenliang123/none-ph.
Closes apache#5916
3b141dd [Bowen Liang] update test
04cf8cd [Bowen Liang] Use "(none)" placeholder for default value of unset configs on config page
Authored-by: Bowen Liang <liangbowen@gf.com.cn>
Signed-off-by: Bowen Liang <liangbowen@gf.com.cn>
# 🔍 Description ## Issue References 🔗 This pull request fixes apache#5916 as a revert ## Describe Your Solution 🔧 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. ## Types of changes 🔖 - [x] 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 --- # Checklists ## 📝 Author Self Checklist - [x] 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 - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] 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 - [x] Pull request title is okay. - [x] No license issues. - [x] Milestone correctly set? - [x] Test coverage is ok - [x] Assignees are selected. - [x] Minimum number of approvals - [x] No changes are requested **Be nice. Be informative.** Closes apache#5928 from yaooqinn/revert. Closes apache#5916 5c43c02 [Kent Yao] [KYUUBI apache#5916] Revert apache#5916 Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
🔍 Description
Issue References 🔗
As descirbed.
Describe Your Solution 🔧
<undefined>to(none)(none)placeholder style is also used in the docs ofNONE): https://trino.io/docs/current/admin/properties.htmlTypes of changes 🔖
Test Plan 🧪
Behavior Without This Pull Request ⚰️
No functional changes.
Config doc page:

Behavior With This Pull Request 🎉
No functional changes.
Config doc page:

Related Unit Tests
Checklists
📝 Author Self Checklist
📝 Committer Pre-Merge Checklist
Be nice. Be informative.