Skip to content
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

[DOCS] Update config docs regeneratoin hints in developer guide #5409

Closed
wants to merge 1 commit into from

Conversation

bowenliang123
Copy link
Contributor

Why are the changes needed?

  • Update the regeneration hits for setting.md in develop.md, as the config docsettings.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

  • Run test locally before make a pull request

Was this patch authored or co-authored using generative AI tooling?

No.

@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Oct 12, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #5409 (985f39e) into master (fd69c6e) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5409   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files         588     588           
  Lines       33423   33423           
  Branches     4391    4391           
======================================
  Misses      33423   33423           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@bowenliang123 bowenliang123 self-assigned this Oct 12, 2023
@bowenliang123 bowenliang123 added this to the v1.8.0 milestone Oct 12, 2023
bowenliang123 added a commit that referenced this pull request Oct 12, 2023
…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]>
(cherry picked from commit 74e52f6)
Signed-off-by: Bowen Liang <[email protected]>
@bowenliang123
Copy link
Contributor Author

Thanks, merged to master(1.9.0) and branch-1.8 (1.8.0).

@bowenliang123 bowenliang123 deleted the regen-settings branch October 12, 2023 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation Documentation is a feature!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants