Skip to content

Commit

Permalink
[KYUUBI #5409] [DOCS] Update config docs regeneratoin hints in develo…
Browse files Browse the repository at this point in the history
…per 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

985f39e [Bowen Liang] update docs

Authored-by: Bowen Liang <[email protected]>
Signed-off-by: Bowen Liang <[email protected]>
  • Loading branch information
bowenliang123 committed Oct 12, 2023
1 parent fd69c6e commit 74e52f6
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/contributing/code/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 74e52f6

Please sign in to comment.