search

tikv / sig-transaction

Resources for the transaction SIG
62 stars 13 forks source link

Documenting MVCC #74

Closed pramodbiligiri closed 3 years ago

pramodbiligiri commented 3 years ago

I went through the list of TODOs in docs/tikv/README.md, and decided to write a couple of paras about the MVCC item there. Can someone review this and give feedback? Thanks.

Tagging @nrc for visibility.

nrc commented 3 years ago

Checks are failing because the commits are not signed and you haven't completed the DCO process. See https://github.com/probot/dco#how-it-works for more info.

nrc commented 3 years ago

@pramodbiligiri this is ready to merge once you fix the DCO issues

pramodbiligiri commented 3 years ago

Thanks @nrc. I've added the sign off message to the commits. The checks are now passing.

nrc commented 3 years ago

Awesome! Thank you for your PR!

nrc commented 3 years ago

@pramodbiligiri do you have an idea on what you'd like to look at next, or would you like some help to find something?

pramodbiligiri commented 3 years ago

@nrc: Regarding the next items: As I was browsing tikv and client-rust, I felt that there were some types in there that can do with more documentation in tikv/components/txn_types and tikv/storage/txn folders. But if you're expecting more people to dive into the codebase, I think module level documentation should be higher priority. The class level stuff can be figured out by reading a file, but more docs on how the pieces fit together would be useful.

So I'm thinking of running a cargo doc on those projects, looking at the output and identifying any module level docs that can be added or enhanced. What do you think?

nrc commented 3 years ago

I think it sounds like a good idea! If you want to browse the rendered docs, TiKV is here: https://tikv.github.io/doc/tikv/index.html and the Rust client is here: https://www.tikv.dev/doc/rust-client/tikv_client/ (they should both be up to date, let me know if not).