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

fix: enhance the code reading experience for lacking RPC generated files #353

Merged
merged 4 commits into from
Apr 13, 2024

Conversation

0x2f2f2f2f
Copy link
Contributor

@0x2f2f2f2f 0x2f2f2f2f commented Apr 7, 2024

Purpose of the PR

Improve documentation surrounding the quickstart guide. Encountered an issue where the RaftRequests file was not correctly compiled. Updated guide to provide solution through rebuilding folder via Maven rebuild

Main Changes

Updated potential issues list to include the issue of compilation not correctly generating the RPC files and included solution of rebuilding folder via Maven. Screenshot of website local build + new content located below.

Screenshot 2024-04-08 at 00 01 59

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. enhancement New feature or request labels Apr 7, 2024
Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THX, could check the content again

@imbajin imbajin changed the title initial commit fix: enhance the code reading experience for lacking RPC generated files Apr 8, 2024
0x2f2f2f2f and others added 2 commits April 7, 2024 23:42
…setup.md

Co-authored-by: imbajin <jin@apache.org>
…setup.md

Co-authored-by: imbajin <jin@apache.org>
@0x2f2f2f2f 0x2f2f2f2f requested a review from imbajin April 8, 2024 04:21
Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, sync the Chinese version later

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@0x2f2f2f2f next time u could also modify the CN doc after EN version fixed, and community could enhance it if need (more efficient)

Recommended Way:

  1. If u have GitHub Copilot, it could auto generate it (then we could use suggestion to enhance it if need~
image 2. use GPT/Bing/Google Translate, no need to worry about the accuracy, we can edit directly~

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 12, 2024
Copy link
Contributor

@javeme javeme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution

@javeme javeme merged commit e768bf2 into apache:master Apr 13, 2024
1 check passed
github-actions bot pushed a commit that referenced this pull request Apr 13, 2024
…les (#353)

Co-authored-by: JerryHu87 <56461496+JerryHu87@users.noreply.github.com>
Co-authored-by: imbajin <jin@apache.org> e768bf2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants