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

Dev Guide for Cluster Sharding/Migration #364

Merged
merged 15 commits into from
May 22, 2024

Conversation

vazois
Copy link
Contributor

@vazois vazois commented May 7, 2024

Developer guide webpage containing information about sharding and migration.

@PaulusParssinen
Copy link
Contributor

👍 Great to have more docs! It's gonna be tought to keep the quoted code snippets in sync though?

Copy link
Contributor

@lmaas lmaas left a 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.

website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
Copy link
Contributor

@lmaas lmaas left a 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).

website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
website/docs/dev/cluster/migration.md Outdated Show resolved Hide resolved
@vazois
Copy link
Contributor Author

vazois commented May 8, 2024

👍 Great to have more docs! It's gonna be tought to keep the quoted code snippets in sync though?

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.

@vazois vazois force-pushed the vazois/dev-cluster branch 3 times, most recently from 6ccdd8e to 94e031d Compare May 14, 2024 02:56
@vazois vazois requested a review from lmaas May 14, 2024 03:13
@vazois
Copy link
Contributor Author

vazois commented May 14, 2024

I updated the website to add a reference to github permalink. This way the dev guide is more resilient to code changes.

@TalZaccai TalZaccai merged commit dcac12e into microsoft:main May 22, 2024
8 checks passed
@vazois vazois deleted the vazois/dev-cluster branch June 4, 2024 19:00
@vazois vazois restored the vazois/dev-cluster branch June 4, 2024 19:00
chyin6 pushed a commit to jusjin-org/garnet that referenced this pull request Jul 2, 2024
* added separate sidebar section for cluster dev guide

* completed sharding section of dev guide

* first iteration of dev guide slot migration

* complete migration dev guide

* addressing comments

* nit

* misc cleanup

* some rewriting and cleanup

* another pass for sharding

* cleanup overview.md in cluste dev guide

* add code snippet reference to github code

* add yarn lock

---------

Co-authored-by: Tal Zaccai <[email protected]>
Co-authored-by: Lukas Maas <[email protected]>
@github-actions github-actions bot locked and limited conversation to collaborators Aug 5, 2024
@vazois vazois deleted the vazois/dev-cluster branch September 17, 2024 17:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants