Add record-layer and other improvements

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/ci.yml

@@ -12,17 +12,17 @@ jobs:
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - run: which mdbook || cargo install mdbook --locked --version 0.4.15
-      - run: which mdbook-toc || cargo install mdbook-toc --locked --version 0.8.0
-      - run: which mdbook-mermaid || cargo install mdbook-mermaid --locked --version 0.9.0
-      - run: which mdbook-linkcheck || cargo install mdbook-linkcheck --locked --version 0.7.6
+      - uses: cachix/install-nix-action@v27
+        with:
+          extra_nix_config: |
+            access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
 
-      - run: mdbook build
+      - run: nix develop --command mdbook build
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         if: ${{ github.ref == 'refs/heads/main' }}
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1 +1,2 @@
 book
+.direnv

README.md

@@ -1,3 +1,11 @@
 # The FoundationDB Book
 
 This repo is holding the source code of `The FoundationDB Book`. Fairly early stage for now.
+
+## TODOs
+
+* https://github.com/apple/foundationdb/wiki/Best-practice-of-storing-structured-data,-for-example-JSON-objects
+* https://github.com/apple/foundationdb/wiki/Data-Distribution-and-Movement
+* https://github.com/apple/foundationdb/wiki/Difference-between-snapshot-reads-and-regular-reads
+* https://github.com/apple/foundationdb/wiki/Guidelines-for-Choosing-Coordinators
+* https://github.com/apple/foundationdb/wiki/Upgrading-FoundationDB

flake.nix

@@ -0,0 +1,26 @@
+{
+  description = "A dev environment for the fdb-book";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+        };
+      in
+      {
+        devShells.default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            mdbook
+            mdbook-toc
+            mdbook-mermaid
+            mdbook-linkcheck
+          ];
+        };
+      });
+}

src/SUMMARY.md

@@ -7,26 +7,26 @@
 - [Yet another database?](./meet_fdb/another_db.md)
 - [Enter FoundationDB](./meet_fdb/enter_fdb.md)
 - [Everything is a key-value!](./meet_fdb/everything_is_kv.md)
-- [Correct and robust, choose both](./meet_fdb/correctess.md)
+- [A Culture of Correctness](./meet_fdb/correctness.md)
 
 # Getting started with FoundationDB
 
-- [Installing FoundationDB](./getting_started/installing-fdb.md)
-- [Playing with `fdbcli`](./getting_started/fdbcli.md)
+- [Installation](./getting_started/installation.md)
+- [The `fdbcli` Command-Line Interface](./getting_started/fdbcli.md)
 
 # Developing a layer
 
-- [ACID transactions](./develop_layer/transactions.md)
-- [Crafting row keys](./develop_layer/crafting-row-keys.md)
-- [Existing open-source layers](./develop_layer/studiable-layers.md)
-- [Tips and tricks](./develop_layer/tips.md)
+- [Core Concept: Transactions](./develop_layer/transactions.md)
+- [Key Design: Tuples, Subspaces, and Directories](./develop_layer/crafting-row-keys.md)
+- [Learning from the Community: Open-Source Layers](./develop_layer/studiable-layers.md)
+- [Best Practices and Pitfalls](./develop_layer/tips.md)
 
 # FoundationDB's internals
 
-- [TODO: the list of roles]()
-- [TODO: the write-path]()
-- [TODO: the read-path]()
+- [Anatomy of a Cluster: Roles](./internals/roles.md)
+- [The Write Path](./internals/the-write-path.md)
+- [The Read Path](./internals/the-read-path.md)
 
 # The Record-Layer
-- [TODO: What is the Record-layer?]()
-- [TODO: QuiCK]()
+- [What is the Record-layer?](./the-record-layer/what-is-record-layer.md)
+- [QuiCK](./the-record-layer/quick.md)