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

Update, rework, and extend docs #35

Merged
merged 8 commits into from
Nov 27, 2023
Merged

Update, rework, and extend docs #35

merged 8 commits into from
Nov 27, 2023

Conversation

timebertt
Copy link
Owner

This is the last PR in the 5-part series for implementing the new external sharding approach (ref #31).

This PR tackles:

  • immense rework and extension of docs
    • there is now a lot of documentation about getting started with the project, implementing sharding in your own controller, understanding the design, etc.
    • update the architecture diagram for the external sharding implementation
  • cmd/shard is now the reference implementation for a shard
    • its components have been made reusable in pkg/shard to give controllers based on controller-runtime a head-start for implementing sharding

With this PR, the project is ready to be announced publicly. 🎉
The docs should now explain the project's purpose much better and how folks can start using sharding in their own controllers.

@timebertt timebertt merged commit b00eb19 into main Nov 27, 2023
7 checks passed
@timebertt timebertt deleted the docs branch November 27, 2023 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant