maokaihe/mini_lsm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: s/tutorial/course

Browse Source 
Signed-off-by: Alex Chi Z <iskyzh@gmail.com>
This commit is contained in:
Alex Chi Z
2025-01-19 19:28:04 -05:00
parent 7f4b204064
commit 38c7ef6f2f
32 changed files with 67 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -6,9 +6,9 @@
Build a simple key-value storage engine in a week! And extend your LSM engine on the second + third week.
## [Tutorial](https://skyzh.github.io/mini-lsm)
## [Book](https://skyzh.github.io/mini-lsm)
The Mini-LSM book is available at [https://skyzh.github.io/mini-lsm](https://skyzh.github.io/mini-lsm). You may follow this guide and implement the Mini-LSM storage engine. We have 3 weeks (parts) of the tutorial, each of them consists of 7 days (chapters).
The Mini-LSM book is available at [https://skyzh.github.io/mini-lsm](https://skyzh.github.io/mini-lsm). You may follow this guide and implement the Mini-LSM storage engine. We have 3 weeks (parts) of the course, each of them consists of 7 days (chapters).
## Community
@@ -18,7 +18,7 @@ You may join skyzh's Discord server and study with the mini-lsm community.
**Add Your Solution**
If you finished at least one full week of this tutorial, you can add your solution to the community solution list at [SOLUTIONS.md](./SOLUTIONS.md). You can submit a pull request and we might do a quick review of your code in return of your hard work.
If you finished at least one full week of this course, you can add your solution to the community solution list at [SOLUTIONS.md](./SOLUTIONS.md). You can submit a pull request and we might do a quick review of your code in return of your hard work.
## Development
@@ -52,9 +52,9 @@ To do this, use `cargo x sync`.
* mini-lsm: the final solution code for <= week 2
* mini-lsm-mvcc: the final solution code for week 3 MVCC
* mini-lsm-starter: the starter code
* mini-lsm-book: the tutorial
* mini-lsm-book: the course
We have another repo mini-lsm-solution-checkpoint at [https://github.com/skyzh/mini-lsm-solution-checkpoint](https://github.com/skyzh/mini-lsm-solution-checkpoint). In this repo, each commit corresponds to a chapter in the tutorial. We will not update the solution checkpoint very often.
We have another repo mini-lsm-solution-checkpoint at [https://github.com/skyzh/mini-lsm-solution-checkpoint](https://github.com/skyzh/mini-lsm-solution-checkpoint). In this repo, each commit corresponds to a chapter in the course. We will not update the solution checkpoint very often.
## Demo
@@ -72,16 +72,16 @@ cargo run --bin compaction-simulator-ref
cargo run --bin compaction-simulator-mvcc-ref
```
## Tutorial Structure
## Course Structure
We have 3 weeks + 1 extra week (in progress) for this tutorial.
We have 3 weeks + 1 extra week (in progress) for this course.
* Week 1: Storage Format + Engine Skeleton
* Week 2: Compaction and Persistence
* Week 3: Multi-Version Concurrency Control
* The Extra Week / Rest of Your Life: Optimizations (unlikely to be available in 2025...)
![Tutorial Roadmap](./mini-lsm-book/src/lsm-tutorial/00-full-overview.svg)
![Course Roadmap](./mini-lsm-book/src/lsm-tutorial/00-full-overview.svg)
| Week + Chapter | Topic |
| -------------- | ----------------------------------------------------------- |
@@ -116,4 +116,4 @@ mini-lsm inspired several projects used in production.
## License
The Mini-LSM starter code and solution are under [Apache 2.0 license](LICENSE). The author reserves the full copyright of the tutorial materials (markdown files and figures).
The Mini-LSM starter code and solution are under [Apache 2.0 license](LICENSE). The author reserves the full copyright of the course materials (markdown files and figures).