From 7b6c275247b4223647ae63b6f1d8152161c918b5 Mon Sep 17 00:00:00 2001 From: Scott Beddall <45376673+scbedd@users.noreply.github.com> Date: Thu, 8 Jun 2023 11:16:17 -0700 Subject: [PATCH] Asset-Sync Documentation Update (#6303) * add line offering additional detail * remove extraneous newline --- tools/test-proxy/documentation/asset-sync/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tools/test-proxy/documentation/asset-sync/README.md b/tools/test-proxy/documentation/asset-sync/README.md index 31aae84e7a8..a92c52f5615 100644 --- a/tools/test-proxy/documentation/asset-sync/README.md +++ b/tools/test-proxy/documentation/asset-sync/README.md @@ -2,6 +2,8 @@ The `test-proxy` optionally offers integration with other git repositories for **storing** and **retrieving** recordings. This enables the proxy to work against repositories that do not emplace their test recordings directly alongside their test implementations. +Colloquially, any file that is stored externally using the `asset-sync` feature of the `test-proxy` is called an `asset`. + ![asset sync block diagram](../_images/asset_sync_block_diagram.png) In the context of a `monorepo`, this means that we store FAR less data per feature. To update recordings, the only change alongside the source code is to update the targeted tag.