openraft icon indicating copy to clipboard operation
openraft copied to clipboard

Add Doc: explain send_append_entires

Open drmingdrmer opened this issue 3 years ago • 9 comments

This method is a bit complicated and needs a nice explanation.

It involves:

  • binary search for the matching log id on a follower.
  • loading log entries from non-snapshot storage API.
  • deal with lack-entry error and switch to snapshot replication.

drmingdrmer avatar Jan 18 '22 09:01 drmingdrmer

👋 Thanks for opening this issue!

Get help or engage by:

  • /help : to print help messages.
  • /assignme : to assign this issue to you.

github-actions[bot] avatar Jan 18 '22 09:01 github-actions[bot]

Hi, can I claim this assignment? I‘m studying the code, doing some output may help me check my understanding. I will try my best to finish it this week.

YangKian avatar Jan 18 '22 14:01 YangKian

Appreciating!

drmingdrmer avatar Jan 18 '22 14:01 drmingdrmer

Thanks XD

YangKian avatar Jan 18 '22 14:01 YangKian

Hi, can I claim this assignment? I‘m studying the code, doing some output may help me check my understanding. I will try my best to finish it this week.

cool,maybe we could build the doc together like wiki.

lichuang avatar Jan 18 '22 14:01 lichuang

Hi, can I claim this assignment? I‘m studying the code, doing some output may help me check my understanding. I will try my best to finish it this week.

cool,maybe we could build the doc together like wiki.

Hmm... the wiki page sometimes runs out of date with the source code.

What about the online guide, which is always sync-ed with the main branch: https://datafuselabs.github.io/openraft/

And updating the markdown in the guide/ folder would be as easy as the wiki.

drmingdrmer avatar Jan 18 '22 14:01 drmingdrmer

cool,maybe we could build the doc together like wiki.

Sounds interesting, I'd like to join.

the wiki page sometimes runs out of date with the source code.

Agreed, the online guide is more appropriate, we can update the guide directly

YangKian avatar Jan 18 '22 15:01 YangKian

Sorry I've been so busy lately :crying_cat_face: , I may need another 2 - 3 days to complete this task. Here I'd like to synchronize the progress, I've finished reading most of the relevant code and started to organize the documentation, there are still some areas that need further confirmation, and I also want to read some code of the relevant tests. I‘ll finish it as soon as possible.

YangKian avatar Jan 24 '22 01:01 YangKian

Sorry I've been so busy lately 😿 , I may need another 2 - 3 days to complete this task. Here I'd like to synchronize the progress, I've finished reading most of the relevant code and started to organize the documentation, there are still some areas that need further confirmation, and I also want to read some code of the relevant tests. I‘ll finish it as soon as possible.

That's OK man~

drmingdrmer avatar Jan 24 '22 03:01 drmingdrmer