mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tvix/*store): add some internal links

Browse source 
We can now cross-link between pages, and it actually works.

Change-Id: Id8bd85111672c687118db9adae7f5066f22441f5
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11817
Reviewed-by: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: Ilan Joselevich <personal@ilanjoselevich.com>
This commit is contained in:
Florian Klink 2024-06-14 17:45:35 +03:00 committed by flokli
parent 46585bee15
commit 6e321c615c
4 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
tvix/docs/src/castore/blobstore-chunking.md
View file

@ -77,7 +77,7 @@ our data model / identifier upfront, but can make this mostly a transport/
storage concern. storage concern.
For some more description on the (remote) protocol, check For some more description on the (remote) protocol, check
`./blobstore-protocol.md`. [BlobStore Protocol](./blobstore-protocol.md).
#### Logical vs. physical chunking #### Logical vs. physical chunking

4
tvix/docs/src/castore/blobstore-protocol.md
View file

@ -41,7 +41,7 @@ It also puts very little requirements on someone implementing a new
The gRPC protocol is documented in `../protos/rpc_blobstore.proto`. The gRPC protocol is documented in `../protos/rpc_blobstore.proto`.
Contrary to the `BlobService` trait, it does not have any options for seeking/ Contrary to the `BlobService` trait, it does not have any options for seeking/
ranging, as it's more desirable to provide this through chunking (see also ranging, as it's more desirable to provide this through chunking (see also
`./blobstore-chunking.md`). [BlobStore Chunking](./blobstore-chunking.md).
## Composition ## Composition
Different `BlobStore` are supposed to be "composed"/"layered" to express Different `BlobStore` are supposed to be "composed"/"layered" to express
@ -76,7 +76,7 @@ an additional additional field in the response, which would allow clients to
populate their local chunk store in a single roundtrip. populate their local chunk store in a single roundtrip.
## Verified Streaming ## Verified Streaming
As already described in `./docs/blobstore-chunking.md`, the physical chunk As already described in [BlobStore Chunking](./blobstore-chunking.md), the physical chunk
information sent in a `BlobService.Stat()` response is still sufficient to fetch information sent in a `BlobService.Stat()` response is still sufficient to fetch
in an authenticated fashion. in an authenticated fashion.

2
tvix/docs/src/castore/data-model.md
View file

@ -2,7 +2,7 @@
This provides some more notes on the fields used in castore.proto. This provides some more notes on the fields used in castore.proto.
See `//tvix/store/docs/api.md` for the full context. See [Store API](../store/api.md) for the full context.
## Directory message ## Directory message
`Directory` messages use the blake3 hash of their canonical protobuf `Directory` messages use the blake3 hash of their canonical protobuf

2
tvix/docs/src/store/api.md
View file

@ -5,7 +5,7 @@ This document outlines the design of the API exposed by tvix-castore and tvix-
store, as well as other implementations of this store protocol. store, as well as other implementations of this store protocol.
This document is meant to be read side-by-side with This document is meant to be read side-by-side with
[castore.md](../../castore/docs/data-model.md) which describes the data model [Data Model](../castore/data-model.md) which describes the data model
in more detail. in more detail.
The store API has four main consumers: The store API has four main consumers: