From 643734f0322f1daae87280a5421564a280e22e70 Mon Sep 17 00:00:00 2001 From: Alex Chi Date: Thu, 18 Jan 2024 20:49:30 +0800 Subject: [PATCH] outline v2 chapters Signed-off-by: Alex Chi --- mini-lsm-book-wip/src/00-overview.md | 40 +++++++++++++++++++++++++ mini-lsm-book-wip/src/SUMMARY.md | 12 ++------ mini-lsm-book-wip/src/week2-overview.md | 7 +++++ 3 files changed, 50 insertions(+), 9 deletions(-) diff --git a/mini-lsm-book-wip/src/00-overview.md b/mini-lsm-book-wip/src/00-overview.md index 07dd0c5c..82682220 100644 --- a/mini-lsm-book-wip/src/00-overview.md +++ b/mini-lsm-book-wip/src/00-overview.md @@ -1 +1,41 @@ # Overview + +## Structure + +chapters + snacks, clear goal + +implement, think, try by yourself + +required tasks, check your understanding questions, bonus tasks + +## Testing + +exploring and understanding is more important than passing all the test cases + +testing basic requirements, not the internal structure or something + +## Solution + +### Checkpoints + +the final version, but many things can be simplified, read the docs + +comments / tests / not up-to-date with the starter code + +### How to use the solutions + +## Feedbacks + +join the Discord server, your feedback is important, thank GitHub users + +## License + +### Free forever? + +### Video lectures + Review Service + Office Hour? + +should have a separate preface (before you start) chapter? and what's new with v2? + +## Target audience? + +## What will you get after taking this course... diff --git a/mini-lsm-book-wip/src/SUMMARY.md b/mini-lsm-book-wip/src/SUMMARY.md index 51b8af91..1c41ac26 100644 --- a/mini-lsm-book-wip/src/SUMMARY.md +++ b/mini-lsm-book-wip/src/SUMMARY.md @@ -3,9 +3,7 @@ [Overview](./00-overview.md) [Get Started](./00-get-started.md) -# Week 1: Mini-LSM - -- [Week 1 Overview](./week1-overview.md) +- [Week 1: Mini-LSM](./week1-overview.md) - [Memtables](./week1-01-memtable.md) - [Blocks](./week1-02-block.md) - [Sorted String Table (SST)](./week1-03-sst.md) @@ -14,9 +12,7 @@ - [Write Path](./week1-06-write-path.md) - [Snack Time: SST Optimizations](./week1-07-sst-optimizations.md) -# Week 2: Compaction and Persistence - -- [Week 2 Overview](./week2-overview.md) +- [Week 2: Compaction and Persistence](./week2-overview.md) - [Compaction Implementation](./week2-01-compaction.md) - [Simple Compaction Strategy](./week2-02-simple.md) - [Tiered Compaction Strategy](./week2-03-tiered.md) @@ -25,9 +21,7 @@ - [Write-Ahead Log (WAL)](./week2-06-wal.md) - [Snack Time: Batch Write](./week2-07-batch-write.md) -# Week 3: MVCC - -- [Overview](./week3-overview.md) +- [Week 3: MVCC](./week3-overview.md) # The Rest of Your Life (TBD) diff --git a/mini-lsm-book-wip/src/week2-overview.md b/mini-lsm-book-wip/src/week2-overview.md index 07dd0c5c..ecb6496e 100644 --- a/mini-lsm-book-wip/src/week2-overview.md +++ b/mini-lsm-book-wip/src/week2-overview.md @@ -1 +1,8 @@ # Overview + +compaction is important + +ask 2 what if questions + +LSM is about tradeoffs +