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
Dev Guide for Cluster Sharding/Migration #364
Conversation
👍 Great to have more docs! It's gonna be tought to keep the quoted code snippets in sync though? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content of the new documentation looks good to me.
I made some small suggestions below. I think we should run a spell-checker on the files before we check them in.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a few more suggestions below. I think it'd be good to make sure the markdown files render correctly before checking in any changes (there were quite a few mismatched markdown tags).
Good point. I would argue that some fundamental parts of the code base will not change as frequently as others. That being said, we can probably add some pseudocode where needed instead of actual code. We might need to go through the other sections of the dev guide to make sure this convention is followed. |
6ccdd8e
to
94e031d
Compare
I updated the website to add a reference to github permalink. This way the dev guide is more resilient to code changes. |
796f04b
to
533f877
Compare
533f877
to
9ba9306
Compare
Developer guide webpage containing information about sharding and migration.