You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by bo...@apache.org on 2023/10/12 07:11:49 UTC
[kyuubi] branch branch-1.8 updated: [KYUUBI #5409] [DOCS] Update config docs regeneratoin hints in developer guide
This is an automated email from the ASF dual-hosted git repository.
bowenliang pushed a commit to branch branch-1.8
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/branch-1.8 by this push:
new 8d09f163e [KYUUBI #5409] [DOCS] Update config docs regeneratoin hints in developer guide
8d09f163e is described below
commit 8d09f163ee1fc34a364908e07d97e11b335ea965
Author: Bowen Liang <li...@gf.com.cn>
AuthorDate: Thu Oct 12 15:11:18 2023 +0800
[KYUUBI #5409] [DOCS] Update config docs regeneratoin hints in developer guide
### _Why are the changes needed?_
- Update the regeneration hits for `setting.md` in `develop.md`, as the config doc`settings.md` is checked and able to regenearted by `dev/gen/gen_all_config_docs.sh` script.
### _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/contributing/code/testing.html#running-tests) locally before make a pull request
### _Was this patch authored or co-authored using generative AI tooling?_
No.
Closes #5409 from bowenliang123/regen-settings.
Closes #5409
985f39e51 [Bowen Liang] update docs
Authored-by: Bowen Liang <li...@gf.com.cn>
Signed-off-by: Bowen Liang <li...@gf.com.cn>
(cherry picked from commit 74e52f6924b8bd6a106925673c215383c0d50cf7)
Signed-off-by: Bowen Liang <li...@gf.com.cn>
---
docs/contributing/code/developer.md | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/contributing/code/developer.md b/docs/contributing/code/developer.md
index ef6fb7988..518d71871 100644
--- a/docs/contributing/code/developer.md
+++ b/docs/contributing/code/developer.md
@@ -46,8 +46,7 @@ You can run `dev/reformat` to format all Java and Scala code.
Kyuubi uses settings.md to explain available configurations.
-You can run `KYUUBI_UPDATE=1 build/mvn clean test -pl kyuubi-server -am -Pflink-provided,spark-provided,hive-provided -DwildcardSuites=org.apache.kyuubi.config.AllKyuubiConfiguration`
-to append descriptions of new configurations to settings.md.
+You can run `dev/gen/gen_all_config_docs.sh` to append and update descriptions of new configurations to `settings.md`.
## Generative Tooling Usage