Skip to content

Commit

Permalink
Asset-Sync Documentation Update (#6303)
Browse files Browse the repository at this point in the history
* add line offering additional detail
* remove extraneous newline
  • Loading branch information
scbedd authored Jun 8, 2023
1 parent b976fcb commit 7b6c275
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions tools/test-proxy/documentation/asset-sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 7b6c275

Please sign in to comment.